Package com.azure.ai.openai.models

Class AzureGroundingEnhancementLine

java.lang.Object

com.azure.ai.openai.models.AzureGroundingEnhancementLine

All Implemented Interfaces:

com.azure.json.JsonSerializable<AzureGroundingEnhancementLine>

public final class AzureGroundingEnhancementLine
extends Object
implements com.azure.json.JsonSerializable<AzureGroundingEnhancementLine>

A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.

Method Summary

Modifier and Type	Method	Description
static AzureGroundingEnhancementLine	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of AzureGroundingEnhancementLine from the JsonReader.
List<AzureGroundingEnhancementLineSpan>	getSpans()	Get the spans property: An array of spans that represent detected objects and its bounding box information.
String	getText()	Get the text property: The text within the line.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getText

public String getText()

Get the text property: The text within the line.

Returns:

the text value.

getSpans

public List<AzureGroundingEnhancementLineSpan> getSpans()

Get the spans property: An array of spans that represent detected objects and its bounding box information.

Returns:

the spans value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<AzureGroundingEnhancementLine>

Throws:

IOException

fromJson

public static AzureGroundingEnhancementLine fromJson(com.azure.json.JsonReader jsonReader)
                                              throws IOException

Reads an instance of AzureGroundingEnhancementLine from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureGroundingEnhancementLine if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

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

IOException - If an error occurs while reading the AzureGroundingEnhancementLine.