Class: Google::Cloud::DocumentAI::V1::Document::Page::FormField

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1/document.rb

Overview

A form field detected on the page.

Instance Attribute Summary collapse

Instance Attribute Details

#corrected_key_text ⇒ ::String

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

Returns:

  • (::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.



607
608
609
610
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 607

class FormField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#corrected_value_text ⇒ ::String

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

Returns:

  • (::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.



607
608
609
610
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 607

class FormField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#field_name ⇒ ::Google::Cloud::DocumentAI::V1::Document::Page::Layout

Returns Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

Returns:



607
608
609
610
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 607

class FormField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#field_value ⇒ ::Google::Cloud::DocumentAI::V1::Document::Page::Layout

Returns Layout for the FormField value.

Returns:



607
608
609
610
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 607

class FormField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name_detected_languages ⇒ ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>

Returns A list of detected languages for name together with confidence.

Returns:



607
608
609
610
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 607

class FormField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#provenance ⇒ ::Google::Cloud::DocumentAI::V1::Document::Provenance

Returns The history of this annotation.

Returns:



607
608
609
610
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 607

class FormField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#value_detected_languages ⇒ ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>

Returns A list of detected languages for value together with confidence.

Returns:



607
608
609
610
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 607

class FormField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#value_type ⇒ ::String

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

Returns:

  • (::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


607
608
609
610
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 607

class FormField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end