Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::Client.
REST client for the DocumentService service.
Service to call Cloud DocumentAI to manage document collection (dataset).
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the DocumentService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all DocumentService clients ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::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.
def batch_delete_documents(request, options = nil) -> ::Gapic::Operation
batch_delete_documents
via a request object, either of type
BatchDeleteDocumentsRequest or an equivalent Hash.
- 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
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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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::Rest::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.
- (config) — Configure the Client client.
- config (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
.
def get_dataset_schema(request, options = nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema
get_dataset_schema
via a request object, either of type
GetDatasetSchemaRequest or an equivalent Hash.
- 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
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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DocumentAI::V1beta3::DatasetSchema)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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::Rest::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.
def get_document(request, options = nil) -> ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse
get_document
via a request object, either of type
GetDocumentRequest or an equivalent Hash.
- 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
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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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::Rest::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.
def import_documents(request, options = nil) -> ::Gapic::Operation
import_documents
via a request object, either of type
ImportDocumentsRequest or an equivalent Hash.
- 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
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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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::Rest::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 REST client object.
- (config) — Configure the DocumentService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::Client.new do |config| config.timeout = 10.0 end
#list_documents
def list_documents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1beta3::DocumentMetadata>
def list_documents(dataset: nil, page_size: nil, page_token: nil, filter: nil, return_total_size: nil, skip: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1beta3::DocumentMetadata>
Returns a list of documents present in the dataset.
def list_documents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1beta3::DocumentMetadata>
list_documents
via a request object, either of type
ListDocumentsRequest or an equivalent Hash.
- request (::Google::Cloud::DocumentAI::V1beta3::ListDocumentsRequest, ::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_documents(dataset: nil, page_size: nil, page_token: nil, filter: nil, return_total_size: nil, skip: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1beta3::DocumentMetadata>
list_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).
- dataset (::String) — Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
- page_size (::Integer) — The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100.
-
page_token (::String) — A page token, received from a previous
ListDocuments
call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListDocuments
must match the call that provided the page token. -
filter (::String) —
Optional. Query to filter the documents based on https://google.aip.dev/160.
Currently support query strings are:
SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED
LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED
DisplayName=\"file_name.pdf\"
EntityType=abc/def
TagName=\"auto-labeling-running\"|\"sampled\"
Note:
- Only
AND
,=
and!=
are supported. e.g.DisplayName=file_name AND EntityType!=abc
IS supported. - Wildcard
*
is supported only inDisplayName
filter - No duplicate filter keys are allowed,
e.g.
EntityType=a AND EntityType=b
is NOT supported. - String match is case sensitive (for filter
DisplayName
&EntityType
).
-
return_total_size (::Boolean) — Optional. Controls if the ListDocuments request requires a total size
of matched documents. See ListDocumentsResponse.total_size.
Enabling this flag may adversely impact performance.
Defaults to false.
-
skip (::Integer) — Optional. Number of results to skip beginning from the
page_token
if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values wil be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results,ListDocumentsResponse.document_metadata
andListDocumentsResponse.next_page_token
will be empty.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1beta3::DocumentMetadata>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DocumentAI::V1beta3::DocumentMetadata>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DocumentAI::V1beta3::ListDocumentsRequest.new # Call the list_documents method. result = client.list_documents 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::V1beta3::DocumentMetadata. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Rest::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Rest::Client)
#operations_client
def operations_client() -> ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::Operations
Get the associated client for long-running 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.
def update_dataset(request, options = nil) -> ::Gapic::Operation
update_dataset
via a request object, either of type
UpdateDatasetRequest or an equivalent Hash.
- 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
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).
-
dataset (::Google::Cloud::DocumentAI::V1beta3::Dataset, ::Hash) — Required. The
name
field of theDataset
is used to identify the resource to be updated. - update_mask (::Google::Protobuf::FieldMask, ::Hash) — The update mask applies to the resource.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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::Rest::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
.
def update_dataset_schema(request, options = nil) -> ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema
update_dataset_schema
via a request object, either of type
UpdateDatasetSchemaRequest or an equivalent Hash.
- 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
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).
-
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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DocumentAI::V1beta3::DatasetSchema)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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::Rest::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