Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta3/classes.rb,
lib/google/apis/documentai_v1beta3/representations.rb,
lib/google/apis/documentai_v1beta3/representations.rb

Overview

Request message for BatchProcessDocuments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3BatchProcessRequest

Returns a new instance of GoogleCloudDocumentaiV1beta3BatchProcessRequest.



2329
2330
2331
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2329

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#document_output_config ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentOutputConfig

Config that controls the output of documents. All documents will be written as a JSON file. Corresponds to the JSON property documentOutputConfig

Returns:



2292
2293
2294
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2292

def document_output_config
  @document_output_config
end

#input_configs ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig>

The input config for each single document in the batch process. Corresponds to the JSON property inputConfigs

Returns:



2297
2298
2299
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2297

def input_configs
  @input_configs
end

#input_documents ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig

The common config to specify a set of documents used as input. Corresponds to the JSON property inputDocuments

Returns:



2302
2303
2304
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2302

def input_documents
  @input_documents
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2311
2312
2313
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2311

def labels
  @labels
end

#output_config ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig

The output configuration in the BatchProcessDocuments method. Corresponds to the JSON property outputConfig

Returns:



2316
2317
2318
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2316

def output_config
  @output_config
end

#process_options ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions

Options for Process API Corresponds to the JSON property processOptions

Returns:



2321
2322
2323
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2321

def process_options
  @process_options
end

#skip_human_review ⇒ Boolean Also known as: skip_human_review?

Whether human review should be skipped for this request. Default to false. Corresponds to the JSON property skipHumanReview

Returns:

  • (Boolean) 


2326
2327
2328
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2326

def skip_human_review
  @skip_human_review
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2334
2335
2336
2337
2338
2339
2340
2341
2342
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2334

def update!(**args)
  @document_output_config = args[:document_output_config] if args.key?(:document_output_config)
  @input_configs = args[:input_configs] if args.key?(:input_configs)
  @input_documents = args[:input_documents] if args.key?(:input_documents)
  @labels = args[:labels] if args.key?(:labels)
  @output_config = args[:output_config] if args.key?(:output_config)
  @process_options = args[:process_options] if args.key?(:process_options)
  @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
end