FormPage Class

Represents a page recognized from the input document. Contains lines, words, selection marks, tables and page metadata.

New in version v2.1: selection_marks property, support for to_dict and from_dict methods

Inheritance

builtins.object

FormPage

Constructor

FormPage(**kwargs: Any)

Methods

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

from_dict

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

from_dict(data: Dict) -> FormPage

Parameters

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

Returns

Type	Description
FormPage	FormPage

to_dict

Returns a dict representation of FormPage.

to_dict() -> Dict

Returns

Type	Description
dict	dict

Attributes

height

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

height: float

lines

When include_field_elements is set to true, a list of recognized text lines is returned. For calls to recognize content, this list is always populated. The maximum number of lines returned is 300 per page. The lines are sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order. The reading order of lines can be specified by the reading_order keyword argument (Note: reading_order only supported in begin_recognize_content and begin_recognize_content_from_url).

lines: List[FormLine]

page_number

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

page_number: int

selection_marks

List of selection marks extracted from the page.

selection_marks: List[FormSelectionMark]

tables

A list of extracted tables contained in a page.

tables: List[FormTable]

text_angle

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

text_angle: float

unit

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

unit: str

width

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

width: float