google-cloud-document_ai-v1 0.9.0 → 0.10.0

data/lib/google/cloud/document_ai/v1/document_processor_service/operations.rb

@@ -158,13 +158,11 @@ module Google
             #   # Call the list_operations method.
             #   result = client.list_operations request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Longrunning::Operation.
-            #     p response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # Call the get_operation method.
             #   result = client.get_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # Call the wait_operation method.
             #   result = client.wait_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil

data/lib/google/cloud/document_ai/v1/document_processor_service/paths.rb

@@ -24,6 +24,29 @@ module Google
         module DocumentProcessorService
           # Path helper methods for the DocumentProcessorService API.
           module Paths
+            ##
+            # Create a fully-qualified Evaluation resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param processor [String]
+            # @param processor_version [String]
+            # @param evaluation [String]
+            #
+            # @return [::String]
+            def evaluation_path project:, location:, processor:, processor_version:, evaluation:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "processor cannot contain /" if processor.to_s.include? "/"
+              raise ::ArgumentError, "processor_version cannot contain /" if processor_version.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/processors/#{processor}/processorVersions/#{processor_version}/evaluations/#{evaluation}"
+            end
+
             ##
             # Create a fully-qualified HumanReviewConfig resource string.
             #

data/lib/google/cloud/document_ai/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module DocumentAI
       module V1
-        VERSION = "0.9.0"
+        VERSION = "0.10.0"
       end
     end
   end

data/lib/google/cloud/documentai/v1/document_pb.rb

@@ -254,6 +254,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :OPERATION_TYPE_UNSPECIFIED, 0
       value :ADD, 1
       value :REMOVE, 2
+      value :UPDATE, 7
       value :REPLACE, 3
       value :EVAL_REQUESTED, 4
       value :EVAL_APPROVED, 5

data/lib/google/cloud/documentai/v1/document_processor_service_pb.rb

@@ -10,10 +10,12 @@ require 'google/api/resource_pb'
 require 'google/cloud/documentai/v1/document_pb'
 require 'google/cloud/documentai/v1/document_io_pb'
 require 'google/cloud/documentai/v1/document_schema_pb'
+require 'google/cloud/documentai/v1/evaluation_pb'
 require 'google/cloud/documentai/v1/operation_metadata_pb'
 require 'google/cloud/documentai/v1/processor_pb'
 require 'google/cloud/documentai/v1/processor_type_pb'
 require 'google/longrunning/operations_pb'
+require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
@@ -174,6 +176,31 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.documentai.v1.SetDefaultProcessorVersionMetadata" do
       optional :common_metadata, :message, 1, "google.cloud.documentai.v1.CommonOperationMetadata"
     end
+    add_message "google.cloud.documentai.v1.TrainProcessorVersionRequest" do
+      optional :parent, :string, 1
+      optional :processor_version, :message, 2, "google.cloud.documentai.v1.ProcessorVersion"
+      optional :document_schema, :message, 10, "google.cloud.documentai.v1.DocumentSchema"
+      optional :input_data, :message, 4, "google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData"
+      optional :base_processor_version, :string, 8
+    end
+    add_message "google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData" do
+      optional :training_documents, :message, 3, "google.cloud.documentai.v1.BatchDocumentsInputConfig"
+      optional :test_documents, :message, 4, "google.cloud.documentai.v1.BatchDocumentsInputConfig"
+    end
+    add_message "google.cloud.documentai.v1.TrainProcessorVersionResponse" do
+      optional :processor_version, :string, 1
+    end
+    add_message "google.cloud.documentai.v1.TrainProcessorVersionMetadata" do
+      optional :common_metadata, :message, 1, "google.cloud.documentai.v1.CommonOperationMetadata"
+      optional :training_dataset_validation, :message, 2, "google.cloud.documentai.v1.TrainProcessorVersionMetadata.DatasetValidation"
+      optional :test_dataset_validation, :message, 3, "google.cloud.documentai.v1.TrainProcessorVersionMetadata.DatasetValidation"
+    end
+    add_message "google.cloud.documentai.v1.TrainProcessorVersionMetadata.DatasetValidation" do
+      optional :document_error_count, :int32, 3
+      optional :dataset_error_count, :int32, 4
+      repeated :document_errors, :message, 1, "google.rpc.Status"
+      repeated :dataset_errors, :message, 2, "google.rpc.Status"
+    end
     add_message "google.cloud.documentai.v1.ReviewDocumentRequest" do
       optional :human_review_config, :string, 1
       optional :enable_schema_validation, :bool, 3
