Compartilhar via

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

Implements

JsonSerializable<DocumentWord>

public final class DocumentWord
implements JsonSerializable<DocumentWord>

A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word.

Method Summary

Modifier and Type Method and Description
static DocumentWord fromJson(JsonReader jsonReader)

Reads an instance of DocumentWord from the JsonReader.
double getConfidence()

Get the confidence property: Confidence of correctly extracting the word.
String getContent()

Get the content property: Text content of the word.
List<Double> getPolygon()

Get the polygon property: Bounding polygon of the word, with coordinates specified relative to the top-left of the page.
DocumentSpan getSpan()

Get the span property: Location of the word 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 DocumentWord fromJson(JsonReader jsonReader)

Reads an instance of DocumentWord from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Returns:

the confidence value.

getContent

public String getContent()

Get the content property: Text content of the word.

Returns:

the content value.

getPolygon

public List getPolygon()

Get the polygon property: Bounding polygon of the word, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.

Returns:

the polygon value.

getSpan

public DocumentSpan getSpan()

Get the span property: Location of the word in the reading order concatenated content.

Returns:

the span value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to