Google Cloud Document Ai V1 Client - Class ProcessRequest (1.7.0)

Version 1.7.0

• 2.1.2 (latest)
• 2.1.1
• 2.0.0
• 1.14.0
• 1.13.1
• 1.12.2
• 1.9.0
• 1.8.2
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.2
• 1.1.1
• 1.0.1

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

Request message for the ProcessDocument method.

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

Namespace

Google \ Cloud \ DocumentAI \ V1

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.
↳ raw_document	Google\Cloud\DocumentAI\V1\RawDocument A raw document content (bytes).
↳ gcs_document	Google\Cloud\DocumentAI\V1\GcsDocument A raw document on Google Cloud Storage.
↳ name	string Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
↳ skip_human_review	bool Whether human review should be skipped for this request. Default to false.
↳ field_mask	Google\Protobuf\FieldMask Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of {document_field_name} or pages.{page_field_name}.
↳ process_options	Google\Cloud\DocumentAI\V1\ProcessOptions Inference-time options for the process API

getInlineDocument

An inline document proto.

Returns
Type	Description
Google\Cloud\DocumentAI\V1\Document|null

hasInlineDocument

setInlineDocument

An inline document proto.

Parameter
Name	Description
var	Google\Cloud\DocumentAI\V1\Document

Returns
Type	Description
$this

getRawDocument

A raw document content (bytes).

Returns
Type	Description
Google\Cloud\DocumentAI\V1\RawDocument|null

hasRawDocument

setRawDocument

A raw document content (bytes).

Parameter
Name	Description
var	Google\Cloud\DocumentAI\V1\RawDocument

Returns
Type	Description
$this

getGcsDocument

A raw document on Google Cloud Storage.

Returns
Type	Description
Google\Cloud\DocumentAI\V1\GcsDocument|null

hasGcsDocument

setGcsDocument

A raw document on Google Cloud Storage.

Parameter
Name	Description
var	Google\Cloud\DocumentAI\V1\GcsDocument

Returns
Type	Description
$this

getName

Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version.

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 the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version.

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

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

getFieldMask

Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of {document_field_name} or pages.{page_field_name}.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasFieldMask

clearFieldMask

setFieldMask

Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of {document_field_name} or pages.{page_field_name}.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

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

getSource

Returns
Type	Description
string

static::build

Parameter
Name	Description
name	string Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
Type	Description
Google\Cloud\DocumentAI\V1\ProcessRequest