Package com.azure.ai.documentintelligence.models

Class DocumentKeyValuePair

java.lang.Object

com.azure.ai.documentintelligence.models.DocumentKeyValuePair

All Implemented Interfaces:

com.azure.json.JsonSerializable<DocumentKeyValuePair>

public final class DocumentKeyValuePair
extends Object
implements com.azure.json.JsonSerializable<DocumentKeyValuePair>

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

Method Summary

Modifier and Type	Method	Description
static DocumentKeyValuePair	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of DocumentKeyValuePair from the JsonReader.
double	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.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

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 double getConfidence()

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

Returns:

the confidence value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<DocumentKeyValuePair>

Throws:

IOException

fromJson

public static DocumentKeyValuePair fromJson(com.azure.json.JsonReader jsonReader)
                                     throws IOException

Reads an instance of DocumentKeyValuePair from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentKeyValuePair if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the DocumentKeyValuePair.