Google Cloud Document Ai V1 Client - Class BatchProcessRequest (1.6.0)

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

Request message for BatchProcessDocuments.

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

Namespace

Google \ Cloud \ DocumentAI \ V1

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: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
`↳ input_documents`	`Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig` The input documents for the BatchProcessDocuments method.
`↳ document_output_config`	`Google\Cloud\DocumentAI\V1\DocumentOutputConfig` The output configuration for the BatchProcessDocuments method.
`↳ skip_human_review`	`bool` Whether human review should be skipped for this request. Default to `false`.
`↳ process_options`	`Google\Cloud\DocumentAI\V1\ProcessOptions` Inference-time options for the process API

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}

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}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInputDocuments

The input documents for the BatchProcessDocuments method.

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig\|null`

hasInputDocuments

clearInputDocuments

setInputDocuments

The input documents for the BatchProcessDocuments method.

Parameter
Name	Description
`var`	`Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig`

Returns
Type	Description
`$this`

getDocumentOutputConfig

The output configuration for the BatchProcessDocuments method.

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\DocumentOutputConfig\|null`

hasDocumentOutputConfig

clearDocumentOutputConfig

setDocumentOutputConfig

The output configuration for the BatchProcessDocuments method.

Parameter
Name	Description
`var`	`Google\Cloud\DocumentAI\V1\DocumentOutputConfig`

Returns
Type	Description
`$this`

getSkipHumanReview

Whether human review should be skipped for this request. Default to false.

Returns
Type	Description
`bool`

setSkipHumanReview

Whether human review should be skipped for this request. Default to false.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getProcessOptions

Inference-time options for the process API

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\ProcessOptions\|null`

hasProcessOptions

clearProcessOptions

setProcessOptions

Inference-time options for the process API

Parameter
Name	Description
`var`	`Google\Cloud\DocumentAI\V1\ProcessOptions`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`name`	`string` Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\BatchProcessRequest`