DocumentProcessorServiceClient

DocumentProcessorServiceClient

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.

Constructor

new DocumentProcessorServiceClient(optionsopt)

Construct an instance of DocumentProcessorServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

batchProcessDocuments(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The processor resource name.
inputDocuments google.cloud.documentai.v1.BatchDocumentsInputConfig

The input documents for batch process.
documentOutputConfig google.cloud.documentai.v1.DocumentOutputConfig

The overall output config for batch process.
skipHumanReview boolean

Whether Human Review feature should be skipped for this request. Default to false.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example
const [operation] = await client.batchProcessDocuments(request);
const [response] = await operation.promise();

(async) checkBatchProcessDocumentsProgress(name) → {Promise}

Check the status of the long running operation returned by batchProcessDocuments().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
const decodedOperation = await checkBatchProcessDocumentsProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

(async) checkReviewDocumentProgress(name) → {Promise}

Check the status of the long running operation returned by reviewDocument().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
const decodedOperation = await checkReviewDocumentProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

humanReviewConfigPath(project, location, processor) → {string}

Return a fully-qualified humanReviewConfig resource name string.

Parameters:
Name Type Description
project string
location string
processor string
Returns:
Type Description
string

Resource name string.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

matchLocationFromHumanReviewConfigName(humanReviewConfigName) → {string}

Parse the location from HumanReviewConfig resource.

Parameters:
Name Type Description
humanReviewConfigName string

A fully-qualified path representing HumanReviewConfig resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProcessorName(processorName) → {string}

Parse the location from Processor resource.

Parameters:
Name Type Description
processorName string

A fully-qualified path representing Processor resource.
Returns:
Type Description
string

A string representing the location.

matchProcessorFromHumanReviewConfigName(humanReviewConfigName) → {string}

Parse the processor from HumanReviewConfig resource.

Parameters:
Name Type Description
humanReviewConfigName string

A fully-qualified path representing HumanReviewConfig resource.
Returns:
Type Description
string

A string representing the processor.

matchProcessorFromProcessorName(processorName) → {string}

Parse the processor from Processor resource.

Parameters:
Name Type Description
processorName string

A fully-qualified path representing Processor resource.
Returns:
Type Description
string

A string representing the processor.

matchProjectFromHumanReviewConfigName(humanReviewConfigName) → {string}

Parse the project from HumanReviewConfig resource.

Parameters:
Name Type Description
humanReviewConfigName string

A fully-qualified path representing HumanReviewConfig resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProcessorName(processorName) → {string}

Parse the project from Processor resource.

Parameters:
Name Type Description
processorName string

A fully-qualified path representing Processor resource.
Returns:
Type Description
string

A string representing the project.

processDocument(request, optionsopt) → {Promise}

Processes a single document.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
inlineDocument google.cloud.documentai.v1.Document

An inline document proto.
rawDocument google.cloud.documentai.v1.RawDocument

A raw document content (bytes).
name string

Required. The processor resource name.
skipHumanReview boolean

Whether Human Review feature should be skipped for this request. Default to false.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing ProcessResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.processDocument(request);

processorPath(project, location, processor) → {string}

Return a fully-qualified processor resource name string.

Parameters:
Name Type Description
project string
location string
processor string
Returns:
Type Description
string

Resource name string.

reviewDocument(request, optionsopt) → {Promise}

Send a document for Human Review. The input document should be processed by the specified processor.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
inlineDocument google.cloud.documentai.v1.Document

An inline document proto.
humanReviewConfig string

Required. The resource name of the HumanReviewConfig that the document will be reviewed with.
enableSchemaValidation 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.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example
const [operation] = await client.reviewDocument(request);
const [response] = await operation.promise();