google-cloud-document_ai-v1 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e135a1c1d1705ed69b0cda0ee44b859ce86d67facf10cb46020c7a012af68661
-  data.tar.gz: 9d70cee5408d9e65ffc99f3e1c172f5b2c7fcb55797f2ed581441a95e3ed3c7c
+  metadata.gz: 24fbe2305962ad733b73b86b892f2cc056719f9b15ae68448b51af84f6f8e41e
+  data.tar.gz: 5ec64c940d4f4cee643127bcbf8574a87bceeebf170e2e329c9ba9d2ad9c28d2
 SHA512:
-  metadata.gz: 7e9ec87315d2863124668d05c73d639a7e9d46bec117e000940add79d2cacee62232b5f0b6d3a260f40f1e9b41bd173832591d45faaa2d611a269a62e0eaf94b
-  data.tar.gz: bae847834df1ed702d5946ee13ad02638db8aba3418d59cd8058e099c15762ac866d9b78a338888b2403846e43bd485d2f2e6d3aafa37671e2e8138e5ba6fc3a
+  metadata.gz: e0b706410acad88a8670fcd63053426d20a3de05d4aa97d1e573c583262af4bbe6394df875c26bcbe0c7e0cfa4550cf96988db55b1acbf8def5e9ac2e5b7eb30
+  data.tar.gz: 69bedf13c4c6362ca21903f79eafc347420b2222931a545679ecac9351e9df6dbb0224b09ae5ae2e87147028dbdc1e319a017910e3ae25a66e5ffb9bb9252d57

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-document_ai-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Credentials}):
 
-1. `DOCUMENT_AI_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `DOCUMENT_AI_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `DOCUMENT_AI_CREDENTIALS` - Path to JSON file, or JSON contents
+* `DOCUMENT_AI_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/document_ai/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/document_ai/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new d
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/document_ai/v1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/document_ai/v1"
 
 client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
-request = my_create_request
+request = ::Google::Cloud::DocumentAI::V1::ProcessRequest.new # (request fields as keyword arguments...)
 response = client.process_document request
 ```
 

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

@@ -44,13 +44,12 @@ module Google
             # See {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all DocumentProcessorService clients:
-            #
-            #     ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all DocumentProcessorService clients
+            #   ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -70,26 +69,17 @@ module Google
 
                 default_config.rpcs.process_document.timeout = 120.0
                 default_config.rpcs.process_document.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay: 60.0,
-                  multiplier: 1.3,
-                  retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.batch_process_documents.timeout = 120.0
                 default_config.rpcs.batch_process_documents.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay: 60.0,
-                  multiplier: 1.3,
-                  retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.review_document.timeout = 120.0
                 default_config.rpcs.review_document.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay: 60.0,
-                  multiplier: 1.3,
-                  retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config
@@ -121,19 +111,15 @@ module Google
             ##
             # Create a new DocumentProcessorService client object.
             #
-            # ## Examples
-            #
-            # To create a new DocumentProcessorService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
             #
-            # To create a new DocumentProcessorService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the DocumentProcessorService client.
             # @yieldparam config [Client::Configuration]
@@ -153,14 +139,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -225,6 +210,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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?
 
@@ -242,16 +242,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.process_document.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.process_document.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :process_document, request, options: options do |response, operation|
@@ -299,6 +303,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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 this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def batch_process_documents request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -316,16 +342,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.batch_process_documents.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.batch_process_documents.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :batch_process_documents, request, options: options do |response, operation|
@@ -351,7 +381,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload review_document(inline_document: nil, human_review_config: nil)
+            # @overload review_document(inline_document: nil, human_review_config: nil, enable_schema_validation: nil, priority: nil)
             #   Pass arguments to `review_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).
@@ -361,6 +391,10 @@ module Google
             #   @param human_review_config [::String]
             #     Required. The resource name of the 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]
+            #     The priority of the human review task.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -370,6 +404,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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 this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def review_document request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -387,16 +443,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "human_review_config" => request.human_review_config
-              }
+              header_params = {}
+              if request.human_review_config
+                header_params["human_review_config"] = request.human_review_config
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.review_document.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.review_document.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @document_processor_service_stub.call_rpc :review_document, request, options: options do |response, operation|
@@ -421,22 +481,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for process_document
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.process_document.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.process_document.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # process_document to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.process_document.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.process_document.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

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

