google-apis-documentai_v1 0.54.0 → 0.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d447c0eab599df90a2f7fc4c7aa351ca86150d9eb2b2549a611ffde0f1d11dc4
-  data.tar.gz: 0f0a6dfaeb72abaa55974f885241ab78b91710339a71e881282ae613a7666d7b
+  metadata.gz: cfb63fb2719e8b59ef6682a6e1ade5c020a294854a02e95e040b88eb1a644899
+  data.tar.gz: 364b8eee4b663b9fd4a39170f5e2beb1786977a767eb92dce62cf96bcabcce0d
 SHA512:
-  metadata.gz: 8b5bca68c6c4004772aad3c34676ddb7b780f358b933be4e37a1aae0bc98e14f29aeb0167decbc53d9ae5a95acaa61052df9f39ab58275aa484553a43b0583e1
-  data.tar.gz: b808c8f96cb7454e22b3bf06f4fc7d0c45b63724722012c02c56b70056f852d8054b847ebad5ca7eaf4844d21daebf24c4356595f51e1e64b451b9cb6301aaad
+  metadata.gz: 1cf8ddd53de846897095b7523591de142d1b17447abd7a7bc9c85d777557ab4166c32fd6ac323a939559312c4f5ad92647cef3207e95d78e56382887b13438e6
+  data.tar.gz: 463447d87da942148ef7534d9a15e2fdf1717448d7f7de08f3041f6a829178a25187eb2d3ef9b5f153a19f36d14e85f594ba2ac3896772abf60f9d9873ae0df3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-documentai_v1
 
+### v0.55.0 (2023-01-22)
+
+* Regenerated from discovery document revision 20230113
+
 ### v0.54.0 (2023-01-15)
 
 * Regenerated from discovery document revision 20230106

data/lib/google/apis/documentai_v1/classes.rb

@@ -395,6 +395,11 @@ module Google
         # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId]
         attr_accessor :gcs_managed_doc_id
       
+        # The revision reference specifies which revision on the document to read.
+        # Corresponds to the JSON property `revisionRef`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionRef]
+        attr_accessor :revision_ref
+      
         # The revision reference specifies which revision on the document to read.
         # Corresponds to the JSON property `revisionReference`
         # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionReference]
@@ -407,6 +412,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @gcs_managed_doc_id = args[:gcs_managed_doc_id] if args.key?(:gcs_managed_doc_id)
+          @revision_ref = args[:revision_ref] if args.key?(:revision_ref)
           @revision_reference = args[:revision_reference] if args.key?(:revision_reference)
         end
       end
@@ -883,6 +889,39 @@ module Google
         end
       end
       
+      # The revision reference specifies which revision on the document to read.
+      class GoogleCloudDocumentaiUiv1beta3RevisionRef
+        include Google::Apis::Core::Hashable
+      
+        # Reads the revision generated by the processor version. The format takes the
+        # full resource name of processor version. `projects/`project`/locations/`
+        # location`/processors/`processor`/processorVersions/`processorVersion``
+        # Corresponds to the JSON property `latestProcessorVersion`
+        # @return [String]
+        attr_accessor :latest_processor_version
+      
+        # Reads the revision by the predefined case.
+        # Corresponds to the JSON property `revisionCase`
+        # @return [String]
+        attr_accessor :revision_case
+      
+        # Reads the revision given by the id.
+        # Corresponds to the JSON property `revisionId`
+        # @return [String]
+        attr_accessor :revision_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @latest_processor_version = args[:latest_processor_version] if args.key?(:latest_processor_version)
+          @revision_case = args[:revision_case] if args.key?(:revision_case)
+          @revision_id = args[:revision_id] if args.key?(:revision_id)
+        end
+      end
+      
       # The revision reference specifies which revision on the document to read.
       class GoogleCloudDocumentaiUiv1beta3RevisionReference
         include Google::Apis::Core::Hashable
@@ -3439,6 +3478,320 @@ module Google
         end
       end
       
