FormField Class

Represents a field recognized in an input form.

New in version v2.1: Support for to_dict and from_dict methods

Inheritance

builtins.object

FormField

Constructor

FormField(**kwargs)

Variables

value_type

str

The type of value found on FormField. Described in FieldValueType, possible types include: 'string', 'date', 'time', 'phoneNumber', 'float', 'integer', 'dictionary', 'list', 'selectionMark', or 'countryRegion'.

label_data

FieldData

Contains the text, bounding box, and field elements for the field label. Note that this is not returned for forms analyzed by models trained with labels.

value_data

FieldData

Contains the text, bounding box, and field elements for the field value.

name

str

The unique name of the field or the training-time label if analyzed from a custom model that was trained with labels.

value

str, int, float, date, <xref:datetime.time,dict>[str, FormField]<xref:,> or list[FormField]

The value for the recognized field. Its semantic data type is described by value_type. If the value is extracted from the form, but cannot be normalized to its type, then access the value_data.text property for a textual representation of the value.

confidence

float

Measures the degree of certainty of the recognition result. Value is between [0.0, 1.0].

Methods

from_dict	Converts a dict in the shape of a FormField to the model itself.
to_dict	Returns a dict representation of FormField.

from_dict

Converts a dict in the shape of a FormField to the model itself.

from_dict(data: dict) -> azure.ai.formrecognizer._models.FormField

Parameters

data

dict

Required

A dictionary in the shape of FormField.

data

Required

Returns

FormField

Return type

FormField

to_dict

Returns a dict representation of FormField.

to_dict() -> dict

Returns

dict

Return type

dict