google-cloud-document_ai-v1beta3 0.23.0 → 0.24.0

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

@@ -24,14 +24,16 @@ module Google
         # Options for Process API
         # @!attribute [rw] ocr_config
         #   @return [::Google::Cloud::DocumentAI::V1beta3::OcrConfig]
-        #     Only applicable to "Document OCR Processor". Returns error if set on other
+        #     Only applicable to `OCR_PROCESSOR`. Returns error if set on other
         #     processor types.
         class ProcessOptions
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for the process document method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#process_document ProcessDocument}
+        # method.
         # @!attribute [rw] inline_document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
         #     An inline document proto.
@@ -52,16 +54,20 @@ module Google
         #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
         # @!attribute [rw] document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
-        #     The document payload, the [content] and [mime_type] fields must be set.
+        #     The document payload, the
+        #     {::Google::Cloud::DocumentAI::V1beta3::Document#content content} and
+        #     {::Google::Cloud::DocumentAI::V1beta3::Document#mime_type mime_type} fields must
+        #     be set.
         # @!attribute [rw] skip_human_review
         #   @return [::Boolean]
-        #     Whether Human Review feature should be skipped for this request. Default to
-        #     false.
+        #     Whether human review should be skipped for this request. Default to
+        #     `false`.
         # @!attribute [rw] field_mask
         #   @return [::Google::Protobuf::FieldMask]
-        #     Specifies which fields to include in ProcessResponse's document.
-        #     Only supports top level document and pages field so it must be in the form
-        #     of `{document_field_name}` or `pages.{page_field_name}`.
+        #     Specifies which fields to include in the
+        #     {::Google::Cloud::DocumentAI::V1beta3::ProcessResponse#document ProcessResponse.document}
+        #     output. Only supports top-level document and pages field, so it must be in
+        #     the form of `{document_field_name}` or `pages.{page_field_name}`.
         # @!attribute [rw] process_options
         #   @return [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions]
         #     Inference-time options for the process API
@@ -80,9 +86,11 @@ module Google
         # @!attribute [rw] human_review_operation
         #   @return [::String]
         #     The name of the operation triggered by the processed document. This field
-        #     is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has
-        #     the same response type and metadata as the long running operation returned
-        #     by [ReviewDocument] method.
+        #     is populated only when the
+        #     {::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus#state state} is
+        #     `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as
+        #     the long-running operation returned by
+        #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}.
         class HumanReviewStatus
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -93,7 +101,7 @@ module Google
             STATE_UNSPECIFIED = 0
 
             # Human review is skipped for the document. This can happen because human
-            # review is not enabled on the processor or the processing request has
+            # review isn't enabled on the processor or the processing request has
             # been set to skip this document.
             SKIPPED = 1
 
@@ -104,12 +112,15 @@ module Google
             IN_PROGRESS = 3
 
             # Some error happened during triggering human review, see the
-            # [state_message] for details.
+            # {::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus#state_message state_message}
+            # for details.
             ERROR = 4
           end
         end
 
-        # Response message for the process document method.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#process_document ProcessDocument}
+        # method.
         # @!attribute [rw] document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
         #     The document payload, will populate fields based on the processor's
@@ -117,9 +128,9 @@ module Google
         # @!attribute [rw] human_review_operation
         #   @return [::String]
         #     The name of the operation triggered by the processed document. If the human
-        #     review process is not triggered, this field will be empty. It has the same
-        #     response type and metadata as the long running operation returned by
-        #     ReviewDocument method.
+        #     review process isn't triggered, this field is empty. It has the same
+        #     response type and metadata as the long-running operation returned by
+        #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}.
         # @!attribute [rw] human_review_status
         #   @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
         #     The status of human review on the processed document.
@@ -128,7 +139,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for batch process document method.
+        # Request message for
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of
@@ -145,14 +157,18 @@ module Google
         #     The overall output config for batch process.
         # @!attribute [rw] input_documents
         #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
-        #     The input documents for batch process.
+        #     The input documents for the
+        #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
+        #     method.
         # @!attribute [rw] document_output_config
         #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig]
-        #     The overall output config for batch process.
+        #     The output configuration for the
+        #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
+        #     method.
         # @!attribute [rw] skip_human_review
         #   @return [::Boolean]
