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
↳ document_output_config
↳ 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.

hasInputDocuments

clearInputDocuments

setInputDocuments

The input documents for the BatchProcessDocuments method.

Returns
Type
Description
$this

getDocumentOutputConfig

The output configuration for the BatchProcessDocuments method.

Returns
Type
Description

hasDocumentOutputConfig

clearDocumentOutputConfig

setDocumentOutputConfig

The output configuration for the BatchProcessDocuments method.

Parameter
Name
Description
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

hasProcessOptions

clearProcessOptions

setProcessOptions

Inference-time options for the process API

Parameter
Name
Description
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}

Design a Mobile Site
View Site in Mobile | Classic
Share by: