DocumentWord Class

A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word.

Inheritance

azure.ai.formrecognizer._models.DocumentContentElement

DocumentWord

Constructor

DocumentWord(**kwargs)

Variables

content

str

Text content of the word.

polygon

list[Point]

Bounding polygon of the word.

span

DocumentSpan

Location of the word in the reading order concatenated content.

confidence

float

Confidence of correctly extracting the word.

kind

str

For DocumentWord, this is "word".

Methods

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

from_dict

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

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

Parameters

data

dict

Required

A dictionary in the shape of DocumentWord.

data

Required

Returns

DocumentWord

Return type

DocumentWord

to_dict

Returns a dict representation of DocumentWord.

to_dict() -> dict

Returns

dict

Return type

dict