-        #     Whether Human Review feature should be skipped for this request. Default to
-        #     false.
+        #     Whether human review should be skipped for this request. Default to
+        #     `false`.
         # @!attribute [rw] process_options
         #   @return [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions]
         #     Inference-time options for the process API
@@ -166,15 +182,21 @@ module Google
           #     The Cloud Storage location as the source of the document.
           # @!attribute [rw] mime_type
           #   @return [::String]
-          #     Mimetype of the input. If the input is a raw document, the supported
-          #     mimetypes are application/pdf, image/tiff, and image/gif.
-          #     If the input is a [Document] proto, the type should be application/json.
+          #     An IANA published [media type (MIME
+          #     type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of
+          #     the input. If the input is a raw document, refer to [supported file
+          #     types](https://cloud.google.com/document-ai/docs/file-types) for the list
+          #     of media types. If the input is a
+          #     {::Google::Cloud::DocumentAI::V1beta3::Document Document}, the type should be
+          #     `application/json`.
           class BatchInputConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # The message for output config in batch process.
+          # The output configuration in the
+          # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
+          # method.
           # @!attribute [rw] gcs_destination
           #   @return [::String]
           #     The output Cloud Storage directory to put the processed documents.
@@ -184,13 +206,15 @@ module Google
           end
         end
 
-        # Response message for batch process document method.
+        # Response message for
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}.
         class BatchProcessResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The long running operation metadata for batch process method.
+        # The long-running operation metadata for
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}.
         # @!attribute [rw] state
         #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata::State]
         #     The state of the current batch processing.
@@ -214,23 +238,25 @@ module Google
           # The status of a each individual document in the batch process.
           # @!attribute [rw] input_gcs_source
           #   @return [::String]
-          #     The source of the document, same as the [input_gcs_source] field in the
-          #     request when the batch process started. The batch process is started by
-          #     take snapshot of that document, since a user can move or change that
-          #     document during the process.
+          #     The source of the document, same as the
+          #     {::Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source}
+          #     field in the request when the batch process started.
           # @!attribute [rw] status
           #   @return [::Google::Rpc::Status]
           #     The status processing the document.
           # @!attribute [rw] output_gcs_destination
           #   @return [::String]
-          #     The output_gcs_destination (in the request as `output_gcs_destination`)
+          #     The Cloud Storage output destination (in the request as
+          #     {::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri})
           #     of the processed document if it was successful, otherwise empty.
           # @!attribute [rw] human_review_operation
           #   @return [::String]
           #     The name of the operation triggered by the processed document. If the
-          #     human review process is not triggered, this field will be empty. It has
-          #     the same response type and metadata as the long running operation
-          #     returned by ReviewDocument method.
+          #     human review process isn't triggered, this field will be empty. It has
+          #     the same response type and metadata as the long-running operation
+          #     returned by the
+          #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}
+          #     method.
           # @!attribute [rw] human_review_status
           #   @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
           #     The status of human review on the processed document.
@@ -264,18 +290,22 @@ module Google
           end
         end
 
-        # Request message for fetch processor types.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}
+        # method. Some processor types may require the project be added to an
+        # allowlist.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The project of processor type to list.
-        #     The available processor types may depend on the allow-listing on projects.
-        #     Format: `projects/{project}/locations/{location}`
+        #     Required. The location of processor types to list.
+        #     Format: `projects/{project}/locations/{location}`.
         class FetchProcessorTypesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for fetch processor types.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}
+        # method.
         # @!attribute [rw] processor_types
         #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType>]
         #     The list of processor types.
@@ -284,17 +314,19 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for list processor types.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#list_processor_types ListProcessorTypes}
+        # method. Some processor types may require the project be added to an
+        # allowlist.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The location of processor type to list.
-        #     The available processor types may depend on the allow-listing on projects.
-        #     Format: `projects/{project}/locations/{location}`
+        #     Required. The location of processor types to list.
+        #     Format: `projects/{project}/locations/{location}`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     The maximum number of processor types to return.
-        #     If unspecified, at most 100 processor types will be returned.
-        #     The maximum value is 500; values above 500 will be coerced to 500.
+        #     If unspecified, at most `100` processor types will be returned.
+        #     The maximum value is `500`. Values above `500` will be coerced to `500`.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     Used to retrieve the next page of results, empty if at the end of the list.
@@ -303,7 +335,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for list processor types.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#list_processor_types ListProcessorTypes}
+        # method.
         # @!attribute [rw] processor_types
         #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType>]
         #     The processor types.
