Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageFormField

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

A form field detected on the page.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1DocumentPageFormField

Returns a new instance of GoogleCloudDocumentaiV1DocumentPageFormField.



2176
2177
2178
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2176

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

Instance Attribute Details

#corrected_key_text ⇒ String

Created for Labeling UI to export key text. If corrections were made to the text identified by the field_name.text_anchor, this field will contain the correction. Corresponds to the JSON property correctedKeyText

Returns:

  • (String) 


2134
2135
2136
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2134

def corrected_key_text
  @corrected_key_text
end

#corrected_value_text ⇒ String

Created for Labeling UI to export value text. If corrections were made to the text identified by the field_value.text_anchor, this field will contain the correction. Corresponds to the JSON property correctedValueText

Returns:

  • (String) 


2141
2142
2143
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2141

def corrected_value_text
  @corrected_value_text
end

#field_name ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageLayout

Visual element describing a layout unit on a page. Corresponds to the JSON property fieldName

Returns:



2146
2147
2148
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2146

def field_name
  @field_name
end

#field_value ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageLayout

Visual element describing a layout unit on a page. Corresponds to the JSON property fieldValue

Returns:



2151
2152
2153
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2151

def field_value
  @field_value
end

#name_detected_languages ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageDetectedLanguage>

A list of detected languages for name together with confidence. Corresponds to the JSON property nameDetectedLanguages

Returns:



2156
2157
2158
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2156

def name_detected_languages
  @name_detected_languages
end

#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentProvenance

Structure to identify provenance relationships between annotations in different revisions. Corresponds to the JSON property provenance

Returns:



2162
2163
2164
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2162

def provenance
  @provenance
end

#value_detected_languages ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageDetectedLanguage>

A list of detected languages for value together with confidence. Corresponds to the JSON property valueDetectedLanguages

Returns:



2167
2168
2169
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2167

def value_detected_languages
  @value_detected_languages
end

#value_type ⇒ String

If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - " unfilled_checkbox" - "filled_checkbox" Corresponds to the JSON property valueType

Returns:

  • (String) 


2174
2175
2176
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2174

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2181

def update!(**args)
  @corrected_key_text = args[:corrected_key_text] if args.key?(:corrected_key_text)
  @corrected_value_text = args[:corrected_value_text] if args.key?(:corrected_value_text)
  @field_name = args[:field_name] if args.key?(:field_name)
  @field_value = args[:field_value] if args.key?(:field_value)
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
  @provenance = args[:provenance] if args.key?(:provenance)
  @value_detected_languages = args[:value_detected_languages] if args.key?(:value_detected_languages)
  @value_type = args[:value_type] if args.key?(:value_type)
end