DocumentKeyValueElement Class

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

Inheritance

builtins.object

DocumentKeyValueElement

Constructor

DocumentKeyValueElement(**kwargs)

Variables

content

str

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

bounding_regions

list[BoundingRegion]

Bounding regions covering the key-value element.

spans

list[DocumentSpan]

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

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) -> azure.ai.formrecognizer._models.DocumentKeyValueElement

Parameters

data

dict

Required

A dictionary in the shape of DocumentKeyValueElement.

data

Required

Returns

DocumentKeyValueElement

Return type

DocumentKeyValueElement

to_dict

Returns a dict representation of DocumentKeyValueElement.

to_dict() -> dict

Returns

dict

Return type

dict