@@ -323,8 +357,8 @@ module Google
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     The maximum number of processors to return.
-        #     If unspecified, at most 50 processors will be returned.
-        #     The maximum value is 100; values above 100 will be coerced to 100.
+        #     If unspecified, at most `50` processors will be returned.
+        #     The maximum value is `100`. Values above `100` will be coerced to `100`.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     We will return the processors sorted by creation time. The page token
@@ -334,7 +368,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for list processors.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#list_processors ListProcessors}
+        # method.
         # @!attribute [rw] processors
         #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Processor>]
         #     The list of processors.
@@ -346,7 +382,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for get processor.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#get_processor_type GetProcessorType}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor type resource name.
@@ -355,7 +393,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for get processor.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#get_processor GetProcessor}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor resource name.
@@ -364,7 +404,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for get processor version.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#get_processor_version GetProcessorVersion}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor resource name.
@@ -382,8 +424,8 @@ module Google
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     The maximum number of processor versions to return.
-        #     If unspecified, at most 10 processor versions will be returned.
-        #     The maximum value is 20; values above 20 will be coerced to 20.
+        #     If unspecified, at most `10` processor versions will be returned.
+        #     The maximum value is `20`. Values above `20` will be coerced to `20`.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     We will return the processor versions sorted by creation time. The page
@@ -393,7 +435,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for list processors.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#list_processor_versions ListProcessorVersions}
+        # method.
         # @!attribute [rw] processor_versions
         #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion>]
         #     The list of processors.
@@ -405,7 +449,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for the delete processor version method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#delete_processor_version DeleteProcessorVersion}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor version resource name to be deleted.
@@ -414,16 +460,20 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The long running operation metadata for delete processor version method.
+        # The long-running operation metadata for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#delete_processor_version DeleteProcessorVersion}
+        # method.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     The basic metadata of the long-running operation.
         class DeleteProcessorVersionMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for the deploy processor version method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#deploy_processor_version DeployProcessorVersion}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor version resource name to be deployed.
@@ -432,22 +482,28 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for the deploy processor version method.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#deploy_processor_version DeployProcessorVersion}
+        # method.
         class DeployProcessorVersionResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The long running operation metadata for deploy processor version method.
+        # The long-running operation metadata for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#deploy_processor_version DeployProcessorVersion}
+        # method.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     The basic metadata of the long-running operation.
         class DeployProcessorVersionMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for the undeploy processor version method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#undeploy_processor_version UndeployProcessorVersion}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor version resource name to be undeployed.
@@ -456,40 +512,49 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for the undeploy processor version method.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#undeploy_processor_version UndeployProcessorVersion}
+        # method.
         class UndeployProcessorVersionResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The long running operation metadata for the undeploy processor version
+        # The long-running operation metadata for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#undeploy_processor_version UndeployProcessorVersion}
         # method.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     The basic metadata of the long-running operation.
         class UndeployProcessorVersionMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for create a processor. Notice this request is sent to
-        # a regionalized backend service, and if the processor type is not available
-        # on that region, the creation will fail.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#create_processor CreateProcessor}
+        # method. Notice this request is sent to a regionalized backend service. If the
+        # {::Google::Cloud::DocumentAI::V1beta3::ProcessorType ProcessorType} isn't
+        # available in that region, the creation fails.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent (project and location) under which to create the
         #     processor. Format: `projects/{project}/locations/{location}`
         # @!attribute [rw] processor
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Processor]
-        #     Required. The processor to be created, requires [processor_type] and
-        #     [display_name] to be set. Also, the processor is under CMEK if CMEK fields
-        #     are set.
+        #     Required. The processor to be created, requires
+        #     {::Google::Cloud::DocumentAI::V1beta3::Processor#type Processor.type} and
+        #     [Processor.display_name]][] to be set. Also, the
+        #     {::Google::Cloud::DocumentAI::V1beta3::Processor#kms_key_name Processor.kms_key_name}
+        #     field must be set if the processor is under CMEK.
         class CreateProcessorRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for the delete processor method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#delete_processor DeleteProcessor}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor resource name to be deleted.
