Class FormField (2.3.0)

Stay organized with collections Save and categorize content based on your preferences.
FormField(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A form field detected on the page.

Attributes

NameDescription
field_name google.cloud.documentai_v1.types.Document.Page.Layout
Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.
field_value google.cloud.documentai_v1.types.Document.Page.Layout
Layout for the FormField value.
name_detected_languages MutableSequence[google.cloud.documentai_v1.types.Document.Page.DetectedLanguage]
A list of detected languages for name together with confidence.
value_detected_languages MutableSequence[google.cloud.documentai_v1.types.Document.Page.DetectedLanguage]
A list of detected languages for value together with confidence.
value_type str
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".
corrected_key_text str
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 str
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.
provenance google.cloud.documentai_v1.types.Document.Provenance
The history of this annotation.

Inheritance

builtins.object > proto.message.Message > FormField