Partilhar via

DocumentKeyValuePair Class

  • Reference
Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.DocumentKeyValuePair

Implements

JsonSerializable<DocumentKeyValuePair>

public final class DocumentKeyValuePair
implements 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 and Description
static DocumentKeyValuePair fromJson(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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static DocumentKeyValuePair fromJson(JsonReader jsonReader)

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:

IOException

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

getConfidence

public double 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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to