@@ -498,16 +563,20 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The long running operation metadata for delete processor method.
+        # The long-running operation metadata for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#delete_processor DeleteProcessor}
+        # method.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     The basic metadata of the long-running operation.
         class DeleteProcessorMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for the enable processor method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#enable_processor EnableProcessor}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor resource name to be enabled.
@@ -516,23 +585,28 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for the enable processor method.
-        # Intentionally empty proto for adding fields in future.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#enable_processor EnableProcessor}
+        # method. Intentionally empty proto for adding fields in future.
         class EnableProcessorResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The long running operation metadata for enable processor method.
+        # The long-running operation metadata for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#enable_processor EnableProcessor}
+        # method.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     The basic metadata of the long-running operation.
         class EnableProcessorMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for the disable processor method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#disable_processor DisableProcessor}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor resource name to be disabled.
@@ -541,23 +615,28 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for the disable processor method.
-        # Intentionally empty proto for adding fields in future.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#disable_processor DisableProcessor}
+        # method. Intentionally empty proto for adding fields in future.
         class DisableProcessorResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The long running operation metadata for disable processor method.
+        # The long-running operation metadata for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#disable_processor DisableProcessor}
+        # method.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     The basic metadata of the long-running operation.
         class DisableProcessorMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for the set default processor version method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#set_default_processor_version SetDefaultProcessorVersion}
+        # method.
         # @!attribute [rw] processor
         #   @return [::String]
         #     Required. The resource name of the
@@ -574,23 +653,31 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for set default processor version method.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#set_default_processor_version SetDefaultProcessorVersion}
+        # method.
         class SetDefaultProcessorVersionResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The long running operation metadata for set default processor version
+        # The long-running operation metadata for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#set_default_processor_version SetDefaultProcessorVersion}
         # method.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     The basic metadata of the long-running operation.
         class SetDefaultProcessorVersionMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for the create processor version method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#train_processor_version TrainProcessorVersion}
+        # method.
+        # @!attribute [rw] custom_document_extraction_options
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions]
+        #     Options to control Custom Document Extraction (CDE) Processor.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent (project, location and processor) to create the new
@@ -604,7 +691,8 @@ module Google
         #     Optional. The schema the processor version will be trained with.
         # @!attribute [rw] input_data
         #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::InputData]
-        #     Optional. The input data used to train the `ProcessorVersion`.
+        #     Optional. The input data used to train the
+        #     {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
         # @!attribute [rw] base_processor_version
         #   @return [::String]
         #     Optional. The processor version to use as a base for training. This
@@ -614,7 +702,8 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # The input data used to train a new `ProcessorVersion`.
+          # The input data used to train a new
+          # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
           # @!attribute [rw] training_documents
           #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
           #     The documents used for training the new version.
@@ -625,9 +714,30 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Options to control the training of the Custom Document Extraction (CDE)
+          # Processor.
+          # @!attribute [rw] training_method
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions::TrainingMethod]
+          #     Training method to use for CDE training.
+          class CustomDocumentExtractionOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Training Method for CDE. TRAINING_METHOD_UNSPECIFIED will fallback to
+            # MODEL_BASED.
+            module TrainingMethod
+              TRAINING_METHOD_UNSPECIFIED = 0
+
+              MODEL_BASED = 1
+
+              TEMPLATE_BASED = 2
+            end
+          end
         end
 
-        # The response for the TrainProcessorVersion method.
+        # The response for
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#train_processor_version TrainProcessorVersion}.
         # @!attribute [rw] processor_version
         #   @return [::String]
         #     The resource name of the processor version produced by training.
@@ -639,7 +749,7 @@ module Google
         # The metadata that represents a processor version being created.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     The basic metadata of the long-running operation.
         # @!attribute [rw] training_dataset_validation
         #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionMetadata::DatasetValidation]
         #     The training dataset validation information.
@@ -674,14 +784,17 @@ module Google
           end
         end
 
-        # Request message for review document method.
+        # Request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}
+        # method.
         # @!attribute [rw] inline_document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
         #     An inline document proto.
         # @!attribute [rw] human_review_config
         #   @return [::String]
-        #     Required. The resource name of the HumanReviewConfig that the document will
-        #     be reviewed with.
+        #     Required. The resource name of the
+        #     [HumanReviewConfig][google.cloud.documentai.v1beta3.HumanReviewConfig] that
+        #     the document will be reviewed with.
         # @!attribute [rw] document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
         #     The document that needs human review.
