Document AI V1 API - Class Google::Cloud::DocumentAI::V1::ProcessRequest (v0.10.0)

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

Request message for the process document 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 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}.

#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} or pages.{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} or pages.{page_field_name}.

#inline_document

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

#inline_document=

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

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

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