DocumentWord Class

Package:

com.azure.ai.formrecognizer.documentanalysis.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.9

• java.lang.Object
• • com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord

public final class 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.

Constructor Summary

Constructor	Description
DocumentWord()	Creates a DocumentWord object.

Method Summary

Modifier and Type	Method and Description
List<Point>	getBoundingPolygon() Get the list of coordinates of the bounding polygon for the word.
float	getConfidence() Get the confidence property: Confidence of correctly extracting the word.
String	getContent() Get the content property: Text content of the word.
DocumentSpan	getSpan() Get the span property: Location of the word in the reading order concatenated content.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentWord

public DocumentWord()

Creates a DocumentWord object.

Method Details

getBoundingPolygon

public List getBoundingPolygon()

Get the list of coordinates of the bounding polygon for the word. 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 boundingPolygon value.

getConfidence

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

getSpan

public DocumentSpan getSpan()

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

Returns:

the span value.