Package com.azure.ai.documentintelligence.models

Class DocumentFormula

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentFormula
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentFormula>
public final class DocumentFormula extends Object implements com.azure.json.JsonSerializable<DocumentFormula>
A formula object.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DocumentFormula
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of DocumentFormula from the JsonReader.
    double
    getConfidence()
    Get the confidence property: Confidence of correctly extracting the formula.
    DocumentFormulaKind
    getKind()
    Get the kind property: Formula kind.
    List<Double>
    getPolygon()
    Get the polygon property: Bounding polygon of the formula, with coordinates specified relative to the top-left of the page.
    DocumentSpan
    getSpan()
    Get the span property: Location of the formula in the reading order concatenated content.
    String
    getValue()
    Get the value property: LaTex expression describing the formula.
    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

    • getKind

      public DocumentFormulaKind getKind()
      Get the kind property: Formula kind.
      Returns:
      the kind value.

    • getValue

      public String getValue()
      Get the value property: LaTex expression describing the formula.
      Returns:
      the value value.

    • getPolygon

      public List<Double> getPolygon()
      Get the polygon property: Bounding polygon of the formula, 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 formula in the reading order concatenated content.
      Returns:
      the span value.

    • getConfidence

      public double getConfidence()
      Get the confidence property: Confidence of correctly extracting the formula.
      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<DocumentFormula>
      Throws:
      IOException

    • fromJson

      public static DocumentFormula fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DocumentFormula from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DocumentFormula 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 DocumentFormula.