Package com.azure.ai.openai.responses.models

Class ResponsesOutputTextAnnotationUrlCitation

java.lang.Object

com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotation

com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationUrlCitation

All Implemented Interfaces:

com.azure.json.JsonSerializable<ResponsesOutputTextAnnotation>

public final class ResponsesOutputTextAnnotationUrlCitation
extends ResponsesOutputTextAnnotation

The ResponsesOutputTextAnnotationUrlCitation model.

Constructor Summary

Constructors

Constructor	Description
ResponsesOutputTextAnnotationUrlCitation(String url, String title, int startIndex, int endIndex)	Creates an instance of ResponsesOutputTextAnnotationUrlCitation class.

Method Summary

Modifier and Type	Method	Description
static ResponsesOutputTextAnnotationUrlCitation	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ResponsesOutputTextAnnotationUrlCitation from the JsonReader.
int	getEndIndex()	Get the endIndex property: The end_index property.
int	getStartIndex()	Get the startIndex property: The start_index property.
String	getTitle()	Get the title property: The title property.
ResponseOutputTextAnnotationType	getType()	Get the type property: The type property.
String	getUrl()	Get the url property: The url property.
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

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

ResponsesOutputTextAnnotationUrlCitation

public ResponsesOutputTextAnnotationUrlCitation(String url,
 String title,
 int startIndex,
 int endIndex)

Creates an instance of ResponsesOutputTextAnnotationUrlCitation class.

Parameters:

url - the url value to set.

title - the title value to set.

startIndex - the startIndex value to set.

endIndex - the endIndex value to set.

Method Details

getType

public ResponseOutputTextAnnotationType getType()

Get the type property: The type property.

Overrides:

getType in class ResponsesOutputTextAnnotation

Returns:

the type value.

getUrl

public String getUrl()

Get the url property: The url property.

Returns:

the url value.

getTitle

public String getTitle()

Get the title property: The title property.

Returns:

the title value.

getStartIndex

public int getStartIndex()

Get the startIndex property: The start_index property.

Returns:

the startIndex value.

getEndIndex

public int getEndIndex()

Get the endIndex property: The end_index property.

Returns:

the endIndex value.

toJson

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

Specified by:

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

Overrides:

toJson in class ResponsesOutputTextAnnotation

Throws:

IOException

fromJson

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

Reads an instance of ResponsesOutputTextAnnotationUrlCitation from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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