Freigeben über

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

Implements

JsonSerializable<DocumentCaption>

public final class DocumentCaption
implements JsonSerializable<DocumentCaption>

Caption of a table or figure.

Method Summary

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

Reads an instance of DocumentCaption from the JsonReader.
String getContent()

Get the content property: Content of the caption.
List<String> getElements()

Get the elements property: Child elements of the caption.
String getSource()

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

Get the span property: Span of the caption 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

Method Details

fromJson

public static DocumentCaption fromJson(JsonReader jsonReader)

Reads an instance of DocumentCaption from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getContent

public String getContent()

Get the content property: Content of the caption.

Returns:

the content value.

getElements

public List<String> getElements()

Get the elements property: Child elements of the caption.

Returns:

the elements value.

getSource

public String getSource()

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

Returns:

the source value.

getSpan

public ContentSpan getSpan()

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

Returns:

the span value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to