Struct ResponsesWebSocketSession 

pub struct ResponsesWebSocketSession { /* private fields */ }

Available on crate feature websocket only.

Sequential Responses session with automatic response-ID chaining. Completed and incomplete responses update the chain unless a request supplies its own previous_response_id. Call Self::close to perform a close handshake.

Implementations

impl ResponsesWebSocketSession

pub fn from_connection( wire: Responses, connection: BoxedWebSocketConnection, event_timeout: Option<Duration>, ) -> Self

Build a session over an already-open, authenticated connection. event_timeout: None waits indefinitely for each event.

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

Return the response ID retained for automatic chaining, if any.

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<(), ProviderError>

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

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

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

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

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

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

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

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

Sends a completion turn and collects the final OpenAI response, normalized; its raw is the provider’s own terminal response object.

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

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 Drop for ResponsesWebSocketSession

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.