Class FormField (0.2.0)

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

A form field detected on the page.

Attributes

NameDescription
field_name .document.Document.Page.Layout
Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.
field_value .document.Document.Page.Layout
Layout for the FormField value.
name_detected_languages Sequence[.document.Document.Page.DetectedLanguage]
A list of detected languages for name together with confidence.
value_detected_languages Sequence[.document.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
An internal field, created for Labeling UI to export key text.
corrected_value_text str
An internal field, created for Labeling UI to export value text.

Methods

__delattr__

__delattr__(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

__eq__

__eq__(other)

Return True if the messages are equal, False otherwise.

__ne__

__ne__(other)

Return True if the messages are unequal, False otherwise.

__setattr__

__setattr__(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.