Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageFormField

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) ⇒ GoogleCloudDocumentaiV1beta2DocumentPageFormField

Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentPageFormField.

[View source]

8440
8441
8442
# File 'lib/google/apis/documentai_v1/classes.rb', line 8440

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)

8398
8399
8400
# File 'lib/google/apis/documentai_v1/classes.rb', line 8398

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)

8405
8406
8407
# File 'lib/google/apis/documentai_v1/classes.rb', line 8405

def corrected_value_text
  @corrected_value_text
end

#field_nameGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageLayout

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


8410
8411
8412
# File 'lib/google/apis/documentai_v1/classes.rb', line 8410

def field_name
  @field_name
end

#field_valueGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageLayout

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


8415
8416
8417
# File 'lib/google/apis/documentai_v1/classes.rb', line 8415

def field_value
  @field_value
end

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

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


8420
8421
8422
# File 'lib/google/apis/documentai_v1/classes.rb', line 8420

def name_detected_languages
  @name_detected_languages
end

#provenanceGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentProvenance

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


8426
8427
8428
# File 'lib/google/apis/documentai_v1/classes.rb', line 8426

def provenance
  @provenance
end

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

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


8431
8432
8433
# File 'lib/google/apis/documentai_v1/classes.rb', line 8431

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)

8438
8439
8440
# File 'lib/google/apis/documentai_v1/classes.rb', line 8438

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'lib/google/apis/documentai_v1/classes.rb', line 8445

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