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
Methods
__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.
Generated from protobuf field .google.cloud.documentai.v1.Document inline_document = 4;
hasInlineDocument
setInlineDocument
An inline document proto.
Generated from protobuf field .google.cloud.documentai.v1.Document inline_document = 4;
$this
getRawDocument
A raw document content (bytes).
Generated from protobuf field .google.cloud.documentai.v1.RawDocument raw_document = 5;
hasRawDocument
setRawDocument
A raw document content (bytes).
Generated from protobuf field .google.cloud.documentai.v1.RawDocument raw_document = 5;
$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}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
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}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
var
string
$this
getSkipHumanReview
Whether Human Review feature should be skipped for this request. Default to false.
Generated from protobuf field bool skip_human_review = 3;
bool
setSkipHumanReview
Whether Human Review feature should be skipped for this request. Default to false.
Generated from protobuf field bool skip_human_review = 3;
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}
.
Generated from protobuf field .google.protobuf.FieldMask field_mask = 6;
Google\Protobuf\FieldMask|null
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}
.
Generated from protobuf field .google.protobuf.FieldMask field_mask = 6;
var
Google\Protobuf\FieldMask
$this
getSource
string
