Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessRequest

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 the process document method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1ProcessRequest

Returns a new instance of GoogleCloudDocumentaiV1ProcessRequest.



4166
4167
4168
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4166

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

Instance Attribute Details

#field_mask ⇒ String

Specifies which fields to include in ProcessResponse's document. 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) 


4144
4145
4146
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4144

def field_mask
  @field_mask
end

#inline_document ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Document

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:



4152
4153
4154
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4152

def inline_document
  @inline_document
end

#raw_document ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1RawDocument

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

Returns:



4157
4158
4159
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4157

def raw_document
  @raw_document
end

#skip_human_review ⇒ Boolean Also known as: skip_human_review?

Whether Human Review feature should be skipped for this request. Default to false. Corresponds to the JSON property skipHumanReview

Returns:

  • (Boolean) 


4163
4164
4165
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4163

def skip_human_review
  @skip_human_review
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4171
4172
4173
4174
4175
4176
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4171

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