@@ -201,6 +228,28 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :common_metadata, :message, 5, "google.cloud.documentai.v1.CommonOperationMetadata"
       optional :question_id, :string, 6
     end
+    add_message "google.cloud.documentai.v1.EvaluateProcessorVersionRequest" do
+      optional :processor_version, :string, 1
+      optional :evaluation_documents, :message, 3, "google.cloud.documentai.v1.BatchDocumentsInputConfig"
+    end
+    add_message "google.cloud.documentai.v1.EvaluateProcessorVersionMetadata" do
+      optional :common_metadata, :message, 1, "google.cloud.documentai.v1.CommonOperationMetadata"
+    end
+    add_message "google.cloud.documentai.v1.EvaluateProcessorVersionResponse" do
+      optional :evaluation, :string, 2
+    end
+    add_message "google.cloud.documentai.v1.GetEvaluationRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.documentai.v1.ListEvaluationsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.documentai.v1.ListEvaluationsResponse" do
+      repeated :evaluations, :message, 1, "google.cloud.documentai.v1.Evaluation"
+      optional :next_page_token, :string, 2
+    end
   end
 end
 
@@ -248,11 +297,22 @@ module Google
         SetDefaultProcessorVersionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.SetDefaultProcessorVersionRequest").msgclass
         SetDefaultProcessorVersionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.SetDefaultProcessorVersionResponse").msgclass
         SetDefaultProcessorVersionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.SetDefaultProcessorVersionMetadata").msgclass
+        TrainProcessorVersionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.TrainProcessorVersionRequest").msgclass
+        TrainProcessorVersionRequest::InputData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData").msgclass
+        TrainProcessorVersionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.TrainProcessorVersionResponse").msgclass
+        TrainProcessorVersionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.TrainProcessorVersionMetadata").msgclass
+        TrainProcessorVersionMetadata::DatasetValidation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.TrainProcessorVersionMetadata.DatasetValidation").msgclass
         ReviewDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ReviewDocumentRequest").msgclass
         ReviewDocumentRequest::Priority = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ReviewDocumentRequest.Priority").enummodule
         ReviewDocumentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ReviewDocumentResponse").msgclass
         ReviewDocumentResponse::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ReviewDocumentResponse.State").enummodule
         ReviewDocumentOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ReviewDocumentOperationMetadata").msgclass
+        EvaluateProcessorVersionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.EvaluateProcessorVersionRequest").msgclass
+        EvaluateProcessorVersionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.EvaluateProcessorVersionMetadata").msgclass
+        EvaluateProcessorVersionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.EvaluateProcessorVersionResponse").msgclass
+        GetEvaluationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.GetEvaluationRequest").msgclass
+        ListEvaluationsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ListEvaluationsRequest").msgclass
+        ListEvaluationsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ListEvaluationsResponse").msgclass
       end
     end
   end

data/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb

@@ -52,6 +52,10 @@ module Google
             rpc :ListProcessors, ::Google::Cloud::DocumentAI::V1::ListProcessorsRequest, ::Google::Cloud::DocumentAI::V1::ListProcessorsResponse
             # Gets a processor detail.
             rpc :GetProcessor, ::Google::Cloud::DocumentAI::V1::GetProcessorRequest, ::Google::Cloud::DocumentAI::V1::Processor
+            # Trains a new processor version.
+            # Operation metadata is returned as
+            # cloud_documentai_core.TrainProcessorVersionMetadata.
+            rpc :TrainProcessorVersion, ::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest, ::Google::Longrunning::Operation
             # Gets a processor version detail.
             rpc :GetProcessorVersion, ::Google::Cloud::DocumentAI::V1::GetProcessorVersionRequest, ::Google::Cloud::DocumentAI::V1::ProcessorVersion
             # Lists all versions of a processor.
@@ -82,6 +86,13 @@ module Google
             # Send a document for Human Review. The input document should be processed by
             # the specified processor.
             rpc :ReviewDocument, ::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest, ::Google::Longrunning::Operation
