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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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.
Generated from protobuf field .google.cloud.documentai.v1.Document inline_document = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\Document|null | |
hasInlineDocument
setInlineDocument
An inline document proto.
Generated from protobuf field .google.cloud.documentai.v1.Document inline_document = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DocumentAI\V1\Document
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHumanReviewConfig
Required. The resource name of the HumanReviewConfig that the document will be reviewed with.
Generated from protobuf field string human_review_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setHumanReviewConfig
Required. The resource name of the HumanReviewConfig that the document will be reviewed with.
Generated from protobuf field string human_review_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableSchemaValidation
Whether the validation should be performed on the ad-hoc review request.
Generated from protobuf field bool enable_schema_validation = 3;
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableSchemaValidation
Whether the validation should be performed on the ad-hoc review request.
Generated from protobuf field bool enable_schema_validation = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPriority
The priority of the human review task.
Generated from protobuf field .google.cloud.documentai.v1.ReviewDocumentRequest.Priority priority = 5;
| Returns | |
|---|---|
| Type | Description |
int | |
setPriority
The priority of the human review task.
Generated from protobuf field .google.cloud.documentai.v1.ReviewDocumentRequest.Priority priority = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDocumentSchema
The document schema of the human review task.
Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema document_schema = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\DocumentSchema|null | |
hasDocumentSchema
clearDocumentSchema
setDocumentSchema
The document schema of the human review task.
Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema document_schema = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DocumentAI\V1\DocumentSchema
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
| Returns | |
|---|---|
| Type | Description |
string | |