Package com.azure.ai.documentintelligence.models

Class DocumentWord

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentWord
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentWord>
public final class DocumentWord extends Object implements com.azure.json.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
    Description
    static DocumentWord
    fromJson(com.azure.json.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.
    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: Text content of the word.
      Returns:
      the content value.

    • getPolygon

      public List<Double> 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.

    • getConfidence

      public double getConfidence()
      Get the confidence property: Confidence of correctly extracting the word.
      Returns:
      the confidence value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DocumentWord>
      Throws:
      IOException

    • fromJson

      public static DocumentWord fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the DocumentWord.