google-cloud-document_ai-v1beta3 0.24.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 874c654f8cfe406c08fae1cb6b257e899672238d977cfa5f174ffcef633394b3
-  data.tar.gz: ea4546e6df5ddbc579da1f9658fe3a6b680e6d6d1b56c5fc212fda0135973555
+  metadata.gz: 862dff0c398d9cde485ea687836cc8f545419df08ca1a7244c456fd6ed80b949
+  data.tar.gz: a86ffaa639b4446d477f30628f9f9cfc01c14251b7afa3b201b11bf0e9f0fb9f
 SHA512:
-  metadata.gz: f5b707d9a7d247a2805a65420dbd938f5c51d010a152ef9104ca8510900d93d419b6975eabbeb700f9d5ec292d2edacc5665d86bf39bc27d9e82ba3c7131790a
-  data.tar.gz: 8184c01a1597bda5985cc3389f73612890ebc661dde4d527c8c00a76bc0d97bfe31331c04c77856f36cff631a0ffcadc27f0554993046be67cc988ade211d52e
+  metadata.gz: c1fd5961a5360be321993039116e5203594d2e85c734a9e8a88ac926921aaf5876dce78a277275fe5f6b5ebda5907297567df86bc9975e0582f51d14cd6c1674
+  data.tar.gz: 6b9a7c0d3748f70a3fa07692e409fd334edbcd7e0455110db52e03f6e81676f875b92e9e99261add25427a95d8d1b631208991ed6af527244c84afa0d033c286

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

@@ -202,7 +202,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, document: nil, skip_human_review: nil, field_mask: nil, process_options: nil)
+            # @overload process_document(inline_document: nil, raw_document: nil, gcs_document: nil, name: nil, document: 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 +211,8 @@ module Google
             #     An inline document proto.
             #   @param raw_document [::Google::Cloud::DocumentAI::V1beta3::RawDocument, ::Hash]
             #     A raw document content (bytes).
+            #   @param gcs_document [::Google::Cloud::DocumentAI::V1beta3::GcsDocument, ::Hash]
+            #     A raw document on Google Cloud Storage.
             #   @param name [::String]
             #     Required. The resource name of the
             #     {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
@@ -2329,7 +2331,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload import_processor_version(processor_version_source: nil, parent: nil)
+            # @overload import_processor_version(processor_version_source: nil, external_processor_version_source: nil, parent: nil)
             #   Pass arguments to `import_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).
@@ -2337,6 +2339,9 @@ module Google
             #   @param processor_version_source [::String]
             #     The source processor version to import from. The source processor version
             #     and destination processor need to be in the same environment and region.
+            #   @param external_processor_version_source [::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest::ExternalProcessorVersionSource, ::Hash]
+            #     The source processor version to import from, and can be from different
+            #     environment and region than the destination processor.
             #   @param parent [::String]
             #     Required. The destination processor name to create the processor version
             #     in. Format:

data/lib/google/cloud/document_ai/v1beta3/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, document: nil, skip_human_review: nil, field_mask: nil, process_options: nil)
+              # @overload process_document(inline_document: nil, raw_document: nil, gcs_document: nil, name: nil, document: 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::V1beta3::RawDocument, ::Hash]
               #     A raw document content (bytes).
+              #   @param gcs_document [::Google::Cloud::DocumentAI::V1beta3::GcsDocument, ::Hash]
+              #     A raw document on Google Cloud Storage.
               #   @param name [::String]
               #     Required. The resource name of the
               #     {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
@@ -1722,7 +1724,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload import_processor_version(processor_version_source: nil, parent: nil)
+              # @overload import_processor_version(processor_version_source: nil, external_processor_version_source: nil, parent: nil)
               #   Pass arguments to `import_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).
@@ -1730,6 +1732,9 @@ module Google
               #   @param processor_version_source [::String]
               #     The source processor version to import from. The source processor version
               #     and destination processor need to be in the same environment and region.
+              #   @param external_processor_version_source [::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest::ExternalProcessorVersionSource, ::Hash]
+              #     The source processor version to import from, and can be from different
+              #     environment and region than the destination processor.
               #   @param parent [::String]
               #     Required. The destination processor name to create the processor version
               #     in. Format:

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