+            # Evaluates a ProcessorVersion against annotated documents, producing an
+            # Evaluation.
+            rpc :EvaluateProcessorVersion, ::Google::Cloud::DocumentAI::V1::EvaluateProcessorVersionRequest, ::Google::Longrunning::Operation
+            # Retrieves a specific evaluation.
+            rpc :GetEvaluation, ::Google::Cloud::DocumentAI::V1::GetEvaluationRequest, ::Google::Cloud::DocumentAI::V1::Evaluation
+            # Retrieves a set of evaluations for a given processor version.
+            rpc :ListEvaluations, ::Google::Cloud::DocumentAI::V1::ListEvaluationsRequest, ::Google::Cloud::DocumentAI::V1::ListEvaluationsResponse
           end
 
           Stub = Service.rpc_stub_class

data/lib/google/cloud/documentai/v1/evaluation_pb.rb

@@ -0,0 +1,79 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/documentai/v1/evaluation.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+require 'google/protobuf/timestamp_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/documentai/v1/evaluation.proto", :syntax => :proto3) do
+    add_message "google.cloud.documentai.v1.EvaluationReference" do
+      optional :operation, :string, 1
+      optional :evaluation, :string, 2
+      optional :aggregate_metrics, :message, 4, "google.cloud.documentai.v1.Evaluation.Metrics"
+      optional :aggregate_metrics_exact, :message, 5, "google.cloud.documentai.v1.Evaluation.Metrics"
+    end
+    add_message "google.cloud.documentai.v1.Evaluation" do
+      optional :name, :string, 1
+      optional :create_time, :message, 2, "google.protobuf.Timestamp"
+      optional :document_counters, :message, 5, "google.cloud.documentai.v1.Evaluation.Counters"
+      optional :all_entities_metrics, :message, 3, "google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics"
+      map :entity_metrics, :string, :message, 4, "google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics"
+      optional :kms_key_name, :string, 6
+      optional :kms_key_version_name, :string, 7
+    end
+    add_message "google.cloud.documentai.v1.Evaluation.Counters" do
+      optional :input_documents_count, :int32, 1
+      optional :invalid_documents_count, :int32, 2
+      optional :failed_documents_count, :int32, 3
+      optional :evaluated_documents_count, :int32, 4
+    end
+    add_message "google.cloud.documentai.v1.Evaluation.Metrics" do
+      optional :precision, :float, 1
+      optional :recall, :float, 2
+      optional :f1_score, :float, 3
+      optional :predicted_occurrences_count, :int32, 4
+      optional :ground_truth_occurrences_count, :int32, 5
+      optional :predicted_document_count, :int32, 10
+      optional :ground_truth_document_count, :int32, 11
+      optional :true_positives_count, :int32, 6
+      optional :false_positives_count, :int32, 7
+      optional :false_negatives_count, :int32, 8
+      optional :total_documents_count, :int32, 9
+    end
+    add_message "google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics" do
+      optional :confidence_level, :float, 1
+      optional :metrics, :message, 2, "google.cloud.documentai.v1.Evaluation.Metrics"
+    end
+    add_message "google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics" do
+      repeated :confidence_level_metrics, :message, 1, "google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics"
+      repeated :confidence_level_metrics_exact, :message, 4, "google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics"
+      optional :auprc, :float, 2
+      optional :estimated_calibration_error, :float, 3
+      optional :auprc_exact, :float, 5
+      optional :estimated_calibration_error_exact, :float, 6
+      optional :metrics_type, :enum, 7, "google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics.MetricsType"
+    end
+    add_enum "google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics.MetricsType" do
+      value :METRICS_TYPE_UNSPECIFIED, 0
+      value :AGGREGATE, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module DocumentAI
+      module V1
+        EvaluationReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.EvaluationReference").msgclass
+        Evaluation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Evaluation").msgclass
+        Evaluation::Counters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Evaluation.Counters").msgclass
+        Evaluation::Metrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Evaluation.Metrics").msgclass
+        Evaluation::ConfidenceLevelMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics").msgclass
+        Evaluation::MultiConfidenceMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics").msgclass
+        Evaluation::MultiConfidenceMetrics::MetricsType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics.MetricsType").enummodule
+      end
+    end
+  end
+end

data/lib/google/cloud/documentai/v1/processor_pb.rb

@@ -6,6 +6,7 @@ require 'google/protobuf'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/documentai/v1/document_schema_pb'
+require 'google/cloud/documentai/v1/evaluation_pb'
 require 'google/protobuf/timestamp_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -16,6 +17,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :document_schema, :message, 12, "google.cloud.documentai.v1.DocumentSchema"
       optional :state, :enum, 6, "google.cloud.documentai.v1.ProcessorVersion.State"
       optional :create_time, :message, 7, "google.protobuf.Timestamp"
+      optional :latest_evaluation, :message, 8, "google.cloud.documentai.v1.EvaluationReference"
       optional :kms_key_name, :string, 9
       optional :kms_key_version_name, :string, 10
       optional :google_managed, :bool, 11

data/proto_docs/google/cloud/documentai/v1/document.rb

@@ -876,17 +876,24 @@ module Google
               # Remove an element identified by `parent`.
               REMOVE = 2
 
-              # Replace an element identified by `parent`.
+              # Updates any fields within the given provenance scope of the message. It
+              # 'overwrites'  the fields rather than replacing them.  This is
+              # especially relevant when we just want to update a field value of an
+              # entity without also affecting all the child properties.
+              UPDATE = 7
+
+              # Currently unused. Replace an element identified by `parent`.
               REPLACE = 3
 
-              # Request human review for the element identified by `parent`.
+              # Deprecated. Request human review for the element identified by
+              # `parent`.
               EVAL_REQUESTED = 4
 
-              # Element is reviewed and approved at human review, confidence will be
-              # set to 1.0.
+              # Deprecated. Element is reviewed and approved at human review,
+              # confidence will be set to 1.0.
               EVAL_APPROVED = 5
 
-              # Element is skipped in the validation process.
+              # Deprecated. Element is skipped in the validation process.
               EVAL_SKIPPED = 6
             end
           end
@@ -902,7 +909,8 @@ module Google
           #     resource name.
           # @!attribute [rw] id
           #   @return [::String]
-          #     Id of the revision.  Unique within the context of the document.
+          #     Id of the revision, internally generated by doc proto storage.
+          #     Unique within the context of the document.
           # @!attribute [rw] parent
           #   @return [::Array<::Integer>]
           #     The revisions that this revision is based on.  This can include one or
@@ -915,7 +923,8 @@ module Google
           #     `provenance.parent.revision` fields that index into this field.
           # @!attribute [rw] create_time
           #   @return [::Google::Protobuf::Timestamp]
-          #     The time that the revision was created.
+          #     The time that the revision was created, internally generated by
+          #     doc proto storage at the time of create.
           # @!attribute [rw] human_review
           #   @return [::Google::Cloud::DocumentAI::V1::Document::Revision::HumanReview]
           #     Human Review information of this revision.

data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb

@@ -530,6 +530,90 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for the create processor version method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent (project, location and processor) to create the new
+        #     version for. Format:
+        #     `projects/{project}/locations/{location}/processors/{processor}`.
+        # @!attribute [rw] processor_version
+        #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion]
+        #     Required. The processor version to be created.
+        # @!attribute [rw] document_schema
+        #   @return [::Google::Cloud::DocumentAI::V1::DocumentSchema]
+        #     Optional. The schema the processor version will be trained with.
+        # @!attribute [rw] input_data
+        #   @return [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData]
+        #     Optional. The input data used to train the `ProcessorVersion`.
+        # @!attribute [rw] base_processor_version
+        #   @return [::String]
+        #     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}`.
+        class TrainProcessorVersionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The input data used to train a new `ProcessorVersion`.
+          # @!attribute [rw] training_documents
+          #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
+          #     The documents used for training the new version.
+          # @!attribute [rw] test_documents
+          #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
+          #     The documents used for testing the trained version.
+          class InputData
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The response for the TrainProcessorVersion method.
+        # @!attribute [rw] processor_version
+        #   @return [::String]
+        #     The resource name of the processor version produced by training.
+        class TrainProcessorVersionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The metadata that represents a processor version being created.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        # @!attribute [rw] training_dataset_validation
+        #   @return [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionMetadata::DatasetValidation]
+        #     The training dataset validation information.
+        # @!attribute [rw] test_dataset_validation
+        #   @return [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionMetadata::DatasetValidation]
+        #     The test dataset validation information.
+        class TrainProcessorVersionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The dataset validation information.
+          # This includes any and all errors with documents and the dataset.
+          # @!attribute [rw] document_error_count
+          #   @return [::Integer]
+          #     The total number of document errors.
+          # @!attribute [rw] dataset_error_count
+          #   @return [::Integer]
+          #     The total number of dataset errors.
+          # @!attribute [rw] document_errors
+          #   @return [::Array<::Google::Rpc::Status>]
+          #     Error information pertaining to specific documents. A maximum of 10
+          #     document errors will be returned.
+          #     Any document with errors will not be used throughout training.
+          # @!attribute [rw] dataset_errors
+          #   @return [::Array<::Google::Rpc::Status>]
+          #     Error information for the dataset as a whole. A maximum of 10 dataset
+          #     errors will be returned.
+          #     A single dataset error is terminal for training.
+          class DatasetValidation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Request message for review document method.
         # @!attribute [rw] inline_document
         #   @return [::Google::Cloud::DocumentAI::V1::Document]
