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.



7123
7124
7125
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7123

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) 


7077
7078
7079
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7077

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:



7082
7083
7084
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7082

def gcs_document
  @gcs_document
end

#imageless_mode ⇒ Boolean Also known as: imageless_mode?

Optional. Option to remove images from the document. Corresponds to the JSON property imagelessMode

Returns:

  • (Boolean) 


7087
7088
7089
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7087

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



7096
7097
7098
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7096

def inline_document
  @inline_document
end

#labels ⇒ Hash<String,String>

Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


7105
7106
7107
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7105

def labels
  @labels
end

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

Options for Process API Corresponds to the JSON property processOptions

Returns:



7110
7111
7112
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7110

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:



7115
7116
7117
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7115

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) 


7120
7121
7122
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7120

def skip_human_review
  @skip_human_review
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7128

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