Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Document::Page::FormField (v0.21.1)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::Document::Page::FormField.

A form field detected on the page.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#corrected_key_text

def corrected_key_text() -> ::String
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.

#corrected_key_text=

def corrected_key_text=(value) -> ::String
Parameter
  • value (::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.
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.

#corrected_value_text

def corrected_value_text() -> ::String
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.

#corrected_value_text=

def corrected_value_text=(value) -> ::String
Parameter
  • value (::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.
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.

#field_name

def field_name() -> ::Google::Cloud::DocumentAI::V1::Document::Page::Layout
Returns

#field_name=

def field_name=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Page::Layout
Parameter
Returns

#field_value

def field_value() -> ::Google::Cloud::DocumentAI::V1::Document::Page::Layout
Returns

#field_value=

def field_value=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Page::Layout
Parameter
Returns

#name_detected_languages

def name_detected_languages() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>
Returns

#name_detected_languages=

def name_detected_languages=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>
Parameter
Returns

#provenance

def provenance() -> ::Google::Cloud::DocumentAI::V1::Document::Provenance
Returns

#provenance=

def provenance=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Provenance
Parameter
Returns

#value_detected_languages

def value_detected_languages() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>
Returns

#value_detected_languages=

def value_detected_languages=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>
Parameter
Returns

#value_type

def value_type() -> ::String
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

#value_type=

def value_type=(value) -> ::String
Parameter
  • value (::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
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