openai-core 0.1.0

Rust SDK for OpenAI-compatible ecosystem
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! WebSocket protocol models and transport implementation.

mod core;
mod events;

use crate::{Client, Result};

pub use core::*;
pub use events::*;

/// Standalone OpenAI Realtime WebSocket connector.
#[cfg(feature = "realtime")]
#[cfg_attr(docsrs, doc(cfg(feature = "realtime")))]
#[derive(Debug, Clone, Copy, Default)]
pub struct OpenAIRealtimeWebSocket;

/// Backwards-compatible alias for the standalone Realtime connector.
#[cfg(feature = "realtime")]
#[cfg_attr(docsrs, doc(cfg(feature = "realtime")))]
pub type OpenAIRealtimeWS = OpenAIRealtimeWebSocket;

#[cfg(feature = "realtime")]
impl OpenAIRealtimeWebSocket {
    /// Connect using the standalone Realtime helper.
    pub async fn connect(client: Client, model: impl Into<String>) -> Result<RealtimeSocket> {
        client.realtime().ws().model(model).connect().await
    }
}

/// Standalone OpenAI Responses WebSocket connector.
#[cfg(feature = "responses-ws")]
#[cfg_attr(docsrs, doc(cfg(feature = "responses-ws")))]
#[derive(Debug, Clone, Copy, Default)]
pub struct OpenAIResponsesWebSocket;

#[cfg(feature = "responses-ws")]
impl OpenAIResponsesWebSocket {
    /// Connect using the standalone Responses helper.
    pub async fn connect(client: Client) -> Result<ResponsesSocket> {
        client.responses().ws().connect().await
    }
}