google-cloud-document_ai-v1beta3 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c468df9db12ad0d32f31243c0c581cc41d2caaeb6400c97481af10bbe8e33c
-  data.tar.gz: eee073b86cbfaeec30f69b2492169e7a38acb327322636f623ea4a85f36c71d6
+  metadata.gz: e0c9d575f9c01541fe46b985d6386ea3f38ef540dc7a77b497df3e683ce8afc4
+  data.tar.gz: fa25f03cb9ac13c8b3ecf738da03665ad6ec187dc3b6352087a6cd7582bef9d6
 SHA512:
-  metadata.gz: 73ce56b1b088efe13921b21767f5b702e5e0383de2047231dfa095f94b74edd6132b12fb01765666fad16433f41c16df97cf5c947d2fdee40b3dbe5a014fb769
-  data.tar.gz: 611dc1bc7f7f89150374091cae56f1afb23f6849c9a0d5d2e02a25368aa43cec0e4cdf64c83fffcb9fbc0626031c0e699322103b8bf403dde8386612a4f60cf9
+  metadata.gz: 398b11a2c1f5585a1cf036dfdadf8d26eedf30fd464a559221d09a31652f63ae8abf78082ab5b722ce5af5d472c3cf0e3488cdbbbffc60ffb315cf40627087f7
+  data.tar.gz: 5f02e1764e8e984892a1989605ea77d3f9c72c43e95056fe8f2388141ecab4fd8ef62da85643063b874ae8a27642436d7b690b2eb48ee55d22dd7690f4fd77e1

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Document AI V1beta3 API
 
-API Client library for the Document AI V1beta3 API
+Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.
 
 Document AI uses machine learning on a single cloud-based platform to automatically classify, extract, and enrich data within your documents to unlock insights.
 

data/lib/google/cloud/document_ai/v1beta3/bindings_override.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/config"
+
+module Google
+  module Cloud
+    module DocumentAI
+      ##
+      # @example Loading just the REST part of this package, including all its services, and instantiating a REST client
+      #
+      #     require "google/cloud/document_ai/v1beta3/rest"
+      #     client = ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client.new
+      #
+      module V1beta3
+        ##
+        # @private
+        # Initialize the mixin bindings configuration
+        #
+        def self.configure
+          @configure ||= begin
+            namespace = ["Google", "Cloud", "DocumentAI"]
+            parent_config = while namespace.any?
+                              parent_name = namespace.join "::"
+                              parent_const = const_get parent_name
+                              break parent_const.configure if parent_const.respond_to? :configure
+                              namespace.pop
+                            end
+
+            default_config = Configuration.new parent_config
+            default_config.bindings_override["google.cloud.location.Locations.GetLocation"] = [
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1beta3/{name}",
+                matches: [
+                  ["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                ],
+                body: nil
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/uiv1beta3/{name}",
+                matches: [
+                  ["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.cloud.location.Locations.ListLocations"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1beta3/{name}/locations",
+                matches: [
+                  ["name", %r{^projects/[^/]+/?$}, false]
+                ],
+                body: nil
+              ),
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/uiv1beta3/{name}/locations",
+                matches: [
+                  ["name", %r{^projects/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config
+          end
+          yield @configure if block_given?
+          @configure
+        end
+
+        ##
+        # @private
+        # Configuration class for the google.cloud.documentai.v1beta3 package.
+        #
+        # This class contains common configuration for all services
+        # of the google.cloud.documentai.v1beta3 package.
+        #
+        # This configuration is for internal use of the client library classes,
+        # and it is not intended that the end-users will read or change it.
+        #
+        class Configuration
+          extend ::Gapic::Config
+
+          # @private
+          # Overrides for http bindings for the RPC of the mixins for this package.
+          # Services in this package should use these when creating clients for the mixin services.
+          # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
+          config_attr :bindings_override, {}, ::Hash, nil
+
+          # @private
+          def initialize parent_config = nil
+            @parent_config = parent_config unless parent_config.nil?
+
+            yield self if block_given?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -358,14 +358,14 @@ module Google
             #   # 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def batch_process_documents request, options = nil
@@ -547,13 +547,11 @@ module Google
             #   # Call the list_processor_types method.
             #   result = client.list_processor_types 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|
+            #   # 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::V1beta3::ProcessorType.
-            #     p response
+            #     p item
             #   end
             #
             def list_processor_types request, options = nil
@@ -732,13 +730,11 @@ module Google
             #   # Call the list_processors method.
             #   result = client.list_processors 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|
+            #   # 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::V1beta3::Processor.
-            #     p response
+            #     p item
             #   end
             #
             def list_processors request, options = nil
@@ -923,14 +919,14 @@ module Google
             #   # Call the train_processor_version method.
             #   result = client.train_processor_version 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def train_processor_version request, options = nil
@@ -1110,13 +1106,11 @@ module Google
             #   # Call the list_processor_versions method.
             #   result = client.list_processor_versions 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|
+            #   # 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::V1beta3::ProcessorVersion.
-            #     p response
+            #     p item
             #   end
             #
             def list_processor_versions request, options = nil
@@ -1203,14 +1197,14 @@ module Google
             #   # Call the delete_processor_version method.
             #   result = client.delete_processor_version 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def delete_processor_version request, options = nil
@@ -1296,14 +1290,14 @@ module Google
             #   # Call the deploy_processor_version method.
             #   result = client.deploy_processor_version 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def deploy_processor_version request, options = nil
@@ -1389,14 +1383,14 @@ module Google
             #   # Call the undeploy_processor_version method.
             #   result = client.undeploy_processor_version 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def undeploy_processor_version request, options = nil
@@ -1574,14 +1568,14 @@ module Google
             #   # Call the delete_processor method.
             #   result = client.delete_processor 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def delete_processor request, options = nil
@@ -1667,14 +1661,14 @@ module Google
             #   # Call the enable_processor method.
             #   result = client.enable_processor 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def enable_processor request, options = nil
@@ -1760,14 +1754,14 @@ module Google
             #   # Call the disable_processor method.
             #   result = client.disable_processor 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def disable_processor request, options = nil
@@ -1864,14 +1858,14 @@ module Google
             #   # 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 this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def set_default_processor_version request, options = nil
@@ -1969,14 +1963,14 @@ module Google
             #   # 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def review_document request, options = nil
@@ -2069,14 +2063,14 @@ module Google
             #   # Call the evaluate_processor_version method.
             #   result = client.evaluate_processor_version 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def evaluate_processor_version request, options = nil
@@ -2259,13 +2253,11 @@ module Google
             #   # Call the list_evaluations method.
             #   result = client.list_evaluations 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|
+            #   # 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::V1beta3::Evaluation.
-            #     p response
+            #     p item
             #   end
             #
             def list_evaluations request, options = nil

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

@@ -158,13 +158,11 @@ module Google
             #   # 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|
+            #   # 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::Longrunning::Operation.
-            #     p response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil