open_ai_rust 1.1.1

Idiomatic Rust SDK for the OpenAI API: chat, responses, embeddings, audio, images, moderations, files, batches, vector stores, fine-tuning. Builder payloads, typed function-call schemas, streaming, per-request retries/timeouts.
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use std::pin::Pin;

use futures_core::Stream;

use crate::client::Client;
use crate::error::Result;
use crate::logoi::input::payload::ChatPayLoad;
use crate::logoi::output::stream::ChatCompletionChunk;
use crate::logoi::output::AiMsgResponse;

/// Accessor for the Chat Completions API (`/chat/completions`).
///
/// Obtained via [`Client::chat`].
pub struct Chat<'a> {
    client: &'a Client,
}

impl<'a> Chat<'a> {
    pub(crate) fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// `POST /chat/completions` — create a chat completion.
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(level = "debug", skip_all, fields(endpoint = "chat.completions", model = %payload.model))
    )]
    pub async fn create(&self, payload: ChatPayLoad) -> Result<AiMsgResponse> {
        super::post_json(self.client, "/chat/completions", &payload).await
    }

    /// Streaming variant — sets `stream: true` and returns an SSE stream of [`ChatCompletionChunk`]s.
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(level = "debug", skip_all, fields(endpoint = "chat.completions.stream", model = %payload.model))
    )]
    pub async fn create_stream(
        &self,
        mut payload: ChatPayLoad,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<ChatCompletionChunk>> + Send>>> {
        payload.stream = Some(true);
        let body = serde_json::to_value(&payload)?;
        super::stream::post_sse_stream(self.client, "/chat/completions", body).await
    }

    /// Mirror the official SDK shape: `client.chat().completions().create(...)`.
    /// Equivalent to [`Self::create`] / [`Self::create_stream`] directly on [`Chat`].
    pub fn completions(&self) -> Completions<'a> {
        Completions {
            client: self.client,
        }
    }
}

/// Alias for [`Chat`] that mirrors `client.chat.completions` in the official OpenAI SDK.
pub struct Completions<'a> {
    client: &'a Client,
}

impl<'a> Completions<'a> {
    /// `POST /chat/completions` — see [`Chat::create`].
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(level = "debug", skip_all, fields(endpoint = "chat.completions", model = %payload.model))
    )]
    pub async fn create(&self, payload: ChatPayLoad) -> Result<AiMsgResponse> {
        super::post_json(self.client, "/chat/completions", &payload).await
    }

    /// Streaming variant — see [`Chat::create_stream`].
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(level = "debug", skip_all, fields(endpoint = "chat.completions.stream", model = %payload.model))
    )]
    pub async fn create_stream(
        &self,
        mut payload: ChatPayLoad,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<ChatCompletionChunk>> + Send>>> {
        payload.stream = Some(true);
        let body = serde_json::to_value(&payload)?;
        super::stream::post_sse_stream(self.client, "/chat/completions", body).await
    }
}