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
#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"