Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchProcessRequest

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

Overview

Request message for BatchProcessDocuments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1BatchProcessRequest

Returns a new instance of GoogleCloudDocumentaiV1BatchProcessRequest.



1598
1599
1600
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1598

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

Instance Attribute Details

#document_output_config ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentOutputConfig

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

Returns:



1571
1572
1573
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1571

def document_output_config
  @document_output_config
end

#input_documents ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig

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

Returns:



1576
1577
1578
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1576

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


1585
1586
1587
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1585

def labels
  @labels
end

#process_options ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessOptions

Options for Process API Corresponds to the JSON property processOptions

Returns:



1590
1591
1592
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1590

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) 


1595
1596
1597
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1595

def skip_human_review
  @skip_human_review
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1603

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