Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::DocumentService::Client (v0.27.0)

Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.

Client for the DocumentService service.

Service to call Cloud DocumentAI to manage document collection (dataset).

Inherits

Object

Includes

Google::Cloud::DocumentAI::V1beta3::DocumentService::Paths

Methods

.configure

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

Configure the DocumentService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all DocumentService clients
::Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.configure do |config|
  config.timeout = 10.0
end

#batch_delete_documents

def batch_delete_documents(request, options = nil) -> ::Gapic::Operation
def batch_delete_documents(dataset: nil, dataset_documents: nil) -> ::Gapic::Operation

Deletes a set of documents.

Overloads

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

Pass arguments to batch_delete_documents via a request object, either of type BatchDeleteDocumentsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def batch_delete_documents(dataset: nil, dataset_documents: nil) -> ::Gapic::Operation

Pass arguments to batch_delete_documents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

dataset (::String) — Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
dataset_documents (::Google::Cloud::DocumentAI::V1beta3::BatchDatasetDocuments, ::Hash) — Required. Dataset documents input. If given filter, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch. The request will be rejected if more than 50 document_ids are provided.

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/v1beta3"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

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

Configure the DocumentService 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

config (Client::Configuration)

Returns

(Client::Configuration)

#get_dataset_schema

def get_dataset_schema(request, options = nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema
def get_dataset_schema(name: nil, visible_fields_only: nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Gets the DatasetSchema of a Dataset.

Overloads

def get_dataset_schema(request, options = nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Pass arguments to get_dataset_schema via a request object, either of type GetDatasetSchemaRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::DocumentAI::V1beta3::GetDatasetSchemaRequest, ::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_dataset_schema(name: nil, visible_fields_only: nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Pass arguments to get_dataset_schema 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

name (::String) — Required. The dataset schema resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema
visible_fields_only (::Boolean) — If set, only returns the visible fields of the schema.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::DocumentAI::V1beta3::DatasetSchema)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::DocumentAI::V1beta3::DatasetSchema)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/document_ai/v1beta3"

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

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

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

# The returned object is of type Google::Cloud::DocumentAI::V1beta3::DatasetSchema.
p result

#get_document

def get_document(request, options = nil) -> ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse
def get_document(dataset: nil, document_id: nil, read_mask: nil, page_range: nil) -> ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse

Returns relevant fields present in the requested document.

Overloads

def get_document(request, options = nil) -> ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse

Pass arguments to get_document via a request object, either of type GetDocumentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::DocumentAI::V1beta3::GetDocumentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_document(dataset: nil, document_id: nil, read_mask: nil, page_range: nil) -> ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse

Pass arguments to get_document via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

dataset (::String) — Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset
document_id (::Google::Cloud::DocumentAI::V1beta3::DocumentId, ::Hash) — Required. Document identifier.
read_mask (::Google::Protobuf::FieldMask, ::Hash) — If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.
page_range (::Google::Cloud::DocumentAI::V1beta3::DocumentPageRange, ::Hash) — List of pages for which the fields specified in the read_mask must be served.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/document_ai/v1beta3"

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

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

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

# The returned object is of type Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse.
p result

#import_documents

def import_documents(request, options = nil) -> ::Gapic::Operation
def import_documents(dataset: nil, batch_documents_import_configs: nil) -> ::Gapic::Operation

Import documents into a dataset.

Overloads

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

Pass arguments to import_documents via a request object, either of type ImportDocumentsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def import_documents(dataset: nil, batch_documents_import_configs: nil) -> ::Gapic::Operation

Pass arguments to import_documents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

dataset (::String) — Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
batch_documents_import_configs (::Array<::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest::BatchDocumentsImportConfig, ::Hash>) — Required. The Cloud Storage uri containing raw documents that must be imported.

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/v1beta3"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#initialize

def initialize() { |config| ... } -> Client

Create a new DocumentService client object.

Yields

(config) — Configure the DocumentService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new do |config|
  config.timeout = 10.0
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::V1beta3::DocumentService::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::DocumentAI::V1beta3::DocumentService::Operations)

#update_dataset

def update_dataset(request, options = nil) -> ::Gapic::Operation
def update_dataset(dataset: nil, update_mask: nil) -> ::Gapic::Operation

Updates metadata associated with a dataset.

Overloads

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

Pass arguments to update_dataset via a request object, either of type UpdateDatasetRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::DocumentAI::V1beta3::UpdateDatasetRequest, ::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 update_dataset(dataset: nil, update_mask: nil) -> ::Gapic::Operation

Pass arguments to update_dataset 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

dataset (::Google::Cloud::DocumentAI::V1beta3::Dataset, ::Hash) — Required. The name field of the Dataset is used to identify the resource to be updated.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — The update mask applies to the resource.

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/v1beta3"

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

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

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

#update_dataset_schema

def update_dataset_schema(request, options = nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema
def update_dataset_schema(dataset_schema: nil, update_mask: nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Updates a DatasetSchema.

Overloads

def update_dataset_schema(request, options = nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Pass arguments to update_dataset_schema via a request object, either of type UpdateDatasetSchemaRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::DocumentAI::V1beta3::UpdateDatasetSchemaRequest, ::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 update_dataset_schema(dataset_schema: nil, update_mask: nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Pass arguments to update_dataset_schema 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

dataset_schema (::Google::Cloud::DocumentAI::V1beta3::DatasetSchema, ::Hash) — Required. The name field of the DatasetSchema is used to identify the resource to be updated.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — The update mask applies to the resource.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::DocumentAI::V1beta3::DatasetSchema)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::DocumentAI::V1beta3::DatasetSchema)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/document_ai/v1beta3"

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

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

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

# The returned object is of type Google::Cloud::DocumentAI::V1beta3::DatasetSchema.
p result