google-cloud-document_ai-v1 0.12.0 → 0.14.0

data/lib/google/cloud/document_ai/v1/document_processor_service/rest/client.rb

@@ -30,7 +30,7 @@ module Google
             ##
             # REST client for the DocumentProcessorService service.
             #
-            # Service to call Cloud DocumentAI to process documents according to the
+            # Service to call Document AI to process documents according to the
             # processor's definition. Processors are built using state-of-the-art Google
             # AI such as natural language, computer vision, and translation to extract
             # structured information from unstructured or semi-structured documents.
@@ -70,7 +70,7 @@ module Google
                                   end
                   default_config = Client::Configuration.new parent_config
 
-                  default_config.rpcs.process_document.timeout = 120.0
+                  default_config.rpcs.process_document.timeout = 300.0
                   default_config.rpcs.process_document.retry_policy = {
                     initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                   }
@@ -194,7 +194,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload process_document(inline_document: nil, raw_document: nil, name: nil, skip_human_review: nil, field_mask: nil)
+              # @overload process_document(inline_document: nil, raw_document: nil, gcs_document: nil, name: nil, skip_human_review: nil, field_mask: nil, process_options: nil)
               #   Pass arguments to `process_document` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -203,6 +203,8 @@ module Google
               #     An inline document proto.
               #   @param raw_document [::Google::Cloud::DocumentAI::V1::RawDocument, ::Hash]
               #     A raw document content (bytes).
+              #   @param gcs_document [::Google::Cloud::DocumentAI::V1::GcsDocument, ::Hash]
+              #     A raw document on Google Cloud Storage.
               #   @param name [::String]
               #     Required. The resource name of the
               #     {::Google::Cloud::DocumentAI::V1::Processor Processor} or
@@ -215,12 +217,15 @@ module Google
               #     or
               #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
               #   @param skip_human_review [::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`.
               #   @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
-              #     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::V1::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}`.
+              #   @param process_options [::Google::Cloud::DocumentAI::V1::ProcessOptions, ::Hash]
+              #     Inference-time options for the process API
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DocumentAI::V1::ProcessResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -228,6 +233,22 @@ module Google
               # @return [::Google::Cloud::DocumentAI::V1::ProcessResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::ProcessRequest.new
+              #
+              #   # Call the process_document method.
+              #   result = client.process_document request
+              #
+              #   # The returned object is of type Google::Cloud::DocumentAI::V1::ProcessResponse.
+              #   p result
+              #
               def process_document request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -277,7 +298,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload batch_process_documents(name: nil, input_documents: nil, document_output_config: nil, skip_human_review: nil)
+              # @overload batch_process_documents(name: nil, input_documents: nil, document_output_config: nil, skip_human_review: nil, process_options: nil)
               #   Pass arguments to `batch_process_documents` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -290,12 +311,18 @@ module Google
               #     or
               #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
               #   @param input_documents [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig, ::Hash]
-              #     The input documents for batch process.
+              #     The input documents for the
+              #     {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client#batch_process_documents BatchProcessDocuments}
+              #     method.
               #   @param document_output_config [::Google::Cloud::DocumentAI::V1::DocumentOutputConfig, ::Hash]
-              #     The overall output config for batch process.
+              #     The output configuration for the
+              #     {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client#batch_process_documents BatchProcessDocuments}
+              #     method.
               #   @param skip_human_review [::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`.
+              #   @param process_options [::Google::Cloud::DocumentAI::V1::ProcessOptions, ::Hash]
+              #     Inference-time options for the process API
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -303,6 +330,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::BatchProcessRequest.new
+              #
+              #   # Call the batch_process_documents method.
+              #   result = client.batch_process_documents request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def batch_process_documents request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -340,8 +390,9 @@ module Google
               end
 
               ##
-              # Fetches processor types. Note that we do not use ListProcessorTypes here
-              # because it is not paginated.
+              # Fetches processor types. Note that we don't use
+              # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client#list_processor_types ListProcessorTypes}
+              # here, because it isn't paginated.
               #
               # @overload fetch_processor_types(request, options = nil)
               #   Pass arguments to `fetch_processor_types` via a request object, either of type
@@ -359,9 +410,8 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::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}`.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -369,6 +419,22 @@ module Google
               # @return [::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::FetchProcessorTypesRequest.new
+              #
+              #   # Call the fetch_processor_types method.
+              #   result = client.fetch_processor_types request
+              #
+              #   # The returned object is of type Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse.
+              #   p result
+              #
               def fetch_processor_types request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -423,13 +489,12 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::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}`.
               #   @param page_size [::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`.
               #   @param page_token [::String]
               #     Used to retrieve the next page of results, empty if at the end of the list.
               # @yield [result, operation] Access the result along with the TransportOperation object
