Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.
Client for the DocumentProcessorService service.
Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the DocumentProcessorService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all DocumentProcessorService clients ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.configure do |config| config.timeout = 10.0 end
#batch_process_documents
def batch_process_documents(request, options = nil) -> ::Gapic::Operation
def batch_process_documents(name: nil, input_documents: nil, document_output_config: nil, skip_human_review: nil) -> ::Gapic::Operation
LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
def batch_process_documents(request, options = nil) -> ::Gapic::Operation
batch_process_documents
via a request object, either of type
BatchProcessRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::BatchProcessRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def batch_process_documents(name: nil, input_documents: nil, document_output_config: nil, skip_human_review: nil) -> ::Gapic::Operation
batch_process_documents
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The resource name of
Processor or
ProcessorVersion.
Format:
projects/{project}/locations/{location}/processors/{processor}
, orprojects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
- input_documents (::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig, ::Hash) — The input documents for batch process.
- document_output_config (::Google::Cloud::DocumentAI::V1::DocumentOutputConfig, ::Hash) — The overall output config for batch process.
- skip_human_review (::Boolean) — Whether Human Review feature should be skipped for this request. Default to false.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the DocumentProcessorService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_processor
def create_processor(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::Processor
def create_processor(parent: nil, processor: nil) -> ::Google::Cloud::DocumentAI::V1::Processor
Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
def create_processor(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::Processor
create_processor
via a request object, either of type
CreateProcessorRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::CreateProcessorRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_processor(parent: nil, processor: nil) -> ::Google::Cloud::DocumentAI::V1::Processor
create_processor
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).
-
parent (::String) — Required. The parent (project and location) under which to create the
processor. Format:
projects/{project}/locations/{location}
- processor (::Google::Cloud::DocumentAI::V1::Processor, ::Hash) — Required. The processor to be created, requires [processor_type] and [display_name] to be set. Also, the processor is under CMEK if CMEK fields are set.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::DocumentAI::V1::Processor)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::CreateProcessorRequest.new # Call the create_processor method. result = client.create_processor request # The returned object is of type Google::Cloud::DocumentAI::V1::Processor. p result
#delete_processor
def delete_processor(request, options = nil) -> ::Gapic::Operation
def delete_processor(name: nil) -> ::Gapic::Operation
Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
def delete_processor(request, options = nil) -> ::Gapic::Operation
delete_processor
via a request object, either of type
Google::Cloud::DocumentAI::V1::DeleteProcessorRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::DeleteProcessorRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_processor(name: nil) -> ::Gapic::Operation
delete_processor
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).
- name (::String) — Required. The processor resource name to be deleted.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DeleteProcessorRequest.new # 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: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
#delete_processor_version
def delete_processor_version(request, options = nil) -> ::Gapic::Operation
def delete_processor_version(name: nil) -> ::Gapic::Operation
Deletes the processor version, all artifacts under the processor version will be deleted.
def delete_processor_version(request, options = nil) -> ::Gapic::Operation
delete_processor_version
via a request object, either of type
Google::Cloud::DocumentAI::V1::DeleteProcessorVersionRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::DeleteProcessorVersionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_processor_version(name: nil) -> ::Gapic::Operation
delete_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).
- name (::String) — Required. The processor version resource name to be deleted.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DeleteProcessorVersionRequest.new # Call the delete_processor_version method. result = client.delete_processor_version request # The returned object is of type Gapic::Operation. You can use 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
#deploy_processor_version
def deploy_processor_version(request, options = nil) -> ::Gapic::Operation
def deploy_processor_version(name: nil) -> ::Gapic::Operation
Deploys the processor version.
def deploy_processor_version(request, options = nil) -> ::Gapic::Operation
deploy_processor_version
via a request object, either of type
Google::Cloud::DocumentAI::V1::DeployProcessorVersionRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::DeployProcessorVersionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def deploy_processor_version(name: nil) -> ::Gapic::Operation
deploy_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).
- name (::String) — Required. The processor version resource name to be deployed.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DeployProcessorVersionRequest.new # Call the deploy_processor_version method. result = client.deploy_processor_version request # The returned object is of type Gapic::Operation. You can use 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
#disable_processor
def disable_processor(request, options = nil) -> ::Gapic::Operation
def disable_processor(name: nil) -> ::Gapic::Operation
Disables a processor
def disable_processor(request, options = nil) -> ::Gapic::Operation
disable_processor
via a request object, either of type
Google::Cloud::DocumentAI::V1::DisableProcessorRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::DisableProcessorRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def disable_processor(name: nil) -> ::Gapic::Operation
disable_processor
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).
- name (::String) — Required. The processor resource name to be disabled.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DisableProcessorRequest.new # 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: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
#enable_processor
def enable_processor(request, options = nil) -> ::Gapic::Operation
def enable_processor(name: nil) -> ::Gapic::Operation
Enables a processor
def enable_processor(request, options = nil) -> ::Gapic::Operation
enable_processor
via a request object, either of type
EnableProcessorRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::EnableProcessorRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def enable_processor(name: nil) -> ::Gapic::Operation
enable_processor
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).
- name (::String) — Required. The processor resource name to be enabled.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::EnableProcessorRequest.new # 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: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
#fetch_processor_types
def fetch_processor_types(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse
def fetch_processor_types(parent: nil) -> ::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse
Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.
def fetch_processor_types(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse
fetch_processor_types
via a request object, either of type
FetchProcessorTypesRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::FetchProcessorTypesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def fetch_processor_types(parent: nil) -> ::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse
fetch_processor_types
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).
-
parent (::String) — Required. The project of processor type to list.
The available processor types may depend on the allow-listing on projects.
Format:
projects/{project}/locations/{location}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::FetchProcessorTypesRequest.new # Call the fetch_processor_types method. result = client.fetch_processor_types request # The returned object is of type Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse. p result
#get_processor
def get_processor(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::Processor
def get_processor(name: nil) -> ::Google::Cloud::DocumentAI::V1::Processor
Gets a processor detail.
def get_processor(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::Processor
get_processor
via a request object, either of type
GetProcessorRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::GetProcessorRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_processor(name: nil) -> ::Google::Cloud::DocumentAI::V1::Processor
get_processor
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).
- name (::String) — Required. The processor resource name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::DocumentAI::V1::Processor)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::GetProcessorRequest.new # Call the get_processor method. result = client.get_processor request # The returned object is of type Google::Cloud::DocumentAI::V1::Processor. p result
#get_processor_version
def get_processor_version(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion
def get_processor_version(name: nil) -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion
Gets a processor version detail.
def get_processor_version(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion
get_processor_version
via a request object, either of type
GetProcessorVersionRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::GetProcessorVersionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_processor_version(name: nil) -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion
get_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).
- name (::String) — Required. The processor resource name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::DocumentAI::V1::ProcessorVersion)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::GetProcessorVersionRequest.new # Call the get_processor_version method. result = client.get_processor_version request # The returned object is of type Google::Cloud::DocumentAI::V1::ProcessorVersion. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new DocumentProcessorService client object.
- (config) — Configure the DocumentProcessorService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new do |config| config.timeout = 10.0 end
#list_processor_types
def list_processor_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorType>
def list_processor_types(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorType>
Lists the processor types that exist.
def list_processor_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorType>
list_processor_types
via a request object, either of type
ListProcessorTypesRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::ListProcessorTypesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_processor_types(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorType>
list_processor_types
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).
-
parent (::String) — Required. The location of processor type to list.
The available processor types may depend on the allow-listing on projects.
Format:
projects/{project}/locations/{location}
- page_size (::Integer) — The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500; values above 500 will be coerced to 500.
- page_token (::String) — Used to retrieve the next page of results, empty if at the end of the list.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorType>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorType>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::ListProcessorTypesRequest.new # Call the list_processor_types method. result = client.list_processor_types request # The returned object is of type Gapic::PagedEnumerable. You can # iterate over 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::Cloud::DocumentAI::V1::ProcessorType. p response end
#list_processor_versions
def list_processor_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorVersion>
def list_processor_versions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorVersion>
Lists all versions of a processor.
def list_processor_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorVersion>
list_processor_versions
via a request object, either of type
ListProcessorVersionsRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::ListProcessorVersionsRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_processor_versions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorVersion>
list_processor_versions
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).
-
parent (::String) — Required. The parent (project, location and processor) to list all
versions. Format:
projects/{project}/locations/{location}/processors/{processor}
- page_size (::Integer) — The maximum number of processor versions to return. If unspecified, at most 10 processor versions will be returned. The maximum value is 20; values above 20 will be coerced to 20.
- page_token (::String) — We will return the processor versions sorted by creation time. The page token will point to the next processor version.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorVersion>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorVersion>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::ListProcessorVersionsRequest.new # Call the list_processor_versions method. result = client.list_processor_versions request # The returned object is of type Gapic::PagedEnumerable. You can # iterate over 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::Cloud::DocumentAI::V1::ProcessorVersion. p response end
#list_processors
def list_processors(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Processor>
def list_processors(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Processor>
Lists all processors which belong to this project.
def list_processors(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Processor>
list_processors
via a request object, either of type
ListProcessorsRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::ListProcessorsRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_processors(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Processor>
list_processors
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).
-
parent (::String) — Required. The parent (project and location) which owns this collection of
Processors. Format:
projects/{project}/locations/{location}
- page_size (::Integer) — The maximum number of processors to return. If unspecified, at most 50 processors will be returned. The maximum value is 100; values above 100 will be coerced to 100.
- page_token (::String) — We will return the processors sorted by creation time. The page token will point to the next processor.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Processor>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Processor>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::ListProcessorsRequest.new # 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| # Each element is of type ::Google::Cloud::DocumentAI::V1::Processor. p response end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Client)
#operations_client
def operations_client() -> ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Operations
Get the associated client for long-running operations.
#process_document
def process_document(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::ProcessResponse
def process_document(inline_document: nil, raw_document: nil, name: nil, skip_human_review: nil, field_mask: nil) -> ::Google::Cloud::DocumentAI::V1::ProcessResponse
Processes a single document.
def process_document(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::ProcessResponse
process_document
via a request object, either of type
ProcessRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::ProcessRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def process_document(inline_document: nil, raw_document: nil, name: nil, skip_human_review: nil, field_mask: nil) -> ::Google::Cloud::DocumentAI::V1::ProcessResponse
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).
- inline_document (::Google::Cloud::DocumentAI::V1::Document, ::Hash) — An inline document proto.
- raw_document (::Google::Cloud::DocumentAI::V1::RawDocument, ::Hash) — A raw document content (bytes).
-
name (::String) — Required. The resource name of the
Processor or
ProcessorVersion
to use for processing. If a
Processor is specified, the server
will use its [default
version][google.cloud.documentai.v1.Processor.default_processor_version].
Format:
projects/{project}/locations/{location}/processors/{processor}
, orprojects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
- skip_human_review (::Boolean) — Whether Human Review feature should be skipped for this request. Default to false.
-
field_mask (::Google::Protobuf::FieldMask, ::Hash) — Specifies which fields to include in ProcessResponse's document.
Only supports top level document and pages field so it must be in the form
of
{document_field_name}
orpages.{page_field_name}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::DocumentAI::V1::ProcessResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#review_document
def review_document(request, options = nil) -> ::Gapic::Operation
def review_document(inline_document: nil, human_review_config: nil, enable_schema_validation: nil, priority: nil, document_schema: nil) -> ::Gapic::Operation
Send a document for Human Review. The input document should be processed by the specified processor.
def review_document(request, options = nil) -> ::Gapic::Operation
review_document
via a request object, either of type
ReviewDocumentRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def review_document(inline_document: nil, human_review_config: nil, enable_schema_validation: nil, priority: nil, document_schema: nil) -> ::Gapic::Operation
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).
- inline_document (::Google::Cloud::DocumentAI::V1::Document, ::Hash) — An inline document proto.
- human_review_config (::String) — Required. The resource name of the HumanReviewConfig that the document will be reviewed with.
- enable_schema_validation (::Boolean) — Whether the validation should be performed on the ad-hoc review request.
- priority (::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest::Priority) — The priority of the human review task.
- document_schema (::Google::Cloud::DocumentAI::V1::DocumentSchema, ::Hash) — The document schema of the human review task.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#set_default_processor_version
def set_default_processor_version(request, options = nil) -> ::Gapic::Operation
def set_default_processor_version(processor: nil, default_processor_version: nil) -> ::Gapic::Operation
Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.
def set_default_processor_version(request, options = nil) -> ::Gapic::Operation
set_default_processor_version
via a request object, either of type
SetDefaultProcessorVersionRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::SetDefaultProcessorVersionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def set_default_processor_version(processor: nil, default_processor_version: nil) -> ::Gapic::Operation
set_default_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).
- processor (::String) — Required. The resource name of the Processor to change default version.
-
default_processor_version (::String) — Required. The resource name of child
ProcessorVersion to use as
default. Format:
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::SetDefaultProcessorVersionRequest.new # Call the set_default_processor_version method. result = client.set_default_processor_version request # The returned object is of type Gapic::Operation. You can use 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
#undeploy_processor_version
def undeploy_processor_version(request, options = nil) -> ::Gapic::Operation
def undeploy_processor_version(name: nil) -> ::Gapic::Operation
Undeploys the processor version.
def undeploy_processor_version(request, options = nil) -> ::Gapic::Operation
undeploy_processor_version
via a request object, either of type
UndeployProcessorVersionRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1::UndeployProcessorVersionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def undeploy_processor_version(name: nil) -> ::Gapic::Operation
undeploy_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).
- name (::String) — Required. The processor version resource name to be undeployed.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::UndeployProcessorVersionRequest.new # Call the undeploy_processor_version method. result = client.undeploy_processor_version request # The returned object is of type Gapic::Operation. You can use 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