DocumentKeyValuePair Class

An object representing a document field with distinct field label (key) and field value (may be empty).

Inheritance
builtins.object
DocumentKeyValuePair

Constructor

DocumentKeyValuePair(**kwargs)

Variables

key
DocumentKeyValueElement

Field label of the key-value pair.

value
DocumentKeyValueElement

Field value of the key-value pair.

confidence
float

Confidence of correctly extracting the key-value pair.

Methods

from_dict

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

to_dict

Returns a dict representation of DocumentKeyValuePair.

from_dict

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

from_dict(data: dict) -> azure.ai.formrecognizer._models.DocumentKeyValuePair

Parameters

data
dict
Required

A dictionary in the shape of DocumentKeyValuePair.

data
Required

Returns

DocumentKeyValuePair

Return type

to_dict

Returns a dict representation of DocumentKeyValuePair.

to_dict() -> dict

Returns

dict

Return type