@@ -601,6 +685,85 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Evaluates the given ProcessorVersion against the supplied documents.
+        # @!attribute [rw] processor_version
+        #   @return [::String]
+        #     Required. The resource name of the
+        #     {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to
+        #     evaluate.
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
+        # @!attribute [rw] evaluation_documents
+        #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
+        #     Optional. The documents used in the evaluation. If unspecified, use the
+        #     processor's dataset as evaluation input.
+        class EvaluateProcessorVersionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of the EvaluateProcessorVersion method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class EvaluateProcessorVersionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of the EvaluateProcessorVersion method.
+        # @!attribute [rw] evaluation
+        #   @return [::String]
+        #     The resource name of the created evaluation.
+        class EvaluateProcessorVersionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Retrieves a specific Evaluation.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the
+        #     {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get.
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
+        class GetEvaluationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Retrieves a list of evaluations for a given ProcessorVersion.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the
+        #     {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list
+        #     evaluations for.
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token, received from a previous `ListEvaluations` call.
+        #     Provide this to retrieve the subsequent page.
+        class ListEvaluationsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response from ListEvaluations.
+        # @!attribute [rw] evaluations
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1::Evaluation>]
+        #     The evaluations requested.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token, which can be sent as `page_token` to retrieve the next page.
+        #     If this field is omitted, there are no subsequent pages.
+        class ListEvaluationsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/cloud/documentai/v1/document_schema.rb

@@ -73,7 +73,7 @@ module Google
           #     one should be set.
           # @!attribute [rw] properties
           #   @return [::Array<::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::Property>]
-          #     Describing the nested structure, or composition of an entity.
+          #     Description the nested structure, or composition of an entity.
           class EntityType
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -104,20 +104,28 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
 
-              # Types of occurrences of the entity type in the document.  Note: this
-              # represents the number of instances of an entity types, not number of
-              # mentions of a given entity instance.
+              # Types of occurrences of the entity type in the document.  This
+              # represents the number of instances of instances of an entity, not
+              # number of mentions of an entity.  For example, a bank statement may
+              # only have one `account_number`, but this account number may be
+              # mentioned in several places on the document.  In this case the
+              # 'account_number' would be considered a `REQUIRED_ONCE` entity type. If,
+              # on the other hand, we expect a bank statement to contain the status of
+              # multiple different accounts for the customers, the occurrence type will
+              # be set to `REQUIRED_MULTIPLE`.
               module OccurrenceType
                 # Unspecified occurrence type.
                 OCCURRENCE_TYPE_UNSPECIFIED = 0
 
-                # There will be zero or one instance of this entity type.
+                # There will be zero or one instance of this entity type.  The same
+                # entity instance may be mentioned multiple times.
                 OPTIONAL_ONCE = 1
 
                 # The entity type will appear zero or multiple times.
                 OPTIONAL_MULTIPLE = 2
 
-                # The entity type will only appear exactly once.
+                # The entity type will only appear exactly once.  The same
+                # entity instance may be mentioned multiple times.
                 REQUIRED_ONCE = 3
 
                 # The entity type will appear once or more times.