FormSelectionMark Class

Information about the extracted selection mark.

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

Constructor

Python

FormSelectionMark(**kwargs: Any)

Methods

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

from_dict

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

Python

from_dict(data: Dict) -> FormSelectionMark

Parameters

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

Returns

Type	Description
FormSelectionMark	FormSelectionMark

to_dict

Returns a dict representation of FormSelectionMark.

Python

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.

Python

bounding_box: List[Point]

confidence

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

Python

confidence: float

kind

For FormSelectionMark, this is "selectionMark".

Python

kind: str

page_number

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

Python

page_number: int

state

"selected", "unselected".

Python

state: str

text

The text content - not returned for FormSelectionMark.

Python

text: str