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.



7408
7409
7410
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7408

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:



7371
7372
7373
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7371

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:



7376
7377
7378
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7376

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:



7381
7382
7383
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7381

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>) 


7390
7391
7392
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7390

def labels
  @labels
end

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

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

Returns:



7395
7396
7397
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7395

def output_config
  @output_config
end

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

Options for Process API Corresponds to the JSON property processOptions

Returns:



7400
7401
7402
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7400

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) 


7405
7406
7407
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7405

def skip_human_review
  @skip_human_review
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7413
7414
7415
7416
7417
7418
7419
7420
7421
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7413

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