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.



2505
2506
2507
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2505

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) 


2463
2464
2465
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2463

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) 


2470
2471
2472
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2470

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:



2475
2476
2477
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2475

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:



2480
2481
2482
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2480

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:



2485
2486
2487
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2485

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:



2491
2492
2493
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2491

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:



2496
2497
2498
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2496

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) 


2503
2504
2505
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2503

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2510

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