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

Class ResponsesStreamEvent

java.lang.Object

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

All Implemented Interfaces:

com.azure.json.JsonSerializable<ResponsesStreamEvent>

Direct Known Subclasses:

ResponsesResponseStreamEventResponseWebSearchCallCompleted, ResponsesResponseStreamEventResponseWebSearchCallInProgress, ResponsesResponseStreamEventResponseWebSearchCallSearching, ResponsesStreamEventCompleted, ResponsesStreamEventContentPartAdded, ResponsesStreamEventContentPartDone, ResponsesStreamEventCreated, ResponsesStreamEventError, ResponsesStreamEventFailed, ResponsesStreamEventFileSearchCallCompleted, ResponsesStreamEventFileSearchCallInProgress, ResponsesStreamEventFileSearchCallSearching, ResponsesStreamEventFunctionCallArgumentsDelta, ResponsesStreamEventFunctionCallArgumentsDone, ResponsesStreamEventIncomplete, ResponsesStreamEventInProgress, ResponsesStreamEventOutputItemAdded, ResponsesStreamEventOutputItemDone, ResponsesStreamEventOutputTextAnnotationAdded, ResponsesStreamEventOutputTextDelta, ResponsesStreamEventOutputTextDone, ResponsesStreamEventRefusalDelta, ResponsesStreamEventRefusalDone

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

The ResponsesStreamEvent model.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResponsesStreamEvent()	Creates an instance of ResponsesStreamEvent class.

Method Summary

Modifier and Type	Method	Description
static ResponsesStreamEvent	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ResponsesStreamEvent from the JsonReader.
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

Constructor Details

ResponsesStreamEvent

protected ResponsesStreamEvent()

Creates an instance of ResponsesStreamEvent class.

Method Details

getType

public ResponsesStreamEventType getType()

Get the type property: The type property.

Returns:

the type 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>

Throws:

IOException

fromJson

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

Reads an instance of ResponsesStreamEvent from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException - If an error occurs while reading the ResponsesStreamEvent.