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.



1507
1508
1509
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1507

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

Instance Attribute Details

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

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

Returns:



1477
1478
1479
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1477

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:



1482
1483
1484
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1482

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:



1487
1488
1489
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1487

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:



1493
1494
1495
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1493

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:



1498
1499
1500
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1498

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) 


1505
1506
1507
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1505

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1512

def update!(**args)
  @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