Package com.azure.ai.documentintelligence.models

Class DocumentKeyValueElement

java.lang.Object

com.azure.ai.documentintelligence.models.DocumentKeyValueElement

All Implemented Interfaces:

com.azure.json.JsonSerializable<DocumentKeyValueElement>

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

An object representing the field key or value in a key-value pair.

Method Summary

Modifier and Type	Method	Description
static DocumentKeyValueElement	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of DocumentKeyValueElement from the JsonReader.
List<BoundingRegion>	getBoundingRegions()	Get the boundingRegions property: Bounding regions covering the key-value element.
String	getContent()	Get the content property: Concatenated content of the key-value element in reading order.
List<DocumentSpan>	getSpans()	Get the spans property: Location of the key-value element in the reading order concatenated content.
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

getContent

public String getContent()

Get the content property: Concatenated content of the key-value element in reading order.

Returns:

the content value.

getBoundingRegions

public List<BoundingRegion> getBoundingRegions()

Get the boundingRegions property: Bounding regions covering the key-value element.

Returns:

the boundingRegions value.

getSpans

public List<DocumentSpan> getSpans()

Get the spans property: Location of the key-value element in the reading order concatenated content.

Returns:

the spans value.

toJson

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

Specified by:

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

Throws:

IOException

fromJson

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

Reads an instance of DocumentKeyValueElement from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentKeyValueElement 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 DocumentKeyValueElement.