Share via

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

Implements

JsonSerializable<DocumentParagraph>

public final class DocumentParagraph
implements JsonSerializable<DocumentParagraph>

Paragraph in a document, generally consisting of an contiguous sequence of lines with common alignment and spacing.

Method Summary

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

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

Get the content property: Paragraph text.
SemanticRole getRole()

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

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

Get the span property: Span of the paragraph 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 DocumentParagraph fromJson(JsonReader jsonReader)

Reads an instance of DocumentParagraph from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentParagraph 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: Paragraph text.

Returns:

the content value.

getRole

public SemanticRole getRole()

Get the role property: Semantic role of the paragraph.

Returns:

the role value.

getSource

public String getSource()

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

Returns:

the source value.

getSpan

public ContentSpan getSpan()

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

Returns:

the span value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to