Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest

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 the ProcessDocument method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3ProcessRequest

Returns a new instance of GoogleCloudDocumentaiV1beta3ProcessRequest.



10186
10187
10188
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 10186

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

Instance Attribute Details

#document ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document

Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. Corresponds to the JSON property document

Returns:



10148
10149
10150
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 10148

def document
  @document
end

#field_mask ⇒ String

Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of document_field_name or pages.page_field_name`. Corresponds to the JSON propertyfieldMask`

Returns:

  • (String) 


10155
10156
10157
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 10155

def field_mask
  @field_mask
end

#gcs_document ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocument

Specifies a document stored on Cloud Storage. Corresponds to the JSON property gcsDocument

Returns:



10160
10161
10162
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 10160

def gcs_document
  @gcs_document
end

#inline_document ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document

Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. Corresponds to the JSON property inlineDocument

Returns:



10168
10169
10170
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 10168

def inline_document
  @inline_document
end

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

Options for Process API Corresponds to the JSON property processOptions

Returns:



10173
10174
10175
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 10173

def process_options
  @process_options
end

#raw_document ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument

Payload message of raw document content (bytes). Corresponds to the JSON property rawDocument

Returns:



10178
10179
10180
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 10178

def raw_document
  @raw_document
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) 


10183
10184
10185
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 10183

def skip_human_review
  @skip_human_review
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10191
10192
10193
10194
10195
10196
10197
10198
10199
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 10191

def update!(**args)
  @document = args[:document] if args.key?(:document)
  @field_mask = args[:field_mask] if args.key?(:field_mask)
  @gcs_document = args[:gcs_document] if args.key?(:gcs_document)
  @inline_document = args[:inline_document] if args.key?(:inline_document)
  @process_options = args[:process_options] if args.key?(:process_options)
  @raw_document = args[:raw_document] if args.key?(:raw_document)
  @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
end