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

Class ResponsesResponseStreamEventResponseWebSearchCallCompleted

java.lang.Object

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

com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallCompleted

All Implemented Interfaces:

com.azure.json.JsonSerializable<ResponsesStreamEvent>

public final class ResponsesResponseStreamEventResponseWebSearchCallCompleted
extends ResponsesStreamEvent

Emitted when a web search call is completed.

Method Summary

Modifier and Type	Method	Description
static ResponsesResponseStreamEventResponseWebSearchCallCompleted	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ResponsesResponseStreamEventResponseWebSearchCallCompleted from the JsonReader.
String	getItemId()	Get the itemId property: The ID of the item that this stream event applies to.
int	getOutputIndex()	Get the outputIndex property: The index of the output item within the response that this stream event applies to.
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.

getItemId

public String getItemId()

Get the itemId property: The ID of the item that this stream event applies to.

Returns:

the itemId value.

getOutputIndex

public int getOutputIndex()

Get the outputIndex property: The index of the output item within the response that this stream event applies to.

Returns:

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

Reads an instance of ResponsesResponseStreamEventResponseWebSearchCallCompleted from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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