@@ -267,6 +267,299 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Import documents into a dataset.
+            #
+            # @overload import_documents(request, options = nil)
+            #   Pass arguments to `import_documents` via a request object, either of type
+            #   {::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload import_documents(dataset: nil, batch_documents_import_configs: nil)
+            #   Pass arguments to `import_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).
+            #
+            #   @param dataset [::String]
+            #     Required. The dataset resource name.
+            #     Format:
+            #     projects/\\{project}/locations/\\{location}/processors/\\{processor}/dataset
+            #   @param batch_documents_import_configs [::Array<::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest::BatchDocumentsImportConfig, ::Hash>]
+            #     Required. The Cloud Storage uri containing raw documents that must be
+            #     imported.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest.new
+            #
+            #   # Call the import_documents method.
+            #   result = client.import_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 import_documents request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.import_documents.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.dataset
+                header_params["dataset"] = request.dataset
+              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.import_documents.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.import_documents.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @document_service_stub.call_rpc :import_documents, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Returns relevant fields present in the requested document.
+            #
+            # @overload get_document(request, options = nil)
+            #   Pass arguments to `get_document` via a request object, either of type
+            #   {::Google::Cloud::DocumentAI::V1beta3::GetDocumentRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DocumentAI::V1beta3::GetDocumentRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload get_document(dataset: nil, document_id: nil, read_mask: nil, page_range: nil)
+            #   Pass arguments to `get_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).
+            #
+            #   @param dataset [::String]
+            #     Required. The resource name of the dataset that the document belongs to .
+            #     Format:
+            #     projects/\\{project}/locations/\\{location}/processors/\\{processor}/dataset
+            #   @param document_id [::Google::Cloud::DocumentAI::V1beta3::DocumentId, ::Hash]
+            #     Required. Document identifier.
+            #   @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
+            #     If set, only fields listed here will be returned. Otherwise, all fields
+            #     will be returned by default.
+            #   @param page_range [::Google::Cloud::DocumentAI::V1beta3::DocumentPageRange, ::Hash]
+            #     List of pages for which the fields specified in the `read_mask` must
+            #     be served.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::GetDocumentRequest.new
+            #
+            #   # Call the get_document method.
+            #   result = client.get_document request
+            #
+            #   # The returned object is of type Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse.
+            #   p result
+            #
+            def get_document request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1beta3::GetDocumentRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.get_document.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.dataset
+                header_params["dataset"] = request.dataset
+              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_document.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.get_document.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @document_service_stub.call_rpc :get_document, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Deletes a set of documents.
+            #
+            # @overload batch_delete_documents(request, options = nil)
+            #   Pass arguments to `batch_delete_documents` via a request object, either of type
+            #   {::Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload batch_delete_documents(dataset: nil, dataset_documents: nil)
+            #   Pass arguments to `batch_delete_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).
+            #
+            #   @param dataset [::String]
+            #     Required. The dataset resource name.
+            #     Format:
+            #     projects/\\{project}/locations/\\{location}/processors/\\{processor}/dataset
+            #   @param dataset_documents [::Google::Cloud::DocumentAI::V1beta3::BatchDatasetDocuments, ::Hash]
+            #     Required. Dataset documents input. If given `filter`, all documents
+            #     satisfying the filter will be deleted. If given documentIds, a maximum of
+            #     50 documents can be deleted in a batch. The request will be rejected if
+            #     more than 50 document_ids are provided.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsRequest.new
+            #
+            #   # Call the batch_delete_documents method.
+            #   result = client.batch_delete_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_delete_documents request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.batch_delete_documents.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.dataset
+                header_params["dataset"] = request.dataset
+              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_delete_documents.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.batch_delete_documents.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @document_service_stub.call_rpc :batch_delete_documents, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Gets the `DatasetSchema` of a `Dataset`.
             #
@@ -587,6 +880,21 @@ module Google
                 #
                 attr_reader :update_dataset
                 ##
+                # RPC-specific configuration for `import_documents`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :import_documents
+                ##
+                # RPC-specific configuration for `get_document`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :get_document
+                ##
+                # RPC-specific configuration for `batch_delete_documents`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :batch_delete_documents
+                ##
                 # RPC-specific configuration for `get_dataset_schema`
                 # @return [::Gapic::Config::Method]
                 #
@@ -601,6 +909,12 @@ module Google
                 def initialize parent_rpcs = nil
                   update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
                   @update_dataset = ::Gapic::Config::Method.new update_dataset_config
+                  import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
+                  @import_documents = ::Gapic::Config::Method.new import_documents_config
+                  get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
+                  @get_document = ::Gapic::Config::Method.new get_document_config
+                  batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
+                  @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
                   get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
                   @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
                   update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema