DocumentLine Class

A content line object representing the content found on a single line of the document.

Inheritance

builtins.object

DocumentLine

Constructor

DocumentLine(**kwargs)

Variables

content

str

Concatenated content of the contained elements in reading order.

polygon

list[Point]

Bounding polygon of the line.

spans

list[DocumentSpan]

Location of the line in the reading order concatenated content.

Methods

from_dict	Converts a dict in the shape of a DocumentLine to the model itself.
get_words	Get the words found in the spans of this DocumentLine.
to_dict	Returns a dict representation of DocumentLine.

from_dict

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

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

Parameters

data

dict

Required

A dictionary in the shape of DocumentLine.

data

Required

Returns

DocumentLine

Return type

DocumentLine

get_words

Get the words found in the spans of this DocumentLine.

get_words(**kwargs: Any) -> Iterable[azure.ai.formrecognizer._models.DocumentWord]

Returns

iterable[DocumentWord]

Return type

<xref:iterable>[DocumentWord]

to_dict

Returns a dict representation of DocumentLine.

to_dict() -> dict

Returns

dict

Return type

dict