Package com.azure.ai.formrecognizer.documentanalysis.models

Class DocumentKeyValuePair

java.lang.Object

com.azure.ai.formrecognizer.documentanalysis.models.DocumentKeyValuePair

public final class DocumentKeyValuePair
extends Object

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

Constructor Summary

Constructors

Constructor	Description
DocumentKeyValuePair()

Method Summary

Modifier and Type	Method	Description
float	getConfidence()	Get the confidence property: Confidence of correctly extracting the key-value pair.
DocumentKeyValueElement	getKey()	Get the key property: Field label of the key-value pair.
DocumentKeyValueElement	getValue()	Get the value property: Field value of the key-value pair.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentKeyValuePair

public DocumentKeyValuePair()

Method Details

getKey

public DocumentKeyValueElement getKey()

Get the key property: Field label of the key-value pair.

Returns:

the key value.

getValue

public DocumentKeyValueElement getValue()

Get the value property: Field value of the key-value pair.

Returns:

the value value.

getConfidence

public float getConfidence()

Get the confidence property: Confidence of correctly extracting the key-value pair.

Returns:

the confidence value.