@@ -82,7 +82,7 @@ module Google
               # Create credentials
               credentials = @config.credentials
               credentials ||= Credentials.default scope: @config.scope
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -143,6 +143,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::ListOperationsRequest.new
+            #
+            #   # Call the list_operations method.
+            #   result = client.list_operations request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Longrunning::Operation.
+            #     p response
+            #   end
+            #
             def list_operations request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -160,16 +181,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.list_operations.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_operations.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -213,6 +238,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::GetOperationRequest.new
+            #
+            #   # Call the get_operation method.
+            #   result = client.get_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def get_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -230,16 +277,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.get_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -283,6 +334,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::DeleteOperationRequest.new
+            #
+            #   # Call the delete_operation method.
+            #   result = client.delete_operation request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -300,16 +366,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.delete_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -358,6 +428,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::CancelOperationRequest.new
+            #
+            #   # Call the cancel_operation method.
+            #   result = client.cancel_operation request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def cancel_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -375,16 +460,20 @@ module Google
                 gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.cancel_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.cancel_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -436,6 +525,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::WaitOperationRequest.new
+            #
+            #   # Call the wait_operation method.
+            #   result = client.wait_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def wait_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -456,7 +567,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.wait_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +594,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for list_operations
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Longrunning::Operations::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_operations.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Longrunning::Operations::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_operations.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_operations to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Longrunning::Operations::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_operations.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Longrunning::Operations::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_operations.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module DocumentAI
       module V1
-        VERSION = "0.1.0"
+        VERSION = "0.2.3"
       end
     end
   end

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

@@ -1,9 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/documentai/v1/document_io.proto
 
+require 'google/api/annotations_pb'
 require 'google/protobuf'
 
-require 'google/api/annotations_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/documentai/v1/document_io.proto", :syntax => :proto3) do
     add_message "google.cloud.documentai.v1.RawDocument" do

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/documentai/v1/document.proto
 
-require 'google/protobuf'
-
 require 'google/api/field_behavior_pb'
 require 'google/cloud/documentai/v1/geometry_pb'
 require 'google/protobuf/timestamp_pb'
@@ -13,6 +11,8 @@ require 'google/type/datetime_pb'
 require 'google/type/money_pb'
 require 'google/type/postal_address_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/documentai/v1/document.proto", :syntax => :proto3) do
     add_message "google.cloud.documentai.v1.Document" do
@@ -63,6 +63,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :visual_elements, :message, 9, "google.cloud.documentai.v1.Document.Page.VisualElement"
       repeated :tables, :message, 10, "google.cloud.documentai.v1.Document.Page.Table"
       repeated :form_fields, :message, 11, "google.cloud.documentai.v1.Document.Page.FormField"
+      optional :provenance, :message, 16, "google.cloud.documentai.v1.Document.Provenance"
     end
     add_message "google.cloud.documentai.v1.Document.Page.Dimension" do
       optional :width, :float, 1
@@ -150,6 +151,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :name_detected_languages, :message, 3, "google.cloud.documentai.v1.Document.Page.DetectedLanguage"
       repeated :value_detected_languages, :message, 4, "google.cloud.documentai.v1.Document.Page.DetectedLanguage"
       optional :value_type, :string, 5
+      optional :provenance, :message, 8, "google.cloud.documentai.v1.Document.Provenance"
     end
     add_message "google.cloud.documentai.v1.Document.Page.DetectedLanguage" do
       optional :language_code, :string, 1
@@ -219,6 +221,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.documentai.v1.Document.Provenance.Parent" do
       optional :revision, :int32, 1
+      optional :index, :int32, 3
       optional :id, :int32, 2
     end
     add_enum "google.cloud.documentai.v1.Document.Provenance.OperationType" do

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/documentai/v1/document_processor_service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -14,6 +12,8 @@ require 'google/longrunning/operations_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/documentai/v1/document_processor_service.proto", :syntax => :proto3) do
     add_message "google.cloud.documentai.v1.ProcessRequest" do
