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

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

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

(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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name.
   */
  // const name = 'abc123'
  /**
   *  The input documents for batch process.
   */
  // const inputDocuments = {}
  /**
   *  The overall output config for batch process.
   */
  // const documentOutputConfig = {}
  /**
   *  Whether Human Review feature should be skipped for this request. Default to
   *  false.
   */
  // const skipHumanReview = true

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callBatchProcessDocuments() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.batchProcessDocuments(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callBatchProcessDocuments();

(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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  An inline document proto.
   */
  // const inlineDocument = {}
  /**
   *  Required. The resource name of the HumanReviewConfig that the document will be
   *  reviewed with.
   */
  // const humanReviewConfig = 'abc123'
  /**
   *  Whether the validation should be performed on the ad-hoc review request.
   */
  // const enableSchemaValidation = true
  /**
   *  The priority of the human review task.
   */
  // const priority = {}

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callReviewDocument() {
    // Construct request
    const request = {
      humanReviewConfig,
    };

    // Run request
    const [operation] = await documentaiClient.reviewDocument(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callReviewDocument();

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.

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.