Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageFormField

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
more...

Overview

A form field detected on the page.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta1DocumentPageFormField

Returns a new instance of GoogleCloudDocumentaiV1beta1DocumentPageFormField.

[View source]

6291
6292
6293
# File 'lib/google/apis/documentai_v1/classes.rb', line 6291

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

Instance Attribute Details

#corrected_key_textString

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)

6249
6250
6251
# File 'lib/google/apis/documentai_v1/classes.rb', line 6249

def corrected_key_text
  @corrected_key_text
end

#corrected_value_textString

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)

6256
6257
6258
# File 'lib/google/apis/documentai_v1/classes.rb', line 6256

def corrected_value_text
  @corrected_value_text
end

#field_nameGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageLayout

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


6261
6262
6263
# File 'lib/google/apis/documentai_v1/classes.rb', line 6261

def field_name
  @field_name
end

#field_valueGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageLayout

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


6266
6267
6268
# File 'lib/google/apis/documentai_v1/classes.rb', line 6266

def field_value
  @field_value
end

#name_detected_languagesArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage>

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


6271
6272
6273
# File 'lib/google/apis/documentai_v1/classes.rb', line 6271

def name_detected_languages
  @name_detected_languages
end

#provenanceGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentProvenance

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


6277
6278
6279
# File 'lib/google/apis/documentai_v1/classes.rb', line 6277

def provenance
  @provenance
end

#value_detected_languagesArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage>

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


6282
6283
6284
# File 'lib/google/apis/documentai_v1/classes.rb', line 6282

def value_detected_languages
  @value_detected_languages
end

#value_typeString

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)

6289
6290
6291
# File 'lib/google/apis/documentai_v1/classes.rb', line 6289

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
# File 'lib/google/apis/documentai_v1/classes.rb', line 6296

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