Compartilhar via

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

Implements

JsonSerializable<DocumentFormula>

public final class DocumentFormula
implements JsonSerializable<DocumentFormula>

A formula object.

Method Summary

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

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:

IOException

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

getConfidence

public double getConfidence()

Get the confidence property: Confidence of correctly extracting the formula.

Returns:

the confidence value.

getKind

public DocumentFormulaKind getKind()

Get the kind property: Formula kind.

Returns:

the kind value.

getPolygon

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

getValue

public String getValue()

Get the value property: LaTex expression describing the formula.

Returns:

the value value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to