+      # Evaluates the given ProcessorVersion against the supplied documents.
+      class GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest
+        include Google::Apis::Core::Hashable
+      
+        # The common config to specify a set of documents used as input.
+        # Corresponds to the JSON property `evaluationDocuments`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig]
+        attr_accessor :evaluation_documents
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @evaluation_documents = args[:evaluation_documents] if args.key?(:evaluation_documents)
+        end
+      end
+      
+      # An evaluation of a ProcessorVersion's performance.
+      class GoogleCloudDocumentaiV1Evaluation
+        include Google::Apis::Core::Hashable
+      
+        # Metrics across multiple confidence levels.
+        # Corresponds to the JSON property `allEntitiesMetrics`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics]
+        attr_accessor :all_entities_metrics
+      
+        # The time that the evaluation was created.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Evaluation counters for the documents that were used.
+        # Corresponds to the JSON property `documentCounters`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters]
+        attr_accessor :document_counters
+      
+        # Metrics across confidence levels, for different entities.
+        # Corresponds to the JSON property `entityMetrics`
+        # @return [Hash<String,Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics>]
+        attr_accessor :entity_metrics
+      
+        # The KMS key name used for encryption.
+        # Corresponds to the JSON property `kmsKeyName`
+        # @return [String]
+        attr_accessor :kms_key_name
+      
+        # The KMS key version with which data is encrypted.
+        # Corresponds to the JSON property `kmsKeyVersionName`
+        # @return [String]
+        attr_accessor :kms_key_version_name
+      
+        # The resource name of the evaluation. Format: `projects/`project`/locations/`
+        # location`/processors/`processor`/processorVersions/`processor_version`/
+        # evaluations/`evaluation``
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @all_entities_metrics = args[:all_entities_metrics] if args.key?(:all_entities_metrics)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @document_counters = args[:document_counters] if args.key?(:document_counters)
+          @entity_metrics = args[:entity_metrics] if args.key?(:entity_metrics)
+          @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
+          @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
+      # Evaluations metrics, at a specific confidence level.
+      class GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics
+        include Google::Apis::Core::Hashable
+      
+        # The confidence level.
+        # Corresponds to the JSON property `confidenceLevel`
+        # @return [Float]
+        attr_accessor :confidence_level
+      
+        # Evaluation metrics, either in aggregate or about a specific entity.
+        # Corresponds to the JSON property `metrics`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
+        attr_accessor :metrics
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @confidence_level = args[:confidence_level] if args.key?(:confidence_level)
+          @metrics = args[:metrics] if args.key?(:metrics)
+        end
+      end
+      
+      # Evaluation counters for the documents that were used.
+      class GoogleCloudDocumentaiV1EvaluationCounters
+        include Google::Apis::Core::Hashable
+      
+        # How many documents were used in the evaluation.
+        # Corresponds to the JSON property `evaluatedDocumentsCount`
+        # @return [Fixnum]
+        attr_accessor :evaluated_documents_count
+      
+        # How many documents were not included in the evaluation as Document AI failed
+        # to process them.
+        # Corresponds to the JSON property `failedDocumentsCount`
+        # @return [Fixnum]
+        attr_accessor :failed_documents_count
+      
+        # How many documents were sent for evaluation.
+        # Corresponds to the JSON property `inputDocumentsCount`
+        # @return [Fixnum]
+        attr_accessor :input_documents_count
+      
+        # How many documents were not included in the evaluation as they didn't pass
+        # validation.
+        # Corresponds to the JSON property `invalidDocumentsCount`
+        # @return [Fixnum]
+        attr_accessor :invalid_documents_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @evaluated_documents_count = args[:evaluated_documents_count] if args.key?(:evaluated_documents_count)
+          @failed_documents_count = args[:failed_documents_count] if args.key?(:failed_documents_count)
+          @input_documents_count = args[:input_documents_count] if args.key?(:input_documents_count)
+          @invalid_documents_count = args[:invalid_documents_count] if args.key?(:invalid_documents_count)
+        end
+      end
+      
+      # Evaluation metrics, either in aggregate or about a specific entity.
+      class GoogleCloudDocumentaiV1EvaluationMetrics
+        include Google::Apis::Core::Hashable
+      
+        # The calculated f1 score.
+        # Corresponds to the JSON property `f1Score`
+        # @return [Float]
+        attr_accessor :f1_score
+      
+        # The amount of false negatives.
+        # Corresponds to the JSON property `falseNegativesCount`
+        # @return [Fixnum]
+        attr_accessor :false_negatives_count
+      
+        # The amount of false positives.
+        # Corresponds to the JSON property `falsePositivesCount`
+        # @return [Fixnum]
+        attr_accessor :false_positives_count
+      
+        # The amount of documents with a ground truth occurrence.
+        # Corresponds to the JSON property `groundTruthDocumentCount`
+        # @return [Fixnum]
+        attr_accessor :ground_truth_document_count
+      
+        # The amount of occurrences in ground truth documents.
+        # Corresponds to the JSON property `groundTruthOccurrencesCount`
+        # @return [Fixnum]
+        attr_accessor :ground_truth_occurrences_count
+      
+        # The calculated precision.
+        # Corresponds to the JSON property `precision`
+        # @return [Float]
+        attr_accessor :precision
+      
+        # The amount of documents with a predicted occurrence.
+        # Corresponds to the JSON property `predictedDocumentCount`
+        # @return [Fixnum]
+        attr_accessor :predicted_document_count
+      
+        # The amount of occurrences in predicted documents.
+        # Corresponds to the JSON property `predictedOccurrencesCount`
+        # @return [Fixnum]
+        attr_accessor :predicted_occurrences_count
+      
+        # The calculated recall.
+        # Corresponds to the JSON property `recall`
+        # @return [Float]
+        attr_accessor :recall
+      
+        # The amount of documents that had an occurrence of this label.
+        # Corresponds to the JSON property `totalDocumentsCount`
+        # @return [Fixnum]
+        attr_accessor :total_documents_count
+      
+        # The amount of true positives.
+        # Corresponds to the JSON property `truePositivesCount`
+        # @return [Fixnum]
+        attr_accessor :true_positives_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @f1_score = args[:f1_score] if args.key?(:f1_score)
+          @false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
+          @false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
+          @ground_truth_document_count = args[:ground_truth_document_count] if args.key?(:ground_truth_document_count)
+          @ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
+          @precision = args[:precision] if args.key?(:precision)
+          @predicted_document_count = args[:predicted_document_count] if args.key?(:predicted_document_count)
+          @predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
+          @recall = args[:recall] if args.key?(:recall)
+          @total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
+          @true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
+        end
+      end
+      
+      # Metrics across multiple confidence levels.
+      class GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics
+        include Google::Apis::Core::Hashable
+      
+        # The calculated area under the precision recall curve (AUPRC), computed by
+        # integrating over all confidence thresholds.
+        # Corresponds to the JSON property `auprc`
+        # @return [Float]
+        attr_accessor :auprc
+      
+        # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
+        # Corresponds to the JSON property `auprcExact`
+        # @return [Float]
+        attr_accessor :auprc_exact
+      
+        # Metrics across confidence levels with fuzzy matching enabled.
+        # Corresponds to the JSON property `confidenceLevelMetrics`
+        # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics>]
+        attr_accessor :confidence_level_metrics
+      
+        # Metrics across confidence levels with only exact matching.
+        # Corresponds to the JSON property `confidenceLevelMetricsExact`
+        # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics>]
+        attr_accessor :confidence_level_metrics_exact
+      
+        # The Estimated Calibration Error (ECE) of the confidence of the predicted
+        # entities.
+        # Corresponds to the JSON property `estimatedCalibrationError`
+        # @return [Float]
+        attr_accessor :estimated_calibration_error
+      
+        # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact
+        # matching only.
+        # Corresponds to the JSON property `estimatedCalibrationErrorExact`
+        # @return [Float]
+        attr_accessor :estimated_calibration_error_exact
+      
+        # The metrics type for the label.
+        # Corresponds to the JSON property `metricsType`
+        # @return [String]
+        attr_accessor :metrics_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @auprc = args[:auprc] if args.key?(:auprc)
+          @auprc_exact = args[:auprc_exact] if args.key?(:auprc_exact)
+          @confidence_level_metrics = args[:confidence_level_metrics] if args.key?(:confidence_level_metrics)
+          @confidence_level_metrics_exact = args[:confidence_level_metrics_exact] if args.key?(:confidence_level_metrics_exact)
+          @estimated_calibration_error = args[:estimated_calibration_error] if args.key?(:estimated_calibration_error)
+          @estimated_calibration_error_exact = args[:estimated_calibration_error_exact] if args.key?(:estimated_calibration_error_exact)
+          @metrics_type = args[:metrics_type] if args.key?(:metrics_type)
+        end
+      end
+      
+      # Gives a short summary of an evaluation, and links to the evaluation itself.
+      class GoogleCloudDocumentaiV1EvaluationReference
+        include Google::Apis::Core::Hashable
+      
+        # Evaluation metrics, either in aggregate or about a specific entity.
+        # Corresponds to the JSON property `aggregateMetrics`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
+        attr_accessor :aggregate_metrics
+      
+        # Evaluation metrics, either in aggregate or about a specific entity.
+        # Corresponds to the JSON property `aggregateMetricsExact`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
+        attr_accessor :aggregate_metrics_exact
+      
+        # The resource name of the evaluation.
+        # Corresponds to the JSON property `evaluation`
+        # @return [String]
+        attr_accessor :evaluation
+      
+        # The resource name of the Long Running Operation for the evaluation.
+        # Corresponds to the JSON property `operation`
+        # @return [String]
+        attr_accessor :operation
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @aggregate_metrics = args[:aggregate_metrics] if args.key?(:aggregate_metrics)
+          @aggregate_metrics_exact = args[:aggregate_metrics_exact] if args.key?(:aggregate_metrics_exact)
+          @evaluation = args[:evaluation] if args.key?(:evaluation)
+          @operation = args[:operation] if args.key?(:operation)
+        end
+      end
+      
       # Response message for fetch processor types.
       class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
         include Google::Apis::Core::Hashable