@@ -72,10 +72,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.documentai.v1.ReviewDocumentRequest" do
       optional :human_review_config, :string, 1
+      optional :enable_schema_validation, :bool, 3
+      optional :priority, :enum, 5, "google.cloud.documentai.v1.ReviewDocumentRequest.Priority"
       oneof :source do
         optional :inline_document, :message, 4, "google.cloud.documentai.v1.Document"
       end
     end
+    add_enum "google.cloud.documentai.v1.ReviewDocumentRequest.Priority" do
+      value :DEFAULT, 0
+      value :URGENT, 1
+    end
     add_message "google.cloud.documentai.v1.ReviewDocumentResponse" do
       optional :gcs_destination, :string, 1
     end
@@ -99,6 +105,7 @@ module Google
         BatchProcessMetadata::IndividualProcessStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus").msgclass
         BatchProcessMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.BatchProcessMetadata.State").enummodule
         ReviewDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ReviewDocumentRequest").msgclass
+        ReviewDocumentRequest::Priority = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ReviewDocumentRequest.Priority").enummodule
         ReviewDocumentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ReviewDocumentResponse").msgclass
         ReviewDocumentOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ReviewDocumentOperationMetadata").msgclass
       end

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

@@ -30,7 +30,7 @@ module Google
           # structured information from unstructured or semi-structured documents.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

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

@@ -1,9 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/documentai/v1/geometry.proto
 
+require 'google/api/annotations_pb'
 require 'google/protobuf'
 
-require 'google/api/annotations_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/documentai/v1/geometry.proto", :syntax => :proto3) do
     add_message "google.cloud.documentai.v1.Vertex" do

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

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/documentai/v1/operation_metadata.proto
 
-require 'google/protobuf'
-
 require 'google/protobuf/timestamp_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/documentai/v1/operation_metadata.proto", :syntax => :proto3) do
     add_message "google.cloud.documentai.v1.CommonOperationMetadata" do

data/proto_docs/google/api/field_behavior.rb

@@ -60,6 +60,12 @@ module Google
       # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

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

@@ -190,6 +190,9 @@ module Google
           # @!attribute [rw] form_fields
           #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::FormField>]
           #     A list of visually detected form fields on the page.
+          # @!attribute [rw] provenance
+          #   @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
+          #     The history of this page.
           class Page
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -461,6 +464,9 @@ module Google
             #     - blank (this indicates the field_value is normal text)
             #     - "unfilled_checkbox"
             #     - "filled_checkbox"
+            # @!attribute [rw] provenance
+            #   @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
+            #     The history of this annotation.
             class FormField
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -621,6 +627,8 @@ module Google
             #   @return [::Integer]
             #     Required. Index into the {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages} element, for example using
             #     [Document.pages][page_refs.page] to locate the related page element.
+            #     This field is skipped when its value is the default 0. See
+            #     https://developers.google.com/protocol-buffers/docs/proto3#json.
             # @!attribute [rw] layout_type
             #   @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType]
             #     Optional. The type of the layout element that is being referenced if any.
@@ -691,6 +699,10 @@ module Google
             # @!attribute [rw] revision
             #   @return [::Integer]
             #     The index of the [Document.revisions] identifying the parent revision.
+            # @!attribute [rw] index
+            #   @return [::Integer]
+            #     The index of the parent revisions corresponding collection of items
+            #     (eg. list of entities, properties within entities, etc.)
             # @!attribute [rw] id
             #   @return [::Integer]
             #     The id of the parent provenance.

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

@@ -193,9 +193,25 @@ module Google
         #   @return [::String]
         #     Required. The resource name of the HumanReviewConfig that the document will be
         #     reviewed with.
+        # @!attribute [rw] enable_schema_validation
+        #   @return [::Boolean]
+        #     Whether the validation should be performed on the ad-hoc review request.
+        # @!attribute [rw] priority
+        #   @return [::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest::Priority]
+        #     The priority of the human review task.
         class ReviewDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The priority level of the human review task.
+          module Priority
+            # The default priority level.
+            DEFAULT = 0
+
+            # The urgent priority level. The labeling manager should allocate labeler
+            # resource to the urgent task queue to respect this priority level.
+            URGENT = 1
+          end
         end
 
         # Response message for review document method.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a