google-cloud-document_ai-v1 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f71dc8e586257fef847d5bf87318e19f2c03f0d44b751c3417225a6e48798abe
-  data.tar.gz: 271d8d1c30e6e1aacd4613491f1b4e687cb74eadd456762677673c7e53d2a10e
+  metadata.gz: 568828243ade46dc62adee351810bd529e24d24354d2017c5feda6a94bfbedde
+  data.tar.gz: 12ab881d48c3149f5381fb80db6bbd22209feadf74a73745b49432944ccafff9
 SHA512:
-  metadata.gz: 4faa7fafc3252a8d8af6e8b419f284b471217f832b11aba45e8cced7d745559d18c0b1e2fbf4ba35d88cd516835c58a52c55f2e652d3c39359c09a3f62f9abad
-  data.tar.gz: 9d9d3cdf093d0e0c2daebf7383b27c421f92de17c9de510a40aeb8ef88adb2818cb3059ec6c4be1eb90f603818daa3549168fbe1f6eb4f696f6aaff55505cc91
+  metadata.gz: 633c11b7fd264391bf2c0e5cc0f1e0a22f3c5aa6906600431ece6f45147c622db25960592813807d11c03e6edfd049eac0f742fd90900b04beccf87b8814f234
+  data.tar.gz: 46ce93d1e2f69c3dda3a052e0c515f8dcdc168086f94c2415093dbfefa9f0653df0fb90d7c5fa13527f029ce682bef51840cb3beed5252cd2316e24094c3477b

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

@@ -28,7 +28,7 @@ module Google
           ##
           # 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.
@@ -68,7 +68,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]
                 }
@@ -169,7 +169,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
 
@@ -202,7 +203,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).
@@ -211,6 +212,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
@@ -223,12 +226,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 [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DocumentAI::V1::ProcessResponse]
@@ -308,7 +314,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).
@@ -321,12 +327,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::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::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 [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -401,8 +413,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::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
@@ -420,9 +433,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 [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse]
@@ -507,13 +519,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.
             #
@@ -694,8 +705,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.
@@ -857,7 +868,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
@@ -869,11 +880,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:
@@ -883,7 +896,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:
@@ -1070,8 +1084,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.
@@ -1426,8 +1440,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
@@ -1448,9 +1463,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 [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DocumentAI::V1::Processor]
@@ -1922,8 +1939,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]
@@ -2215,8 +2233,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.
@@ -2409,6 +2427,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the DocumentProcessorService API.
               #

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

@@ -93,7 +93,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
 
               # Used by an LRO wrapper for some methods of this service
@@ -701,6 +702,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the Operations API.
               #