@@ -3555,6 +3908,32 @@ module Google
         end
       end
       
+      # The response from ListEvaluations.
+      class GoogleCloudDocumentaiV1ListEvaluationsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The evaluations requested.
+        # Corresponds to the JSON property `evaluations`
+        # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation>]
+        attr_accessor :evaluations
+      
+        # A token, which can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @evaluations = args[:evaluations] if args.key?(:evaluations)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response message for list processor types.
       class GoogleCloudDocumentaiV1ListProcessorTypesResponse
         include Google::Apis::Core::Hashable
@@ -3916,6 +4295,11 @@ module Google
         # @return [String]
         attr_accessor :kms_key_version_name
       
+        # Gives a short summary of an evaluation, and links to the evaluation itself.
+        # Corresponds to the JSON property `latestEvaluation`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference]
+        attr_accessor :latest_evaluation
+      
         # The resource name of the processor version. Format: `projects/`project`/
         # locations/`location`/processors/`processor`/processorVersions/`
         # processor_version``
@@ -3941,6 +4325,7 @@ module Google
           @google_managed = args[:google_managed] if args.key?(:google_managed)
           @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
           @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
+          @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
           @name = args[:name] if args.key?(:name)
           @state = args[:state] if args.key?(:state)
         end
@@ -4148,6 +4533,74 @@ module Google
         end
       end
       
