DocumentFormula Class

A formula object.

Inheritance

builtins.object

DocumentFormula

Constructor

DocumentFormula(**kwargs: Any)

Methods

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

from_dict

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

from_dict(data: Dict[str, Any]) -> DocumentFormula

Parameters

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

Returns

Type	Description
DocumentFormula	DocumentFormula

to_dict

Returns a dict representation of DocumentFormula.

to_dict() -> Dict[str, Any]

Returns

Type	Description
Dict[str, Any]	Dict[str, Any]

Attributes

confidence

Confidence of correctly extracting the formula.

confidence: float

kind

Formula kind. Known values are "inline", "display".

kind: Literal['inline', 'display']

polygon

Bounding polygon of the formula.

polygon: Sequence[Point]

span

Location of the formula in the reading order concatenated content.

span: DocumentSpan

value

LaTex expression describing the formula.

value: str