Document AI V1 API - Class Google::Cloud::DocumentAI::V1::ProcessRequest (v1.0.0)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::ProcessRequest.

Request message for the ProcessDocument method.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#field_mask

def field_mask() -> ::Google::Protobuf::FieldMask

Returns

(::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}.

#field_mask=

def field_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

value (::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}.

Returns

(::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}.

#gcs_document

def gcs_document() -> ::Google::Cloud::DocumentAI::V1::GcsDocument

Returns

(::Google::Cloud::DocumentAI::V1::GcsDocument) — A raw document on Google Cloud Storage.

#gcs_document=

def gcs_document=(value) -> ::Google::Cloud::DocumentAI::V1::GcsDocument

Parameter

value (::Google::Cloud::DocumentAI::V1::GcsDocument) — A raw document on Google Cloud Storage.

Returns

(::Google::Cloud::DocumentAI::V1::GcsDocument) — A raw document on Google Cloud Storage.

#inline_document

def inline_document() -> ::Google::Cloud::DocumentAI::V1::Document

Returns

(::Google::Cloud::DocumentAI::V1::Document) — An inline document proto.

#inline_document=

def inline_document=(value) -> ::Google::Cloud::DocumentAI::V1::Document

Parameter

value (::Google::Cloud::DocumentAI::V1::Document) — An inline document proto.

Returns

(::Google::Cloud::DocumentAI::V1::Document) — An inline document proto.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

#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.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{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.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{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.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

#process_options

def process_options() -> ::Google::Cloud::DocumentAI::V1::ProcessOptions

Returns

(::Google::Cloud::DocumentAI::V1::ProcessOptions) — Inference-time options for the process API

#process_options=

def process_options=(value) -> ::Google::Cloud::DocumentAI::V1::ProcessOptions

Parameter

value (::Google::Cloud::DocumentAI::V1::ProcessOptions) — Inference-time options for the process API

Returns

(::Google::Cloud::DocumentAI::V1::ProcessOptions) — Inference-time options for the process API

#raw_document

def raw_document() -> ::Google::Cloud::DocumentAI::V1::RawDocument

Returns

(::Google::Cloud::DocumentAI::V1::RawDocument) — A raw document content (bytes).

#raw_document=

def raw_document=(value) -> ::Google::Cloud::DocumentAI::V1::RawDocument

Parameter

value (::Google::Cloud::DocumentAI::V1::RawDocument) — A raw document content (bytes).

Returns

(::Google::Cloud::DocumentAI::V1::RawDocument) — A raw document content (bytes).

#skip_human_review

def skip_human_review() -> ::Boolean

Returns

(::Boolean) — Whether human review should be skipped for this request. Default to false.

#skip_human_review=

def skip_human_review=(value) -> ::Boolean

Parameter

value (::Boolean) — Whether human review should be skipped for this request. Default to false.

Returns

(::Boolean) — Whether human review should be skipped for this request. Default to false.