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

Class ResponsesOutputTextAnnotationFilePath

java.lang.Object

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

com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFilePath

All Implemented Interfaces:

com.azure.json.JsonSerializable<ResponsesOutputTextAnnotation>

public final class ResponsesOutputTextAnnotationFilePath
extends ResponsesOutputTextAnnotation

The ResponsesOutputTextAnnotationFilePath model.

Constructor Summary

Constructors

Constructor	Description
ResponsesOutputTextAnnotationFilePath(String fileId, int index)	Creates an instance of ResponsesOutputTextAnnotationFilePath class.

Method Summary

Modifier and Type	Method	Description
static ResponsesOutputTextAnnotationFilePath	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ResponsesOutputTextAnnotationFilePath from the JsonReader.
String	getFileId()	Get the fileId property: The file_id property.
int	getIndex()	Get the index property: The index property.
ResponseOutputTextAnnotationType	getType()	Get the type property: The type 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

ResponsesOutputTextAnnotationFilePath

public ResponsesOutputTextAnnotationFilePath(String fileId,
 int index)

Creates an instance of ResponsesOutputTextAnnotationFilePath class.

Parameters:

fileId - the fileId value to set.

index - the index 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.

getFileId

public String getFileId()

Get the fileId property: The file_id property.

Returns:

the fileId value.

getIndex

public int getIndex()

Get the index property: The index property.

Returns:

the index 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 ResponsesOutputTextAnnotationFilePath fromJson(com.azure.json.JsonReader jsonReader)
                                                      throws IOException

Reads an instance of ResponsesOutputTextAnnotationFilePath from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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