Document AI V1 API - Class Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client (v0.18.0)

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 Document AI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the DocumentProcessorService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# 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, process_options: nil) -> ::Gapic::Operation

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Overloads 
def batch_process_documents(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_process_documents via a request object, either of type BatchProcessRequest or an equivalent Hash.
Parameters
  • 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, process_options: nil) -> ::Gapic::Operation
Pass arguments to batch_process_documents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::BatchProcessRequest.new

# Call the batch_process_documents method.
result = client.batch_process_documents request

# The returned object is of type Gapic::Operation. You can use 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

#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.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#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 ProcessorType provided. The processor will be at ENABLED state by default after its creation.

Overloads 
def create_processor(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::Processor
Pass arguments to create_processor via a request object, either of type CreateProcessorRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameters
  • 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 [Processor.display_name]][] to be set. Also, the Processor.kms_key_name field must be set if the processor is under CMEK.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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.

Overloads 
def delete_processor(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_processor via a request object, either of type Google::Cloud::DocumentAI::V1::DeleteProcessorRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameter
  • name (::String) — Required. The processor resource name to be deleted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::DeleteProcessorRequest.new

# Call the delete_processor method.
result = client.delete_processor 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

#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.

Overloads 
def delete_processor_version(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_processor_version via a request object, either of type Google::Cloud::DocumentAI::V1::DeleteProcessorVersionRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameter
  • name (::String) — Required. The processor version resource name to be deleted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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 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

#deploy_processor_version

def deploy_processor_version(request, options = nil) -> ::Gapic::Operation
def deploy_processor_version(name: nil) -> ::Gapic::Operation

Deploys the processor version.

Overloads 
def deploy_processor_version(request, options = nil) -> ::Gapic::Operation
Pass arguments to deploy_processor_version via a request object, either of type Google::Cloud::DocumentAI::V1::DeployProcessorVersionRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameter
  • name (::String) — Required. The processor version resource name to be deployed.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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 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

#disable_processor

def disable_processor(request, options = nil) -> ::Gapic::Operation
def disable_processor(name: nil) -> ::Gapic::Operation

Disables a processor

Overloads 
def disable_processor(request, options = nil) -> ::Gapic::Operation
Pass arguments to disable_processor via a request object, either of type Google::Cloud::DocumentAI::V1::DisableProcessorRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameter
  • name (::String) — Required. The processor resource name to be disabled.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::DisableProcessorRequest.new

# Call the disable_processor method.
result = client.disable_processor 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

#enable_processor

def enable_processor(request, options = nil) -> ::Gapic::Operation
def enable_processor(name: nil) -> ::Gapic::Operation

Enables a processor

Overloads 
def enable_processor(request, options = nil) -> ::Gapic::Operation
Pass arguments to enable_processor via a request object, either of type EnableProcessorRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameter
  • name (::String) — Required. The processor resource name to be enabled.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::EnableProcessorRequest.new

# Call the enable_processor method.
result = client.enable_processor 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

#evaluate_processor_version

def evaluate_processor_version(request, options = nil) -> ::Gapic::Operation
def evaluate_processor_version(processor_version: nil, evaluation_documents: nil) -> ::Gapic::Operation

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Overloads 
def evaluate_processor_version(request, options = nil) -> ::Gapic::Operation
Pass arguments to evaluate_processor_version via a request object, either of type EvaluateProcessorVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DocumentAI::V1::EvaluateProcessorVersionRequest, ::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 evaluate_processor_version(processor_version: nil, evaluation_documents: nil) -> ::Gapic::Operation
Pass arguments to evaluate_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).
Parameters
  • processor_version (::String) — Required. The resource name of the ProcessorVersion to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
  • evaluation_documents (::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig, ::Hash) — Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::EvaluateProcessorVersionRequest.new

# Call the evaluate_processor_version method.
result = client.evaluate_processor_version 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

#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 don't use ListProcessorTypes here, because it isn't paginated.

Overloads 
def fetch_processor_types(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse
Pass arguments to fetch_processor_types via a request object, either of type FetchProcessorTypesRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameter
  • parent (::String) — Required. The location of processor types to list. Format: projects/{project}/locations/{location}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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_evaluation

def get_evaluation(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::Evaluation
def get_evaluation(name: nil) -> ::Google::Cloud::DocumentAI::V1::Evaluation

Retrieves a specific evaluation.

Overloads 
def get_evaluation(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::Evaluation
Pass arguments to get_evaluation via a request object, either of type GetEvaluationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DocumentAI::V1::GetEvaluationRequest, ::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_evaluation(name: nil) -> ::Google::Cloud::DocumentAI::V1::Evaluation
Pass arguments to get_evaluation 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).
Parameter
  • name (::String) — Required. The resource name of the Evaluation to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::GetEvaluationRequest.new

# Call the get_evaluation method.
result = client.get_evaluation request

# The returned object is of type Google::Cloud::DocumentAI::V1::Evaluation.
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.

Overloads 
def get_processor(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::Processor
Pass arguments to get_processor via a request object, either of type GetProcessorRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameter
  • name (::String) — Required. The processor resource name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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_type

def get_processor_type(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::ProcessorType
def get_processor_type(name: nil) -> ::Google::Cloud::DocumentAI::V1::ProcessorType

Gets a processor type detail.

Overloads 
def get_processor_type(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::ProcessorType
Pass arguments to get_processor_type via a request object, either of type GetProcessorTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DocumentAI::V1::GetProcessorTypeRequest, ::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_type(name: nil) -> ::Google::Cloud::DocumentAI::V1::ProcessorType
Pass arguments to get_processor_type 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).
Parameter
  • name (::String) — Required. The processor type resource name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::GetProcessorTypeRequest.new

# Call the get_processor_type method.
result = client.get_processor_type request

# The returned object is of type Google::Cloud::DocumentAI::V1::ProcessorType.
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.

Overloads 
def get_processor_version(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion
Pass arguments to get_processor_version via a request object, either of type GetProcessorVersionRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameter
  • name (::String) — Required. The processor resource name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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.

Yields
  • (config) — Configure the DocumentProcessorService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# 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_evaluations

def list_evaluations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Evaluation>
def list_evaluations(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Evaluation>

Retrieves a set of evaluations for a given processor version.

Overloads 
def list_evaluations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Evaluation>
Pass arguments to list_evaluations via a request object, either of type ListEvaluationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DocumentAI::V1::ListEvaluationsRequest, ::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_evaluations(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Evaluation>
Pass arguments to list_evaluations 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).
Parameters
  • parent (::String) — Required. The resource name of the ProcessorVersion to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
  • page_size (::Integer) — The standard list page size. If unspecified, at most 5 evaluations are returned. The maximum value is 100. Values above 100 are coerced to 100.
  • page_token (::String) — A page token, received from a previous ListEvaluations call. Provide this to retrieve the subsequent page.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::ListEvaluationsRequest.new

# Call the list_evaluations method.
result = client.list_evaluations request

# 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::V1::Evaluation.
  p item
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.

Overloads 
def list_processor_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorType>
Pass arguments to list_processor_types via a request object, either of type ListProcessorTypesRequest or an equivalent Hash.
Parameters
  • 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>
Pass arguments to 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).
Parameters
  • parent (::String) — Required. The location of processor types to list. 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.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DocumentAI::V1::ProcessorType.
  p item
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.

Overloads 
def list_processor_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::ProcessorVersion>
Pass arguments to list_processor_versions via a request object, either of type ListProcessorVersionsRequest or an equivalent Hash.
Parameters
  • 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>
Pass arguments to 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).
Parameters
  • 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.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DocumentAI::V1::ProcessorVersion.
  p item
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.

Overloads 
def list_processors(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DocumentAI::V1::Processor>
Pass arguments to list_processors via a request object, either of type ListProcessorsRequest or an equivalent Hash.
Parameters
  • 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>
Pass arguments to 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).
Parameters
  • 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.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::ListProcessorsRequest.new

# Call the list_processors method.
result = client.list_processors request

# 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::V1::Processor.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#operations_client

def operations_client() -> ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Operations

Get the associated client for long-running operations.

Returns

#process_document

def process_document(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::ProcessResponse
def process_document(inline_document: nil, raw_document: nil, gcs_document: nil, name: nil, skip_human_review: nil, field_mask: nil, process_options: nil) -> ::Google::Cloud::DocumentAI::V1::ProcessResponse

Processes a single document.

Overloads 
def process_document(request, options = nil) -> ::Google::Cloud::DocumentAI::V1::ProcessResponse
Pass arguments to process_document via a request object, either of type ProcessRequest or an equivalent Hash.
Parameters
  • 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, gcs_document: nil, name: nil, skip_human_review: nil, field_mask: nil, process_options: nil) -> ::Google::Cloud::DocumentAI::V1::ProcessResponse
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).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::ProcessRequest.new

# Call the process_document method.
result = client.process_document request

# The returned object is of type Google::Cloud::DocumentAI::V1::ProcessResponse.
p result

#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.

Overloads 
def review_document(request, options = nil) -> ::Gapic::Operation
Pass arguments to review_document via a request object, either of type ReviewDocumentRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to review_document via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::ReviewDocumentRequest.new

# Call the review_document method.
result = client.review_document request

# The returned object is of type Gapic::Operation. You can use 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

#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.

Overloads 
def set_default_processor_version(request, options = nil) -> ::Gapic::Operation
Pass arguments to set_default_processor_version via a request object, either of type SetDefaultProcessorVersionRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameters
  • 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}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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 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

#train_processor_version

def train_processor_version(request, options = nil) -> ::Gapic::Operation
def train_processor_version(custom_document_extraction_options: nil, parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil) -> ::Gapic::Operation

Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.

Overloads 
def train_processor_version(request, options = nil) -> ::Gapic::Operation
Pass arguments to train_processor_version via a request object, either of type TrainProcessorVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest, ::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 train_processor_version(custom_document_extraction_options: nil, parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil) -> ::Gapic::Operation
Pass arguments to train_processor_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest.new

# Call the train_processor_version method.
result = client.train_processor_version 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

#undeploy_processor_version

def undeploy_processor_version(request, options = nil) -> ::Gapic::Operation
def undeploy_processor_version(name: nil) -> ::Gapic::Operation

Undeploys the processor version.

Overloads 
def undeploy_processor_version(request, options = nil) -> ::Gapic::Operation
Pass arguments to undeploy_processor_version via a request object, either of type UndeployProcessorVersionRequest or an equivalent Hash.
Parameters
  • 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
Pass arguments to 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).
Parameter
  • name (::String) — Required. The processor version resource name to be undeployed.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/document_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1::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 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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)