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

#field_mask=

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

#gcs_document

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

#gcs_document=

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

#inline_document

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

#inline_document=

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

#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

#process_options=

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

#raw_document

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

#raw_document=

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

#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.