Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest (v0.33.0)

Version 0.33.0

• 0.38.0 (latest)
• 0.37.0
• 0.36.1
• 0.35.0
• 0.34.0
• 0.33.1
• 0.32.0
• 0.31.0
• 0.30.2
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.4

Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::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::V1beta3::DocumentOutputConfig

Returns

• (::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig) — The output configuration for the BatchProcessDocuments method.

#document_output_config=

def document_output_config=(value) -> ::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig) — The output configuration for the BatchProcessDocuments method.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig) — The output configuration for the BatchProcessDocuments method.

#input_configs

def input_configs() -> ::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>) — The input config for each single document in the batch process.

#input_configs=

def input_configs=(value) -> ::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>) — The input config for each single document in the batch process.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>) — The input config for each single document in the batch process.

#input_documents

def input_documents() -> ::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig

Returns

• (::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig) — The input documents for the BatchProcessDocuments method.

#input_documents=

def input_documents=(value) -> ::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig) — The input documents for the BatchProcessDocuments method.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig) — The input documents for the BatchProcessDocuments method.

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

#output_config

def output_config() -> ::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig

Returns

• (::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig) — The overall output config for batch process.

#output_config=

def output_config=(value) -> ::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig) — The overall output config for batch process.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig) — The overall output config for batch process.

#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

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