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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

use std::pin::Pin;

use futures_core::Stream;

use crate::client::Client;
use crate::error::{OpenAiError, Result};
use crate::responses::output::ResponseObject;
use crate::responses::request::ResponseRequest;
use crate::responses::stream::ResponseStreamEvent;

/// Accessor for the Responses API. Obtained via [`Client::responses`].
pub struct Responses<'a> {
    client: &'a Client,
}

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

    /// `POST /responses` — create a new stateful response. Use
    /// [`ResponseRequestBuilder`](crate::responses::ResponseRequestBuilder) to construct the
    /// request body.
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(level = "debug", skip_all, fields(endpoint = "responses.create"))
    )]
    pub async fn create(&self, req: ResponseRequest) -> Result<ResponseObject> {
        crate::resources::post_json(self.client, "/responses", &req).await
    }

    /// Streaming variant — sets `stream: true` and yields typed [`ResponseStreamEvent`]
    /// variants, one per server-sent event.
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(
            level = "debug",
            skip_all,
            fields(endpoint = "responses.create_stream")
        )
    )]
    pub async fn create_stream(
        &self,
        mut req: ResponseRequest,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<ResponseStreamEvent>> + Send>>> {
        req.stream = Some(true);
        let body = serde_json::to_value(&req)?;
        crate::resources::stream::post_sse_stream(self.client, "/responses", body).await
    }

    /// `GET /responses/{id}` — fetch a previously-created response. Only works when the
    /// originating call had `store: true` (the default for the Responses API).
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(level = "debug", skip_all, fields(endpoint = "responses.retrieve"))
    )]
    pub async fn retrieve(&self, id: &str) -> Result<ResponseObject> {
        let url = self.client.build_url(&format!("/responses/{}", id))?;
        let resp = self
            .client
            .http()
            .get(url)
            .headers(self.client.auth_headers())
            .send()
            .await?;
        let status = resp.status();
        let body = resp.text().await?;
        if !status.is_success() {
            return Err(OpenAiError::from_response_body(status.as_u16(), &body));
        }
        Ok(serde_json::from_str(&body)?)
    }

    /// `DELETE /responses/{id}` — permanently remove a stored response.
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(level = "debug", skip_all, fields(endpoint = "responses.delete"))
    )]
    pub async fn delete(&self, id: &str) -> Result<()> {
        let url = self.client.build_url(&format!("/responses/{}", id))?;
        let resp = self
            .client
            .http()
            .delete(url)
            .headers(self.client.auth_headers())
            .send()
            .await?;
        let status = resp.status();
        if !status.is_success() {
            let body = resp.text().await.unwrap_or_default();
            return Err(OpenAiError::from_response_body(status.as_u16(), &body));
        }
        Ok(())
    }

    /// `POST /responses/{id}/cancel` — cancel a still-running response (e.g. one issued
    /// async with `background: true`). In-flight tool calls may still complete.
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(level = "debug", skip_all, fields(endpoint = "responses.cancel"))
    )]
    pub async fn cancel(&self, id: &str) -> Result<ResponseObject> {
        let url = self
            .client
            .build_url(&format!("/responses/{}/cancel", id))?;
        let resp = self
            .client
            .http()
            .post(url)
            .headers(self.client.auth_headers())
            .send()
            .await?;
        let status = resp.status();
        let body = resp.text().await?;
        if !status.is_success() {
            return Err(OpenAiError::from_response_body(status.as_u16(), &body));
        }
        Ok(serde_json::from_str(&body)?)
    }
}