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

Class ResponsesStreamEventCompleted

java.lang.Object

com.azure.ai.openai.responses.models.ResponsesStreamEvent

com.azure.ai.openai.responses.models.ResponsesStreamEventCompleted

All Implemented Interfaces:

com.azure.json.JsonSerializable<ResponsesStreamEvent>

public final class ResponsesStreamEventCompleted
extends ResponsesStreamEvent

Returned when a Response is done streaming. Always emitted, no matter the final state. The Response object included in the `response.completed` event will include all output Items in the Response but will omit the raw audio data.

Method Summary

Modifier and Type	Method	Description
static ResponsesStreamEventCompleted	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ResponsesStreamEventCompleted from the JsonReader.
ResponsesResponse	getResponse()	Get the response property: The completed response.
ResponsesStreamEventType	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

Method Details

getType

public ResponsesStreamEventType getType()

Get the type property: The type property.

Overrides:

getType in class ResponsesStreamEvent

Returns:

the type value.

getResponse

public ResponsesResponse getResponse()

Get the response property: The completed response.

Returns:

the response value.

toJson

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

Specified by:

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

Overrides:

toJson in class ResponsesStreamEvent

Throws:

IOException

fromJson

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

Reads an instance of ResponsesStreamEventCompleted from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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