Class FormField (2.4.0)

Version 2.4.0

• 3.0.1 (latest)
• 3.0.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.3
• 2.28.0
• 2.27.1
• 2.26.0
• 2.25.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

FormField(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A form field detected on the page.

Attributes

Name	Description
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.