Struct ResponsesWebSocketSession 

pub struct ResponsesWebSocketSession<T = Client> { /* private fields */ }

Available on non-target_family=wasm only.

A stateful OpenAI Responses WebSocket session.

This session keeps track of the most recent successful response.id so later turns can automatically chain via previous_response_id unless the request explicitly sets a different one.

Call ResponsesWebSocketSession::close when you are finished with the session so the websocket can complete a close handshake cleanly.

Implementations

impl<T> ResponsesWebSocketSession<T>

where T: HttpClientExt + Clone + Debug + Default + WasmCompatSend + WasmCompatSync + 'static,

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

Returns the most recent successful response.id tracked by this session.

pub fn clear_previous_response_id(&mut self)

Clears the cached previous_response_id so the next turn starts a fresh chain.

pub async fn send( &mut self, completion_request: CompletionRequest, ) -> Result<(), CompletionError>

Sends a response.create event for a Rig completion request.

pub async fn send_with_options( &mut self, completion_request: CompletionRequest, options: ResponsesWebSocketCreateOptions, ) -> Result<(), CompletionError>

Sends a response.create event with explicit websocket-mode options.

pub async fn next_event( &mut self, ) -> Result<ResponsesWebSocketEvent, CompletionError>

Reads the next server event for the current in-flight turn.

pub async fn warmup( &mut self, completion_request: CompletionRequest, ) -> Result<String, CompletionError>

Sends a warmup turn (generate: false) and returns the resulting response ID.

pub async fn completion( &mut self, completion_request: CompletionRequest, ) -> Result<CompletionResponse<CompletionResponse>, CompletionError>

Sends a completion turn and collects the final OpenAI response.

pub async fn close(&mut self) -> Result<(), CompletionError>

Closes the websocket connection.

Call this when you are finished with the session so the websocket can terminate with a clean close handshake.

Trait Implementations

impl<T> Drop for ResponsesWebSocketSession<T>

fn drop(&mut self)

Executes the destructor for this type.