+      # Request message for the create processor version method.
+      class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
+        include Google::Apis::Core::Hashable
+      
+        # Optional. The processor version to use as a base for training. This processor
+        # version must be a child of `parent`. Format: `projects/`project`/locations/`
+        # location`/processors/`processor`/processorVersions/`processorVersion``.
+        # Corresponds to the JSON property `baseProcessorVersion`
+        # @return [String]
+        attr_accessor :base_processor_version
+      
+        # The schema defines the output of the processed document by a processor.
+        # Corresponds to the JSON property `documentSchema`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema]
+        attr_accessor :document_schema
+      
+        # The input data used to train a new `ProcessorVersion`.
+        # Corresponds to the JSON property `inputData`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData]
+        attr_accessor :input_data
+      
+        # A processor version is an implementation of a processor. Each processor can
+        # have multiple versions, pre-trained by Google internally or up-trained by the
+        # customer. At a time, a processor can only have one default version version. So
+        # the processor's behavior (when processing documents) is defined by a default
+        # version
+        # Corresponds to the JSON property `processorVersion`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion]
+        attr_accessor :processor_version
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @base_processor_version = args[:base_processor_version] if args.key?(:base_processor_version)
+          @document_schema = args[:document_schema] if args.key?(:document_schema)
+          @input_data = args[:input_data] if args.key?(:input_data)
+          @processor_version = args[:processor_version] if args.key?(:processor_version)
+        end
+      end
+      
+      # The input data used to train a new `ProcessorVersion`.
+      class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
+        include Google::Apis::Core::Hashable
+      
+        # The common config to specify a set of documents used as input.
+        # Corresponds to the JSON property `testDocuments`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig]
+        attr_accessor :test_documents
+      
+        # The common config to specify a set of documents used as input.
+        # Corresponds to the JSON property `trainingDocuments`
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig]
+        attr_accessor :training_documents
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @test_documents = args[:test_documents] if args.key?(:test_documents)
+          @training_documents = args[:training_documents] if args.key?(:training_documents)
+        end
+      end
+      
       # The long running operation metadata for the undeploy processor version method.
       class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
         include Google::Apis::Core::Hashable