@@ -439,6 +504,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorType>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::ListProcessorTypesRequest.new
+              #
+              #   # Call the list_processor_types method.
+              #   result = client.list_processor_types request
+              #
+              #   # 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::Cloud::DocumentAI::V1::ProcessorType.
+              #     p item
+              #   end
+              #
               def list_processor_types request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -502,6 +587,22 @@ module Google
               # @return [::Google::Cloud::DocumentAI::V1::ProcessorType]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::GetProcessorTypeRequest.new
+              #
+              #   # Call the get_processor_type method.
+              #   result = client.get_processor_type request
+              #
+              #   # The returned object is of type Google::Cloud::DocumentAI::V1::ProcessorType.
+              #   p result
+              #
               def get_processor_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -560,8 +661,8 @@ module Google
               #     Processors. Format: `projects/{project}/locations/{location}`
               #   @param page_size [::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`.
               #   @param page_token [::String]
               #     We will return the processors sorted by creation time. The page token
               #     will point to the next processor.
@@ -572,6 +673,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Processor>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::ListProcessorsRequest.new
+              #
+              #   # Call the list_processors method.
+              #   result = client.list_processors request
+              #
+              #   # 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::Cloud::DocumentAI::V1::Processor.
+              #     p item
+              #   end
+              #
               def list_processors request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -635,6 +756,22 @@ module Google
               # @return [::Google::Cloud::DocumentAI::V1::Processor]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::GetProcessorRequest.new
+              #
+              #   # Call the get_processor method.
+              #   result = client.get_processor request
+              #
+              #   # The returned object is of type Google::Cloud::DocumentAI::V1::Processor.
+              #   p result
+              #
               def get_processor request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -673,7 +810,7 @@ module Google
               ##
               # Trains a new processor version.
               # Operation metadata is returned as
-              # cloud_documentai_core.TrainProcessorVersionMetadata.
+              # {::Google::Cloud::DocumentAI::V1::TrainProcessorVersionMetadata TrainProcessorVersionMetadata}.
               #
               # @overload train_processor_version(request, options = nil)
               #   Pass arguments to `train_processor_version` via a request object, either of type
@@ -685,11 +822,13 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload train_processor_version(parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil)
+              # @overload train_processor_version(custom_document_extraction_options: nil, parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil)
               #   Pass arguments to `train_processor_version` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
+              #   @param custom_document_extraction_options [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::CustomDocumentExtractionOptions, ::Hash]
+              #     Options to control Custom Document Extraction (CDE) Processor.
               #   @param parent [::String]
               #     Required. The parent (project, location and processor) to create the new
               #     version for. Format:
@@ -699,7 +838,8 @@ module Google
               #   @param document_schema [::Google::Cloud::DocumentAI::V1::DocumentSchema, ::Hash]
               #     Optional. The schema the processor version will be trained with.
               #   @param input_data [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData, ::Hash]
-              #     Optional. The input data used to train the `ProcessorVersion`.
+              #     Optional. The input data used to train the
+              #     {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
               #   @param base_processor_version [::String]
               #     Optional. The processor version to use as a base for training. This
               #     processor version must be a child of `parent`. Format:
@@ -711,6 +851,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest.new
+              #
+              #   # Call the train_processor_version method.
+              #   result = client.train_processor_version request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def train_processor_version request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -774,6 +937,22 @@ module Google
               # @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::GetProcessorVersionRequest.new
+              #
+              #   # Call the get_processor_version method.
+              #   result = client.get_processor_version request
+              #
+              #   # The returned object is of type Google::Cloud::DocumentAI::V1::ProcessorVersion.
+              #   p result
+              #
               def get_processor_version request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -833,8 +1012,8 @@ module Google
               #     `projects/{project}/locations/{location}/processors/{processor}`
               #   @param page_size [::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`.
               #   @param page_token [::String]
               #     We will return the processor versions sorted by creation time. The page
               #     token will point to the next processor version.
@@ -845,6 +1024,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorVersion>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::ListProcessorVersionsRequest.new
+              #
+              #   # Call the list_processor_versions method.
+              #   result = client.list_processor_versions request
+              #
+              #   # 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::Cloud::DocumentAI::V1::ProcessorVersion.
+              #     p item
+              #   end
+              #
               def list_processor_versions request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -909,6 +1108,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::DeleteProcessorVersionRequest.new
+              #
+              #   # Call the delete_processor_version method.
+              #   result = client.delete_processor_version request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def delete_processor_version request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -972,6 +1194,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::DeployProcessorVersionRequest.new
+              #
+              #   # Call the deploy_processor_version method.
+              #   result = client.deploy_processor_version request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def deploy_processor_version request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1035,6 +1280,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::UndeployProcessorVersionRequest.new
+              #
+              #   # Call the undeploy_processor_version method.
+              #   result = client.undeploy_processor_version request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def undeploy_processor_version request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1072,8 +1340,9 @@ module Google
               end
 
               ##
-              # Creates a processor from the type processor that the user chose.
-              # The processor will be at "ENABLED" state by default after its creation.
+              # Creates a processor from the
+              # {::Google::Cloud::DocumentAI::V1::ProcessorType ProcessorType} provided. The
+              # processor will be at `ENABLED` state by default after its creation.
               #
               # @overload create_processor(request, options = nil)
               #   Pass arguments to `create_processor` via a request object, either of type
@@ -1094,9 +1363,11 @@ module Google
               #     Required. The parent (project and location) under which to create the
               #     processor. Format: `projects/{project}/locations/{location}`
               #   @param processor [::Google::Cloud::DocumentAI::V1::Processor, ::Hash]
-              #     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::V1::Processor#type Processor.type} and
+              #     [Processor.display_name]][] to be set. Also, the
+              #     {::Google::Cloud::DocumentAI::V1::Processor#kms_key_name Processor.kms_key_name}
+              #     field must be set if the processor is under CMEK.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DocumentAI::V1::Processor]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1104,6 +1375,22 @@ module Google
               # @return [::Google::Cloud::DocumentAI::V1::Processor]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::CreateProcessorRequest.new
+              #
+              #   # Call the create_processor method.
+              #   result = client.create_processor request
+              #
+              #   # The returned object is of type Google::Cloud::DocumentAI::V1::Processor.
+              #   p result
+              #
               def create_processor request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1167,6 +1454,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::DeleteProcessorRequest.new
+              #
+              #   # Call the delete_processor method.
+              #   result = client.delete_processor request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def delete_processor request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1230,6 +1540,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::EnableProcessorRequest.new
+              #
+              #   # Call the enable_processor method.
+              #   result = client.enable_processor request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def enable_processor request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1293,6 +1626,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::DisableProcessorRequest.new
+              #
+              #   # Call the disable_processor method.
+              #   result = client.disable_processor request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def disable_processor request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1367,6 +1723,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::SetDefaultProcessorVersionRequest.new
+              #
+              #   # Call the set_default_processor_version method.
+              #   result = client.set_default_processor_version request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def set_default_processor_version request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1425,8 +1804,9 @@ module Google
               #   @param inline_document [::Google::Cloud::DocumentAI::V1::Document, ::Hash]
               #     An inline document proto.
               #   @param human_review_config [::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.v1.HumanReviewConfig] that the
+              #     document will be reviewed with.
               #   @param enable_schema_validation [::Boolean]
               #     Whether the validation should be performed on the ad-hoc review request.
               #   @param priority [::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest::Priority]
@@ -1440,6 +1820,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::ReviewDocumentRequest.new
+              #
+              #   # Call the review_document method.
+              #   result = client.review_document request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def review_document request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1510,6 +1913,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::EvaluateProcessorVersionRequest.new
+              #
+              #   # Call the evaluate_processor_version method.
+              #   result = client.evaluate_processor_version request
+              #
+              #   # 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 "No response received."
+              #   end
+              #
               def evaluate_processor_version request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1575,6 +2001,22 @@ module Google
               # @return [::Google::Cloud::DocumentAI::V1::Evaluation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::GetEvaluationRequest.new
+              #
+              #   # Call the get_evaluation method.
+              #   result = client.get_evaluation request
+              #
+              #   # The returned object is of type Google::Cloud::DocumentAI::V1::Evaluation.
+              #   p result
+              #
               def get_evaluation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1635,8 +2077,8 @@ module Google
               #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
               #   @param page_size [::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`.
               #   @param page_token [::String]
               #     A page token, received from a previous `ListEvaluations` call.
               #     Provide this to retrieve the subsequent page.
@@ -1647,6 +2089,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Evaluation>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/document_ai/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DocumentAI::V1::ListEvaluationsRequest.new
+              #
+              #   # Call the list_evaluations method.
+              #   result = client.list_evaluations request
+              #
+              #   # 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::Cloud::DocumentAI::V1::Evaluation.
+              #     p item
+              #   end
+              #
               def list_evaluations request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?