Reference documentation and code samples for the Google Cloud Document Ai V1 Client class BatchProcessRequest.
Request message for batch process document method.
Generated from protobuf message google.cloud.documentai.v1.BatchProcessRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name of Processor or ProcessorVersion. Format: |
↳ input_documents |
Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig
The input documents for batch process. |
↳ document_output_config |
Google\Cloud\DocumentAI\V1\DocumentOutputConfig
The overall output config for batch process. |
↳ skip_human_review |
bool
Whether Human Review feature should be skipped for this request. Default to false. |
getName
Required. The resource name of Processor or ProcessorVersion.
Format: projects/{project}/locations/{location}/processors/{processor},
or
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The resource name of Processor or ProcessorVersion.
Format: projects/{project}/locations/{location}/processors/{processor},
or
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInputDocuments
The input documents for batch process.
Generated from protobuf field .google.cloud.documentai.v1.BatchDocumentsInputConfig input_documents = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig|null |
|
hasInputDocuments
clearInputDocuments
setInputDocuments
The input documents for batch process.
Generated from protobuf field .google.cloud.documentai.v1.BatchDocumentsInputConfig input_documents = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocumentOutputConfig
The overall output config for batch process.
Generated from protobuf field .google.cloud.documentai.v1.DocumentOutputConfig document_output_config = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\DocumentOutputConfig|null |
|
hasDocumentOutputConfig
clearDocumentOutputConfig
setDocumentOutputConfig
The overall output config for batch process.
Generated from protobuf field .google.cloud.documentai.v1.DocumentOutputConfig document_output_config = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DocumentAI\V1\DocumentOutputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSkipHumanReview
Whether Human Review feature should be skipped for this request. Default to false.
Generated from protobuf field bool skip_human_review = 4;
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSkipHumanReview
Whether Human Review feature should be skipped for this request. Default to false.
Generated from protobuf field bool skip_human_review = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|