Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageFormField

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta3/classes.rb,
lib/google/apis/documentai_v1beta3/representations.rb,
lib/google/apis/documentai_v1beta3/representations.rb

Overview

A form field detected on the page.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3DocumentPageFormField

Returns a new instance of GoogleCloudDocumentaiV1beta3DocumentPageFormField.



6508
6509
6510
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6508

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) 


6466
6467
6468
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6466

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) 


6473
6474
6475
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6473

def corrected_value_text
  @corrected_value_text
end

#field_name ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageLayout

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

Returns:



6478
6479
6480
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6478

def field_name
  @field_name
end

#field_value ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageLayout

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

Returns:



6483
6484
6485
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6483

def field_value
  @field_value
end

#name_detected_languages ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage>

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

Returns:



6488
6489
6490
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6488

def name_detected_languages
  @name_detected_languages
end

#provenance ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance

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

Returns:



6494
6495
6496
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6494

def provenance
  @provenance
end

#value_detected_languages ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage>

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

Returns:



6499
6500
6501
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6499

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) 


6506
6507
6508
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6506

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 6513

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