@@ -709,7 +822,9 @@ module Google
           end
         end
 
-        # Response message for review document method.
+        # Response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}
+        # method.
         # @!attribute [rw] gcs_destination
         #   @return [::String]
         #     The Cloud Storage uri for the human reviewed document if the review is
@@ -737,7 +852,9 @@ module Google
           end
         end
 
-        # The long running operation metadata for review document method.
+        # The long-running operation metadata for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}
+        # method.
         # @!attribute [rw] state
         #   @return [::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentOperationMetadata::State]
         #     Used only when Operation.done is false.
@@ -753,7 +870,7 @@ module Google
         #     The last update time of the operation.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     The basic metadata of the long-running operation.
         # @!attribute [rw] question_id
         #   @return [::String]
         #     The Crowd Compute question ID.
@@ -761,7 +878,7 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # State of the longrunning operation.
+          # State of the long-running operation.
           module State
             # Unspecified state.
             STATE_UNSPECIFIED = 0
@@ -783,7 +900,9 @@ module Google
           end
         end
 
-        # Evaluates the given ProcessorVersion against the supplied documents.
+        # Evaluates the given
+        # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion} against
+        # the supplied documents.
         # @!attribute [rw] processor_version
         #   @return [::String]
         #     Required. The resource name of the
@@ -799,16 +918,20 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Metadata of the EvaluateProcessorVersion method.
+        # Metadata of the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#evaluate_processor_version EvaluateProcessorVersion}
+        # method.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata of the long running operation.
+        #     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.
+        # Response of the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#evaluate_processor_version EvaluateProcessorVersion}
+        # method.
         # @!attribute [rw] evaluation
         #   @return [::String]
         #     The resource name of the created evaluation.
@@ -828,7 +951,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Retrieves a list of evaluations for a given ProcessorVersion.
+        # Retrieves a list of evaluations for a given
+        # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The resource name of the
@@ -838,8 +962,8 @@ module Google
         # @!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.
+        #     If unspecified, at most `5` evaluations are returned.
+        #     The maximum value is `100`. Values above `100` are coerced to `100`.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     A page token, received from a previous `ListEvaluations` call.
@@ -849,7 +973,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response from ListEvaluations.
+        # The response from `ListEvaluations`.
         # @!attribute [rw] evaluations
         #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation>]
         #     The evaluations requested.
@@ -862,19 +986,27 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request message for the ImportProcessorVersion method.
-        # This method requires Document AI Service Agent of the destination project in
-        # the source project's IAM with [Document AI Editor
-        # role](https://cloud.google.com/document-ai/docs/access-control/iam-roles).
+        # The request message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#import_processor_version ImportProcessorVersion}
+        # method. Requirements:
         #
-        # The destination project is specified as part of the `parent` field.
-        # The source project is specified as part of `source` field.
+        # - The source processor version and destination processor
+        # must be in the same location.
+        # - The Document AI [Service
+        # Agent](https://cloud.google.com/iam/docs/service-agents) of the destination
+        # project must have [Document AI Editor
+        # role](https://cloud.google.com/document-ai/docs/access-control/iam-roles) on
+        # the source project.
         #
-        # The Service Agent for Document AI can be found in
-        # https://cloud.google.com/iam/docs/service-agents.
+        # The destination project is specified as part of the
+        # {::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest#parent parent}
+        # field. The source project is specified as part of the
+        # {::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest#processor_version_source source}
+        # field.
         # @!attribute [rw] processor_version_source
         #   @return [::String]
-        #     The source processor version to import from.
+        #     The source processor version to import from. The source processor version
+        #     and destination processor need to be in the same environment and region.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The destination processor name to create the processor version
@@ -885,7 +1017,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response message for the ImportProcessorVersion method.
+        # The response message for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#import_processor_version ImportProcessorVersion}
+        # method.
         # @!attribute [rw] processor_version
         #   @return [::String]
         #     The destination processor version name.
@@ -894,11 +1028,12 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The long running operation metadata for the ImportProcessorVersion
+        # The long-running operation metadata for the
+        # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#import_processor_version ImportProcessorVersion}
         # method.
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
-        #     The basic metadata for the long running operation.
+        #     The basic metadata for the long-running operation.
         class ImportProcessorVersionMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods