google-cloud-document_ai-v1 0.13.0 → 0.15.0

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

@@ -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
@@ -222,6 +224,8 @@ module Google
               #     {::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]
@@ -229,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?
 
@@ -278,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).
@@ -301,6 +321,8 @@ module Google
               #   @param skip_human_review [::Boolean]
               #     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]
@@ -308,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?
 
@@ -374,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?
 
@@ -443,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?
 
@@ -506,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?
 
@@ -576,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?
 
@@ -639,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?
 
@@ -689,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:
@@ -716,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?
 
@@ -779,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?
 
@@ -850,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?
 
@@ -914,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?
 
@@ -977,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?
 
@@ -1040,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?
 
@@ -1112,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?
 
@@ -1175,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?
 
@@ -1238,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?
 
@@ -1301,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?
 
@@ -1375,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?
 
@@ -1449,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?
 
@@ -1519,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?
 
@@ -1584,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?
 
@@ -1656,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?