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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3ProcessRequest

Returns a new instance of GoogleCloudDocumentaiV1beta3ProcessRequest.



8832
8833
8834
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8832

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:



8798
8799
8800
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8798

def document
  @document
end

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


8805
8806
8807
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8805

def field_mask
  @field_mask
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:



8813
8814
8815
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8813

def inline_document
  @inline_document
end

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

Options for Process API Corresponds to the JSON property processOptions

Returns:



8818
8819
8820
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8818

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:



8823
8824
8825
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8823

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) 


8829
8830
8831
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8829

def skip_human_review
  @skip_human_review
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8837
8838
8839
8840
8841
8842
8843
8844
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8837

def update!(**args)
  @document = args[:document] if args.key?(:document)
  @field_mask = args[:field_mask] if args.key?(:field_mask)
  @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