DocumentField Class

An object representing the content and location of a document field value.

Inheritance

builtins.object

DocumentField

Constructor

DocumentField(**kwargs)

Variables

value_type

str

The type of value found on DocumentField. Possible types include: "string", "date", "time", "phoneNumber", "float", "integer", "selectionMark", "countryRegion", "signature", "currency", "list", "dictionary".

value

str, int, float, date, <xref:datetime.time,azure.ai.formrecognizer.CurrencyValue>, <xref:azure.ai.formrecognizer.AddressValue,dict>[str, DocumentField]<xref:,> or list[DocumentField]

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

content

str

The field's content.

bounding_regions

list[BoundingRegion]

Bounding regions covering the field.

spans

list[DocumentSpan]

Location of the field in the reading order concatenated content.

confidence

float

The confidence of correctly extracting the field.

Methods

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

from_dict

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

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

Parameters

data

dict

Required

A dictionary in the shape of DocumentField.

data

Required

Returns

DocumentField

Return type

DocumentField

to_dict

Returns a dict representation of DocumentField.

to_dict() -> dict

Returns

dict

Return type

dict