Document AI V1 API - Class Google::Cloud::DocumentAI::V1::BatchProcessRequest (v0.23.1)

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

Request message for BatchProcessDocuments.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#document_output_config

def document_output_config() -> ::Google::Cloud::DocumentAI::V1::DocumentOutputConfig
Returns

#document_output_config=

def document_output_config=(value) -> ::Google::Cloud::DocumentAI::V1::DocumentOutputConfig
Parameter
Returns

#input_documents

def input_documents() -> ::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig
Returns

#input_documents=

def input_documents=(value) -> ::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig
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 Processor or ProcessorVersion. 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 Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
Returns
  • (::String) — Required. The resource name of Processor or ProcessorVersion. 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

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