DocumentKeyValuePair Class

Package:

com.azure.ai.formrecognizer.documentanalysis.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.9

• java.lang.Object
• • com.azure.ai.formrecognizer.documentanalysis.models.DocumentKeyValuePair

public final class DocumentKeyValuePair

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

Constructor Summary

Constructor	Description
DocumentKeyValuePair()	Constructs a DocumentKeyValuePair object.

Method Summary

Modifier and Type	Method and 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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentKeyValuePair

public DocumentKeyValuePair()

Constructs a DocumentKeyValuePair object.

Method Details

getConfidence

public float getConfidence()

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

Returns:

the confidence value.

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.