Struct OpenAiSocket 

pub struct OpenAiSocket { /* private fields */ }

OpenAI’s persistent Responses WebSocket transport.

Implementations

impl OpenAiSocket

pub fn new(api_key: impl Into<String>, model: impl Into<String>) -> Result<Self>

Creates the first-party Responses transport with HTTP fallback.

pub fn with_reasoning_effort(self, effort: impl Into<String>) -> Result<Self>

Selects a Responses reasoning effort.

pub fn with_web_search(self) -> Self

Enables provider-hosted live web search.

pub fn with_cached_web_search(self) -> Self

Enables provider-hosted cached-only web search.

Trait Implementations

impl Model for OpenAiSocket

fn info(&self) -> ModelInfo

Returns stable display metadata without exposing credentials.

fn supports_image_input(&self) -> bool

Reports whether this provider accepts native image input.

fn supports_realtime_voice(&self) -> bool

Reports whether this transport can negotiate a provider-owned realtime voice call.

fn start_realtime_voice( &self, request: RealtimeVoiceRequest, ) -> BoxFuture<'_, Result<RealtimeVoiceCall>>

Negotiates voice media without exposing provider credentials to the frontend.

fn prompt_cache_capability(&self) -> PromptCacheMode

Reports the provider’s prompt-cache mode without exposing transport details.

fn tool_discovery(&self) -> ToolDiscoveryMode

Reports how this route makes deferred tool schemas callable.

fn pricing(&self) -> Option<ModelPricing>

Returns current token pricing when this provider owns a known billing schedule.

fn respond<'a>( &'a self, request: ModelRequest<'a>, events: ModelEventSink, ) -> BoxFuture<'a, Result<ModelOutput>>

Produces one streamed response.

fn compaction_endpoint(&self) -> bool

Reports whether this provider exposes a native compaction endpoint.

fn compact<'a>( &'a self, request: CompactRequest<'a>, ) -> BoxFuture<'a, Result<CompactOutput>>

Calls the native history-compaction endpoint when advertised.