Method: processors.batchProcess

Full name: projects.locations.processors.batchProcess

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

HTTP request

POST https://{endpoint}/v1beta3/{name}:batchProcess

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters

Parameters
`name`	`string` Required. The resource name of `Processor` or `ProcessorVersion`. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` It takes the form `projects/{project}/locations/{location}/processors/{processor}`. Authorization requires one or more of the following IAM permissions on the specified resource `name`: `documentai.processors.processBatch` `documentai.processorVersions.processBatch`

name

string

Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} It takes the form projects/{project}/locations/{location}/processors/{processor}.

Authorization requires one or more of the following IAM permissions on the specified resource name:

documentai.processors.processBatch
documentai.processorVersions.processBatch

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "inputConfigs": [ { object (`BatchInputConfig`) } ], "outputConfig": { object (`BatchOutputConfig`) }, "inputDocuments": { object (`BatchDocumentsInputConfig`) }, "documentOutputConfig": { object (`DocumentOutputConfig`) }, "skipHumanReview": boolean, "processOptions": { object (`ProcessOptions`) }, "labels": { string: string, ... } }

{
  "inputConfigs": [
    {
      object (BatchInputConfig)
    }
  ],
  "outputConfig": {
    object (BatchOutputConfig)
  },
  "inputDocuments": {
    object (BatchDocumentsInputConfig)
  },
  "documentOutputConfig": {
    object (DocumentOutputConfig)
  },
  "skipHumanReview": boolean,
  "processOptions": {
    object (ProcessOptions)
  },
  "labels": {
    string: string,
    ...
  }
}

Fields
`inputConfigs[] (deprecated)`	`object (BatchInputConfig)` The input config for each single document in the batch process.
`outputConfig (deprecated)`	`object (BatchOutputConfig)` The overall output config for batch process.
`inputDocuments`	`object (BatchDocumentsInputConfig)` The input documents for the `processors.batchProcess` method.
`documentOutputConfig`	`object (DocumentOutputConfig)` The output configuration for the `processors.batchProcess` method.
`skipHumanReview`	`boolean` Whether human review should be skipped for this request. Default to `false`.
`processOptions`	`object (ProcessOptions)` Inference-time options for the process API
`labels`	`map (key: string, value: string)` Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires one of the following IAM permissions on the name resource, depending on the resource type:

documentai.processors.processBatch
documentai.processorVersions.processBatch

For more information, see the IAM documentation.