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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1ProcessRequest

Returns a new instance of GoogleCloudDocumentaiV1ProcessRequest.



4606
4607
4608
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4606

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

Instance Attribute Details

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


4575
4576
4577
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4575

def field_mask
  @field_mask
end

#gcs_document ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1GcsDocument

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

Returns:



4580
4581
4582
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4580

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



4588
4589
4590
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4588

def inline_document
  @inline_document
end

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

Options for Process API Corresponds to the JSON property processOptions

Returns:



4593
4594
4595
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4593

def process_options
  @process_options
end

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

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

Returns:



4598
4599
4600
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4598

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) 


4603
4604
4605
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4603

def skip_human_review
  @skip_human_review
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4611

def update!(**args)
  @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