Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::ProcessRequest.
Request message for the process document method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#document
def document() -> ::Google::Cloud::DocumentAI::V1beta3::Document
Returns
- (::Google::Cloud::DocumentAI::V1beta3::Document) — The document payload, the [content] and [mime_type] fields must be set.
#document=
def document=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Document
Parameter
- value (::Google::Cloud::DocumentAI::V1beta3::Document) — The document payload, the [content] and [mime_type] fields must be set.
Returns
- (::Google::Cloud::DocumentAI::V1beta3::Document) — The document payload, the [content] and [mime_type] fields must be set.
#field_mask
def field_mask() -> ::Google::Protobuf::FieldMask
Returns
-
(::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}
orpages.{page_field_name}
.
#field_mask=
def field_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
-
value (::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}
orpages.{page_field_name}
.
Returns
-
(::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}
orpages.{page_field_name}
.
#inline_document
def inline_document() -> ::Google::Cloud::DocumentAI::V1beta3::Document
Returns
- (::Google::Cloud::DocumentAI::V1beta3::Document) — An inline document proto.
#inline_document=
def inline_document=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Document
Parameter
- value (::Google::Cloud::DocumentAI::V1beta3::Document) — An inline document proto.
Returns
- (::Google::Cloud::DocumentAI::V1beta3::Document) — An inline document proto.
#name
def name() -> ::String
Returns
-
(::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][google.cloud.documentai.v1beta3.Processor.default_processor_version].
Format:
projects/{project}/locations/{location}/processors/{processor}
, orprojects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
#name=
def name=(value) -> ::String
Parameter
-
value (::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][google.cloud.documentai.v1beta3.Processor.default_processor_version].
Format:
projects/{project}/locations/{location}/processors/{processor}
, orprojects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
Returns
-
(::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][google.cloud.documentai.v1beta3.Processor.default_processor_version].
Format:
projects/{project}/locations/{location}/processors/{processor}
, orprojects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
#process_options
def process_options() -> ::Google::Cloud::DocumentAI::V1beta3::ProcessOptions
Returns
- (::Google::Cloud::DocumentAI::V1beta3::ProcessOptions) — Inference-time options for the process API
#process_options=
def process_options=(value) -> ::Google::Cloud::DocumentAI::V1beta3::ProcessOptions
Parameter
- value (::Google::Cloud::DocumentAI::V1beta3::ProcessOptions) — Inference-time options for the process API
Returns
- (::Google::Cloud::DocumentAI::V1beta3::ProcessOptions) — Inference-time options for the process API
#raw_document
def raw_document() -> ::Google::Cloud::DocumentAI::V1beta3::RawDocument
Returns
- (::Google::Cloud::DocumentAI::V1beta3::RawDocument) — A raw document content (bytes).
#raw_document=
def raw_document=(value) -> ::Google::Cloud::DocumentAI::V1beta3::RawDocument
Parameter
- value (::Google::Cloud::DocumentAI::V1beta3::RawDocument) — A raw document content (bytes).
Returns
- (::Google::Cloud::DocumentAI::V1beta3::RawDocument) — A raw document content (bytes).
#skip_human_review
def skip_human_review() -> ::Boolean
Returns
- (::Boolean) — Whether Human Review feature should be skipped for this request. Default to false.
#skip_human_review=
def skip_human_review=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether Human Review feature should be skipped for this request. Default to false.
Returns
- (::Boolean) — Whether Human Review feature should be skipped for this request. Default to false.