data/lib/google/apis/documentai_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DocumentaiV1
       # Version of the google-apis-documentai_v1 gem
-      GEM_VERSION = "0.54.0"
+      GEM_VERSION = "0.55.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.11.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230106"
+      REVISION = "20230113"
     end
   end
 end

data/lib/google/apis/documentai_v1/representations.rb

@@ -238,6 +238,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDocumentaiUiv1beta3RevisionRef
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDocumentaiUiv1beta3RevisionReference
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -682,6 +688,48 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDocumentaiV1Evaluation
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationCounters
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationMetrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationReference
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -712,6 +760,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDocumentaiV1ListEvaluationsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDocumentaiV1ListProcessorTypesResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -820,6 +874,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1770,6 +1836,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :gcs_managed_doc_id, as: 'gcsManagedDocId', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId::Representation
       
+          property :revision_ref, as: 'revisionRef', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionRef, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionRef::Representation
+      
           property :revision_reference, as: 'revisionReference', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionReference, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionReference::Representation
       
         end
@@ -1940,6 +2008,15 @@ module Google
         end
       end
       
+      class GoogleCloudDocumentaiUiv1beta3RevisionRef
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :latest_processor_version, as: 'latestProcessorVersion'
+          property :revision_case, as: 'revisionCase'
+          property :revision_id, as: 'revisionId'
+        end
+      end
+      
       class GoogleCloudDocumentaiUiv1beta3RevisionReference
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2714,6 +2791,93 @@ module Google
         end
       end
       
+      class GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :evaluation_documents, as: 'evaluationDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDocumentaiV1Evaluation
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :all_entities_metrics, as: 'allEntitiesMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics::Representation
+      
+          property :create_time, as: 'createTime'
+          property :document_counters, as: 'documentCounters', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters::Representation
+      
+          hash :entity_metrics, as: 'entityMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics::Representation
+      
+          property :kms_key_name, as: 'kmsKeyName'
+          property :kms_key_version_name, as: 'kmsKeyVersionName'
+          property :name, as: 'name'
+        end
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :confidence_level, as: 'confidenceLevel'
+          property :metrics, as: 'metrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationCounters
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :evaluated_documents_count, as: 'evaluatedDocumentsCount'
+          property :failed_documents_count, as: 'failedDocumentsCount'
+          property :input_documents_count, as: 'inputDocumentsCount'
+          property :invalid_documents_count, as: 'invalidDocumentsCount'
+        end
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :f1_score, as: 'f1Score'
+          property :false_negatives_count, as: 'falseNegativesCount'
+          property :false_positives_count, as: 'falsePositivesCount'
+          property :ground_truth_document_count, as: 'groundTruthDocumentCount'
+          property :ground_truth_occurrences_count, as: 'groundTruthOccurrencesCount'
+          property :precision, as: 'precision'
+          property :predicted_document_count, as: 'predictedDocumentCount'
+          property :predicted_occurrences_count, as: 'predictedOccurrencesCount'
+          property :recall, as: 'recall'
+          property :total_documents_count, as: 'totalDocumentsCount'
+          property :true_positives_count, as: 'truePositivesCount'
+        end
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :auprc, as: 'auprc'
+          property :auprc_exact, as: 'auprcExact'
+          collection :confidence_level_metrics, as: 'confidenceLevelMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics::Representation
+      
+          collection :confidence_level_metrics_exact, as: 'confidenceLevelMetricsExact', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics::Representation
+      
+          property :estimated_calibration_error, as: 'estimatedCalibrationError'
+          property :estimated_calibration_error_exact, as: 'estimatedCalibrationErrorExact'
+          property :metrics_type, as: 'metricsType'
+        end
+      end
+      
+      class GoogleCloudDocumentaiV1EvaluationReference
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :aggregate_metrics, as: 'aggregateMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics::Representation
+      
+          property :aggregate_metrics_exact, as: 'aggregateMetricsExact', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics::Representation
+      
+          property :evaluation, as: 'evaluation'
+          property :operation, as: 'operation'
+        end
+      end
+      
       class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2754,6 +2918,15 @@ module Google
         end
       end
       
