Method: projects.locations.processors.process

Processes a single document.

HTTP request

POST https://documentai.googleapis.com/v1beta3/{name=projects/*/locations/*/processors/*}:process

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The processor resource name.

Authorization requires the following IAM permission on the specified resource name:

  • documentai.processors.processOnline

Request body

The request body contains data with the following structure:

JSON representation
{
  "document": {
    object (Document)
  },
  "skipHumanReview": boolean
}
Fields
document

object (Document)

The document payload, the [content] and [mimeType] fields must be set.

skipHumanReview

boolean

Whether Human Review feature should be skipped for this request. Default to false.

Response body

If successful, the response body contains data with the following structure:

Response message for the process document method.

JSON representation
{
  "document": {
    object (Document)
  },
  "humanReviewOperation": string
}
Fields
document

object (Document)

The document payload, will populate fields based on the processor's behavior.

humanReviewOperation

string

The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by humanReviewConfig.reviewDocument method.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.