Enum ResponsesWebSocketEvent 

pub enum ResponsesWebSocketEvent {
    Response(Box<ResponseChunk>),
    Item(ItemChunk),
    Error(ResponsesWebSocketErrorEvent),
    Done(ResponsesWebSocketDoneEvent),
}

Available on non-target_family=wasm only.

A server event emitted by OpenAI WebSocket mode.

Variants

Response(Box<ResponseChunk>)

A response lifecycle event such as response.created or response.completed.

Item(ItemChunk)

A streaming item/delta event such as response.output_text.delta.

Error(ResponsesWebSocketErrorEvent)

A protocol-level websocket error event.

Done(ResponsesWebSocketDoneEvent)

An optional response.done event emitted by OpenAI over WebSockets.

Implementations

impl ResponsesWebSocketEvent

pub fn response_id(&self) -> Option<&str>

Returns the response ID when the event includes one.

pub fn is_terminal(&self) -> bool

Returns true when this event ends the current in-flight websocket turn.

Trait Implementations

impl Clone for ResponsesWebSocketEvent

fn clone(&self) -> ResponsesWebSocketEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResponsesWebSocketEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.