Share via

DocumentFormula Class

Package:
com.azure.ai.contentunderstanding.models
Maven Artifact:
com.azure:azure-ai-contentunderstanding:1.0.0
  • java.lang.Object
    • com.azure.ai.contentunderstanding.models.DocumentFormula

Implements

JsonSerializable<DocumentFormula>

public final class DocumentFormula
implements JsonSerializable<DocumentFormula>

Mathematical formula in a document.

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 predicting the formula.
DocumentFormulaKind getKind()

Get the kind property: Formula kind.
String getSource()

Get the source property: Encoded source that identifies the position of the formula in the content.
ContentSpan getSpan()

Get the span property: Span of the formula in the markdown 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 predicting the formula.

Returns:

the confidence value.

getKind

public DocumentFormulaKind getKind()

Get the kind property: Formula kind.

Returns:

the kind value.

getSource

public String getSource()

Get the source property: Encoded source that identifies the position of the formula in the content.

Returns:

the source value.

getSpan

public ContentSpan getSpan()

Get the span property: Span of the formula in the markdown 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