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.



4372
4373
4374
# File 'lib/google/apis/documentai_v1/classes.rb', line 4372

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

Instance Attribute Details

#field_maskString

Specifies which fields to include in the ProcessResponse 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)


4350
4351
4352
# File 'lib/google/apis/documentai_v1/classes.rb', line 4350

def field_mask
  @field_mask
end

#inline_documentGoogle::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



4358
4359
4360
# File 'lib/google/apis/documentai_v1/classes.rb', line 4358

def inline_document
  @inline_document
end

#raw_documentGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1RawDocument

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



4363
4364
4365
# File 'lib/google/apis/documentai_v1/classes.rb', line 4363

def raw_document
  @raw_document
end

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


4369
4370
4371
# File 'lib/google/apis/documentai_v1/classes.rb', line 4369

def skip_human_review
  @skip_human_review
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4377
4378
4379
4380
4381
4382
# File 'lib/google/apis/documentai_v1/classes.rb', line 4377

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