Condividi tramite

DocumentKeyValueElement 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.DocumentKeyValueElement

Implements

JsonSerializable<DocumentKeyValueElement>

public final class DocumentKeyValueElement
implements JsonSerializable<DocumentKeyValueElement>

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

Method Summary

Modifier and Type Method and Description
static DocumentKeyValueElement fromJson(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.
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 DocumentKeyValueElement fromJson(JsonReader jsonReader)

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:

IOException

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

getBoundingRegions

public List getBoundingRegions()

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

Returns:

the boundingRegions value.

getContent

public String getContent()

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

Returns:

the content value.

getSpans

public List getSpans()

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

Returns:

the spans value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to