+      class GoogleCloudDocumentaiV1ListEvaluationsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :evaluations, as: 'evaluations', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class GoogleCloudDocumentaiV1ListProcessorTypesResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2858,6 +3031,8 @@ module Google
           property :google_managed, as: 'googleManaged'
           property :kms_key_name, as: 'kmsKeyName'
           property :kms_key_version_name, as: 'kmsKeyVersionName'
+          property :latest_evaluation, as: 'latestEvaluation', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference::Representation
+      
           property :name, as: 'name'
           property :state, as: 'state'
         end
@@ -2930,6 +3105,29 @@ module Google
         end
       end
       
+      class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :base_processor_version, as: 'baseProcessorVersion'
+          property :document_schema, as: 'documentSchema', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema::Representation
+      
+          property :input_data, as: 'inputData', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData::Representation
+      
+          property :processor_version, as: 'processorVersion', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :test_documents, as: 'testDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig::Representation
+      
+          property :training_documents, as: 'trainingDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig::Representation
+      
+        end
+      end
+      
       class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/documentai_v1/service.rb

@@ -820,6 +820,42 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Evaluates a ProcessorVersion against annotated documents, producing an
+        # Evaluation.
+        # @param [String] processor_version
+        #   Required. The resource name of the ProcessorVersion to evaluate. `projects/`
+        #   project`/locations/`location`/processors/`processor`/processorVersions/`
+        #   processorVersion``
+        # @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest] google_cloud_documentai_v1_evaluate_processor_version_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DocumentaiV1::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DocumentaiV1::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def evaluate_project_location_processor_processor_version_processor_version(processor_version, google_cloud_documentai_v1_evaluate_processor_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+processorVersion}:evaluateProcessorVersion', options)
+          command.request_representation = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest::Representation
+          command.request_object = google_cloud_documentai_v1_evaluate_processor_version_request_object
+          command.response_representation = Google::Apis::DocumentaiV1::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DocumentaiV1::GoogleLongrunningOperation
+          command.params['processorVersion'] = processor_version unless processor_version.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets a processor version detail.
         # @param [String] name
         #   Required. The processor resource name.
@@ -927,6 +963,42 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Trains a new processor version. Operation metadata is returned as
+        # cloud_documentai_core.TrainProcessorVersionMetadata.
+        # @param [String] parent
+        #   Required. The parent (project, location and processor) to create the new
+        #   version for. Format: `projects/`project`/locations/`location`/processors/`
+        #   processor``.
+        # @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequest] google_cloud_documentai_v1_train_processor_version_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DocumentaiV1::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DocumentaiV1::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def train_project_location_processor_processor_version(parent, google_cloud_documentai_v1_train_processor_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+parent}/processorVersions:train', options)
+          command.request_representation = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequest::Representation
+          command.request_object = google_cloud_documentai_v1_train_processor_version_request_object
+          command.response_representation = Google::Apis::DocumentaiV1::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DocumentaiV1::GoogleLongrunningOperation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Undeploys the processor version.
         # @param [String] name
         #   Required. The processor version resource name to be undeployed.
@@ -960,6 +1032,78 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Retrieves a specific evaluation.
+        # @param [String] name
+        #   Required. The resource name of the Evaluation to get. `projects/`project`/
+        #   locations/`location`/processors/`processor`/processorVersions/`
+        #   processorVersion`/evaluations/`evaluation``
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_location_processor_processor_version_evaluation(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation::Representation
+          command.response_class = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Retrieves a set of evaluations for a given processor version.
+        # @param [String] parent
+        #   Required. The resource name of the ProcessorVersion to list evaluations for. `
+        #   projects/`project`/locations/`location`/processors/`processor`/
+        #   processorVersions/`processorVersion``
+        # @param [Fixnum] page_size
+        #   The standard list page size. If unspecified, at most 5 evaluations will be
+        #   returned. The maximum value is 100; values above 100 will be coerced to 100.
+        # @param [String] page_token
+        #   A page token, received from a previous `ListEvaluations` call. Provide this to
+        #   retrieve the subsequent page.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ListEvaluationsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ListEvaluationsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_processor_processor_version_evaluations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/evaluations', options)
+          command.response_representation = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ListEvaluationsResponse::Representation
+          command.response_class = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ListEvaluationsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-documentai_v1
 version: !ruby/object:Gem::Version
-  version: 0.54.0
+  version: 0.55.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-15 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.54.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.55.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1
 post_install_message: 
 rdoc_options: []