DocumentKeyValueElement Class

An object representing the field key or value in a key-value pair.

Inheritance
builtins.object
DocumentKeyValueElement

Constructor

DocumentKeyValueElement(**kwargs: Any)

Methods

from_dict

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

to_dict

Returns a dict representation of DocumentKeyValueElement.

from_dict

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

from_dict(data: Dict) -> DocumentKeyValueElement

Parameters

Name Description
data
Required

A dictionary in the shape of DocumentKeyValueElement.

Returns

Type Description

DocumentKeyValueElement

to_dict

Returns a dict representation of DocumentKeyValueElement.

to_dict() -> Dict

Returns

Type Description

dict

Attributes

bounding_regions

Bounding regions covering the key-value element.

bounding_regions: List[BoundingRegion] | None

content

Concatenated content of the key-value element in reading order.

content: str

spans

Location of the key-value element in the reading order of the concatenated content.

spans: List[DocumentSpan]