Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Document::Page::FormField (v1.1.1)

Version 1.1.1

• 1.2.0 (latest)
• 1.1.1
• 1.0.0
• 0.23.1
• 0.22.0
• 0.21.1
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.2
• 0.16.2
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.4

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

• (::Google::Cloud::DocumentAI::V1::Document::Page::Layout) — Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

#field_name=

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

Parameter

• value (::Google::Cloud::DocumentAI::V1::Document::Page::Layout) — Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

Returns

• (::Google::Cloud::DocumentAI::V1::Document::Page::Layout) — Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

#field_value

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

Returns

• (::Google::Cloud::DocumentAI::V1::Document::Page::Layout) — Layout for the FormField value.

#field_value=

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

Parameter

• value (::Google::Cloud::DocumentAI::V1::Document::Page::Layout) — Layout for the FormField value.

Returns

• (::Google::Cloud::DocumentAI::V1::Document::Page::Layout) — Layout for the FormField value.

#name_detected_languages

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

Returns

• (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>) — A list of detected languages for name together with confidence.

#name_detected_languages=

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

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>) — A list of detected languages for name together with confidence.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>) — A list of detected languages for name together with confidence.

#provenance

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

Returns

• (::Google::Cloud::DocumentAI::V1::Document::Provenance) — The history of this annotation.

#provenance=

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

Parameter

• value (::Google::Cloud::DocumentAI::V1::Document::Provenance) — The history of this annotation.

Returns

• (::Google::Cloud::DocumentAI::V1::Document::Provenance) — The history of this annotation.

#value_detected_languages

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

Returns

• (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>) — A list of detected languages for value together with confidence.

#value_detected_languages=

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

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>) — A list of detected languages for value together with confidence.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>) — A list of detected languages for value together with confidence.

#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