DocumentPage Class

Content and layout elements extracted from a page of the input.

Inheritance

builtins.object

DocumentPage

Constructor

DocumentPage(**kwargs)

Variables

kind

str

Kind of document page. Known values are: "document", "sheet", "slide", "image".

page_number

int

1-based page number in the input document.

angle

float

The general orientation of the content in clockwise direction, measured in degrees between (-180, 180].

width

float

The width of the image/PDF in pixels/inches, respectively.

height

float

The height of the image/PDF in pixels/inches, respectively.

unit

str

The unit used by the width, height, and bounding box properties. For images, the unit is "pixel". For PDF, the unit is "inch". Possible values include: "pixel", "inch".

spans

list[DocumentSpan]

Location of the page in the reading order concatenated content.

words

list[DocumentWord]

Extracted words from the page.

selection_marks

list[DocumentSelectionMark]

Extracted selection marks from the page.

lines

list[DocumentLine]

Extracted lines from the page, potentially containing both textual and visual elements.

Methods

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

from_dict

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

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

Parameters

data

dict

Required

A dictionary in the shape of DocumentPage.

data

Required

Returns

DocumentPage

Return type

DocumentPage

to_dict

Returns a dict representation of DocumentPage.

to_dict() -> dict

Returns

dict

Return type

dict