Reference documentation and code samples for the Google Cloud Document Ai V1 Client class ProcessRequest.
Request message for the process document method.
Generated from protobuf message google.cloud.documentai.v1.ProcessRequest
Namespace
Google \ Cloud \ DocumentAI \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ inline_document
↳ raw_document
↳ 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 feature should be skipped for this request. Default to false.
↳ field_mask
Google\Protobuf\FieldMask
Specifies which fields to include in ProcessResponse's document. Only supports top level document and pages field so it must be in the form of {document_field_name}
or pages.{page_field_name}
.
getInlineDocument
An inline document proto.
hasInlineDocument
setInlineDocument
An inline document proto.
$this
getRawDocument
A raw document content (bytes).
hasRawDocument
setRawDocument
A raw document content (bytes).
$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}
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}
var
string
$this
getSkipHumanReview
Whether Human Review feature should be skipped for this request. Default to false.
bool
setSkipHumanReview
Whether Human Review feature should be skipped for this request. Default to false.
var
bool
$this
getFieldMask
Specifies which fields to include in ProcessResponse's document.
Only supports top level document and pages field so it must be in the form
of {document_field_name}
or pages.{page_field_name}
.
hasFieldMask
clearFieldMask
setFieldMask
Specifies which fields to include in ProcessResponse's document.
Only supports top level document and pages field so it must be in the form
of {document_field_name}
or pages.{page_field_name}
.
$this
getSource
string
static::build
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}
