Google Cloud Document Ai V1 Client - Class ReviewDocumentRequest (1.3.0)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class ReviewDocumentRequest.

Request message for review document method.

Generated from protobuf message google.cloud.documentai.v1.ReviewDocumentRequest

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ inline_document Google\Cloud\DocumentAI\V1\Document

An inline document proto.

↳ human_review_config string

Required. The resource name of the HumanReviewConfig that the document will be reviewed with.

↳ enable_schema_validation bool

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

↳ priority int

The priority of the human review task.

↳ document_schema Google\Cloud\DocumentAI\V1\DocumentSchema

The document schema of the human review task.

getInlineDocument

An inline document proto.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\Document|null

hasInlineDocument

setInlineDocument

An inline document proto.

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\Document
Returns
TypeDescription
$this

getHumanReviewConfig

Required. The resource name of the HumanReviewConfig that the document will be reviewed with.

Returns
TypeDescription
string

setHumanReviewConfig

Required. The resource name of the HumanReviewConfig that the document will be reviewed with.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEnableSchemaValidation

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

Returns
TypeDescription
bool

setEnableSchemaValidation

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getPriority

The priority of the human review task.

Returns
TypeDescription
int

setPriority

The priority of the human review task.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDocumentSchema

The document schema of the human review task.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\DocumentSchema|null

hasDocumentSchema

clearDocumentSchema

setDocumentSchema

The document schema of the human review task.

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\DocumentSchema
Returns
TypeDescription
$this

getSource

Returns
TypeDescription
string

static::build

Parameter
NameDescription
humanReviewConfig string

Required. The resource name of the HumanReviewConfig that the document will be reviewed with. Please see Google\Cloud\DocumentAI\V1\DocumentProcessorServiceClient::humanReviewConfigName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\ReviewDocumentRequest