Method: humanReviewConfig.reviewDocument

Full name: projects.locations.processors.humanReviewConfig.reviewDocument

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

HTTP request

POST https://{endpoint}/v1/{humanReviewConfig}:reviewDocument

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

Path parameters

Parameters
humanReviewConfig

string

Required. The resource name of the HumanReviewConfig that the document will be reviewed with. It takes the form projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig.

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

  • documentai.humanReviewConfigs.review

Request body

The request body contains data with the following structure:

JSON representation 
{
  "enableSchemaValidation": boolean,
  "priority": enum (Priority),
  "documentSchema": {
    object (DocumentSchema)
  },

  // Union field source can be only one of the following:
  "inlineDocument": {
    object (Document)
  }
  // End of list of possible types for union field source.
}
Fields
enableSchemaValidation

boolean

Whether the validation should be performed on the ad-hoc review request.
priority

enum (Priority)

The priority of the human review task.
documentSchema

object (DocumentSchema)

The document schema of the human review task.
Union field source. The document payload. source can be only one of the following:
inlineDocument

object (Document)

An inline document proto.

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 the following IAM permission on the humanReviewConfig resource:

  • documentai.humanReviewConfigs.review

For more information, see the IAM documentation.

Priority

The priority level of the human review task.

Enums
DEFAULT The default priority level.
URGENT The urgent priority level. The labeling manager should allocate labeler resource to the urgent task queue to respect this priority level.