Class v1beta3.DocumentProcessorServiceClient (3.1.0)

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

Package

@google-cloud/documentai

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of DocumentProcessorServiceClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

documentProcessorServiceStub

documentProcessorServiceStub?: Promise<{
        [name: string]: Function;
    }>;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

batchProcessDocuments(request, options)

batchProcessDocuments(request?: protos.google.cloud.documentai.v1beta3.IBatchProcessRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

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

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IBatchProcessRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 config for each single document in the batch process.
   */
  // const inputConfigs = 1234
  /**
   *  The overall output config for batch process.
   */
  // const outputConfig = {}
  /**
   *  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').v1beta3;

  // 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();

batchProcessDocuments(request, options, callback)

batchProcessDocuments(request: protos.google.cloud.documentai.v1beta3.IBatchProcessRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IBatchProcessRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

batchProcessDocuments(request, callback)

batchProcessDocuments(request: protos.google.cloud.documentai.v1beta3.IBatchProcessRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IBatchProcessRequest`
callback	`Callback<LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

checkBatchProcessDocumentsProgress(name)

checkBatchProcessDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1beta3.BatchProcessResponse, protos.google.cloud.documentai.v1beta3.BatchProcessMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.documentai.v1beta3.BatchProcessResponse, protos.google.cloud.documentai.v1beta3.BatchProcessMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 config for each single document in the batch process.
   */
  // const inputConfigs = 1234
  /**
   *  The overall output config for batch process.
   */
  // const outputConfig = {}
  /**
   *  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').v1beta3;

  // 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();

checkDeleteProcessorProgress(name)

checkDeleteProcessorProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.documentai.v1beta3.DeleteProcessorMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.documentai.v1beta3.DeleteProcessorMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be deleted.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteProcessor();

checkDisableProcessorProgress(name)

checkDisableProcessorProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1beta3.DisableProcessorResponse, protos.google.cloud.documentai.v1beta3.DisableProcessorMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.documentai.v1beta3.DisableProcessorResponse, protos.google.cloud.documentai.v1beta3.DisableProcessorMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be disabled.
   */
  // const name = 'abc123'

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

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

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

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

  callDisableProcessor();

checkEnableProcessorProgress(name)

checkEnableProcessorProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1beta3.EnableProcessorResponse, protos.google.cloud.documentai.v1beta3.EnableProcessorMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.documentai.v1beta3.EnableProcessorResponse, protos.google.cloud.documentai.v1beta3.EnableProcessorMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be enabled.
   */
  // const name = 'abc123'

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

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

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

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

  callEnableProcessor();

checkReviewDocumentProgress(name)

checkReviewDocumentProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1beta3.ReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.documentai.v1beta3.ReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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'
  /**
   *  The document that needs human review.
   */
  // const document = {}
  /**
   *  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').v1beta3;

  // 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()

close(): Promise<void>;

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<void>	{Promise} A promise that resolves when the client is closed.

createProcessor(request, options)

createProcessor(request?: protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest, options?: CallOptions): Promise<[protos.google.cloud.documentai.v1beta3.IProcessor, (protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest | undefined), {} | undefined]>;

Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.documentai.v1beta3.IProcessor, (protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest \| undefined), {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Processor]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent (project and location) under which to create the processor.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Required. The processor to be created, requires processor_type  and display_name
   *  to be set. Also, the processor is under CMEK if CMEK fields are set.
   */
  // const processor = {}

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

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

  async function callCreateProcessor() {
    // Construct request
    const request = {
      parent,
      processor,
    };

    // Run request
    const response = await documentaiClient.createProcessor(request);
    console.log(response);
  }

  callCreateProcessor();

createProcessor(request, options, callback)

createProcessor(request: protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1beta3.IProcessor, protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.documentai.v1beta3.IProcessor, protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createProcessor(request, callback)

createProcessor(request: protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest, callback: Callback<protos.google.cloud.documentai.v1beta3.IProcessor, protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest`
callback	`Callback<protos.google.cloud.documentai.v1beta3.IProcessor, protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteProcessor(request, options)

deleteProcessor(request?: protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be deleted.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteProcessor();

deleteProcessor(request, options, callback)

deleteProcessor(request: protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteProcessor(request, callback)

deleteProcessor(request: protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

disableProcessor(request, options)

disableProcessor(request?: protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Disables a processor

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be disabled.
   */
  // const name = 'abc123'

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

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

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

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

  callDisableProcessor();

disableProcessor(request, options, callback)

disableProcessor(request: protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

disableProcessor(request, callback)

disableProcessor(request: protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest`
callback	`Callback<LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

enableProcessor(request, options)

enableProcessor(request?: protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Enables a processor

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be enabled.
   */
  // const name = 'abc123'

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

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

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

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

  callEnableProcessor();

enableProcessor(request, options, callback)

enableProcessor(request: protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

enableProcessor(request, callback)

enableProcessor(request: protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest`
callback	`Callback<LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

fetchProcessorTypes(request, options)

fetchProcessorTypes(request?: protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest, options?: CallOptions): Promise<[protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, (protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest | undefined), {} | undefined]>;

Fetches processor types.

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, (protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest \| undefined), {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [FetchProcessorTypesResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project of processor type to list.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'

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

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

  async function callFetchProcessorTypes() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const response = await documentaiClient.fetchProcessorTypes(request);
    console.log(response);
  }

  callFetchProcessorTypes();

fetchProcessorTypes(request, options, callback)

fetchProcessorTypes(request: protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

fetchProcessorTypes(request, callback)

fetchProcessorTypes(request: protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest, callback: Callback<protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest`
callback	`Callback<protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

humanReviewConfigPath(project, location, processor)

humanReviewConfigPath(project: string, location: string, processor: string): string;

Return a fully-qualified humanReviewConfig resource name string.

Parameters

Name	Description
project	`string`
location	`string`
processor	`string`

Returns

Type	Description
string	{string} Resource name string.

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listProcessors(request, options)

listProcessors(request?: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, options?: CallOptions): Promise<[protos.google.cloud.documentai.v1beta3.IProcessor[], protos.google.cloud.documentai.v1beta3.IListProcessorsRequest | null, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse]>;

Lists all processors which belong to this project.

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IListProcessorsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[protos.google.cloud.documentai.v1beta3.IProcessor[], protos.google.cloud.documentai.v1beta3.IListProcessorsRequest | null, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Processor]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listProcessorsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listProcessors(request, options, callback)

listProcessors(request: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1beta3.IProcessor>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IListProcessorsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse \| null \| undefined, protos.google.cloud.documentai.v1beta3.IProcessor>`

Returns

Type	Description
void

listProcessors(request, callback)

listProcessors(request: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, callback: PaginationCallback<protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1beta3.IProcessor>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IListProcessorsRequest`
callback	`PaginationCallback<protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse \| null \| undefined, protos.google.cloud.documentai.v1beta3.IProcessor>`

Returns

Type	Description
void

listProcessorsAsync(request, options)

listProcessorsAsync(request?: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.documentai.v1beta3.IProcessor>;

Equivalent to listProcessors, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IListProcessorsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.documentai.v1beta3.IProcessor>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Processor]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent (project and location) which owns this collection of Processors.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  We will return the processors sorted by creation time. The page token
   *  will point to the next processor.
   */
  // const pageToken = 'abc123'

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

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

  async function callListProcessors() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await documentaiClient.listProcessorsAsync(request);
    for await (const response of iterable) {
      console.log(response);
    }
  }

  callListProcessors();

listProcessorsStream(request, options)

listProcessorsStream(request?: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IListProcessorsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Processor] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listProcessorsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

matchLocationFromHumanReviewConfigName(humanReviewConfigName)

matchLocationFromHumanReviewConfigName(humanReviewConfigName: string): string | number;

Parse the location from HumanReviewConfig resource.

Parameter

Name	Description
humanReviewConfigName	`string` A fully-qualified path representing HumanReviewConfig resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProcessorName(processorName)

matchLocationFromProcessorName(processorName: string): string | number;

Parse the location from Processor resource.

Parameter

Name	Description
processorName	`string` A fully-qualified path representing Processor resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProcessorTypeName(processorTypeName)

matchLocationFromProcessorTypeName(processorTypeName: string): string | number;

Parse the location from ProcessorType resource.

Parameter

Name	Description
processorTypeName	`string` A fully-qualified path representing ProcessorType resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchProcessorFromHumanReviewConfigName(humanReviewConfigName)

matchProcessorFromHumanReviewConfigName(humanReviewConfigName: string): string | number;

Parse the processor from HumanReviewConfig resource.

Parameter

Name	Description
humanReviewConfigName	`string` A fully-qualified path representing HumanReviewConfig resource.

Returns

Type	Description
string \| number	{string} A string representing the processor.

matchProcessorFromProcessorName(processorName)

matchProcessorFromProcessorName(processorName: string): string | number;

Parse the processor from Processor resource.

Parameter

Name	Description
processorName	`string` A fully-qualified path representing Processor resource.

Returns

Type	Description
string \| number	{string} A string representing the processor.

matchProcessorTypeFromProcessorTypeName(processorTypeName)

matchProcessorTypeFromProcessorTypeName(processorTypeName: string): string | number;

Parse the processor_type from ProcessorType resource.

Parameter

Name	Description
processorTypeName	`string` A fully-qualified path representing ProcessorType resource.

Returns

Type	Description
string \| number	{string} A string representing the processor_type.

matchProjectFromHumanReviewConfigName(humanReviewConfigName)

matchProjectFromHumanReviewConfigName(humanReviewConfigName: string): string | number;

Parse the project from HumanReviewConfig resource.

Parameter

Name	Description
humanReviewConfigName	`string` A fully-qualified path representing HumanReviewConfig resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProcessorName(processorName)

matchProjectFromProcessorName(processorName: string): string | number;

Parse the project from Processor resource.

Parameter

Name	Description
processorName	`string` A fully-qualified path representing Processor resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProcessorTypeName(processorTypeName)

matchProjectFromProcessorTypeName(processorTypeName: string): string | number;

Parse the project from ProcessorType resource.

Parameter

Name	Description
processorTypeName	`string` A fully-qualified path representing ProcessorType resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Name	Description
projectName	`string` A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

processDocument(request, options)

processDocument(request?: protos.google.cloud.documentai.v1beta3.IProcessRequest, options?: CallOptions): Promise<[protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest | undefined, {} | undefined]>;

Processes a single document.

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IProcessRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ProcessResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  An inline document proto.
   */
  // const inlineDocument = {}
  /**
   *  A raw document content (bytes).
   */
  // const rawDocument = {}
  /**
   *  Required. The processor resource name.
   */
  // const name = 'abc123'
  /**
   *  The document payload, the content  and mime_type  fields must be set.
   */
  // const document = {}
  /**
   *  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').v1beta3;

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

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

    // Run request
    const response = await documentaiClient.processDocument(request);
    console.log(response);
  }

  callProcessDocument();

processDocument(request, options, callback)

processDocument(request: protos.google.cloud.documentai.v1beta3.IProcessRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IProcessRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

processDocument(request, callback)

processDocument(request: protos.google.cloud.documentai.v1beta3.IProcessRequest, callback: Callback<protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IProcessRequest`
callback	`Callback<protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

processorPath(project, location, processor)

processorPath(project: string, location: string, processor: string): string;

Return a fully-qualified processor resource name string.

Parameters

Name	Description
project	`string`
location	`string`
processor	`string`

Returns

Type	Description
string	{string} Resource name string.

processorTypePath(project, location, processorType)

processorTypePath(project: string, location: string, processorType: string): string;

Return a fully-qualified processorType resource name string.

Parameters

Name	Description
project	`string`
location	`string`
processorType	`string`

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
string	{string} Resource name string.

reviewDocument(request, options)

reviewDocument(request?: protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

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

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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'
  /**
   *  The document that needs human review.
   */
  // const document = {}
  /**
   *  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').v1beta3;

  // 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();

reviewDocument(request, options, callback)

reviewDocument(request: protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

reviewDocument(request, callback)

reviewDocument(request: protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest`
callback	`Callback<LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void