Share via

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

Implements

JsonSerializable<DocumentFigure>

public class DocumentFigure
implements JsonSerializable<DocumentFigure>

Figure in a document.

Constructor Summary

Modifier Constructor Description
protected DocumentFigure(String id)

Creates an instance of DocumentFigure class.

Method Summary

Modifier and Type Method and Description
static DocumentFigure fromJson(JsonReader jsonReader)

Reads an instance of DocumentFigure from the JsonReader.
DocumentCaption getCaption()

Get the caption property: Figure caption.
String getDescription()

Get the description property: Description of the figure.
List<String> getElements()

Get the elements property: Child elements of the figure, excluding any caption or footnotes.
List<DocumentFootnote> getFootnotes()

Get the footnotes property: List of figure footnotes.
String getId()

Get the id property: Figure identifier.
DocumentFigureKind getKind()

Get the kind property: Figure kind.
SemanticRole getRole()

Get the role property: Semantic role of the figure.
String getSource()

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

Get the span property: Span of the figure in the markdown content.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentFigure

protected DocumentFigure(String id)

Creates an instance of DocumentFigure class.

Parameters:

id - the id value to set.

Method Details

fromJson

public static DocumentFigure fromJson(JsonReader jsonReader)

Reads an instance of DocumentFigure from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentFigure 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.

getCaption

public DocumentCaption getCaption()

Get the caption property: Figure caption.

Returns:

the caption value.

getDescription

public String getDescription()

Get the description property: Description of the figure.

Returns:

the description value.

getElements

public List<String> getElements()

Get the elements property: Child elements of the figure, excluding any caption or footnotes.

Returns:

the elements value.

getFootnotes

public List<DocumentFootnote> getFootnotes()

Get the footnotes property: List of figure footnotes.

Returns:

the footnotes value.

getId

public String getId()

Get the id property: Figure identifier.

Returns:

the id value.

getKind

public DocumentFigureKind getKind()

Get the kind property: Figure kind.

Returns:

the kind value.

getRole

public SemanticRole getRole()

Get the role property: Semantic role of the figure.

Returns:

the role value.

getSource

public String getSource()

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

Returns:

the source value.

getSpan

public ContentSpan getSpan()

Get the span property: Span of the figure in the markdown content.

Returns:

the span value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to