FormWord Class

Represents a word recognized from the input document.

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

Inheritance

azure.ai.formrecognizer._models.FormElement

FormWord

Constructor

FormWord(**kwargs: Any)

Methods

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

from_dict

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

from_dict(data: Dict) -> FormWord

Parameters

Name	Description
data Required	dict A dictionary in the shape of FormWord.

Returns

Type	Description
FormWord	FormWord

to_dict

Returns a dict representation of FormWord.

to_dict() -> Dict

Returns

Type	Description
dict	dict

Attributes

bounding_box

A list of 4 points representing the quadrilateral bounding box that outlines the text. The points are listed in clockwise order: top-left, top-right, bottom-right, bottom-left. Units are in pixels for images and inches for PDF.

bounding_box: List[Point]

confidence

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

confidence: float

kind

For FormWord, this is "word".

kind: str

page_number

The 1-based number of the page in which this content is present.

page_number: int

text

The text content of the word.

text: str