openai-oxide 0.13.0

Idiomatic Rust client for the OpenAI API — 1:1 parity with the official Python SDK
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

// Models resource — client.models().list() / retrieve() / delete()

use crate::client::OpenAI;
use crate::error::OpenAIError;
use crate::types::model::{Model, ModelDeleted, ModelList};

/// Access model endpoints.
///
/// API reference: <https://platform.openai.com/docs/api-reference/models>
pub struct Models<'a> {
    client: &'a OpenAI,
}

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

    /// List available models.
    ///
    /// `GET /models`
    pub async fn list(&self) -> Result<ModelList, OpenAIError> {
        self.client.get("/models").await
    }

    /// Retrieve a model by ID.
    ///
    /// `GET /models/{model}`
    pub async fn retrieve(&self, model: &str) -> Result<Model, OpenAIError> {
        self.client.get(&format!("/models/{model}")).await
    }

    /// Delete a fine-tuned model.
    ///
    /// `DELETE /models/{model}`
    pub async fn delete(&self, model: &str) -> Result<ModelDeleted, OpenAIError> {
        self.client.delete(&format!("/models/{model}")).await
    }
}

#[cfg(test)]
mod tests {
    use crate::OpenAI;
    use crate::config::ClientConfig;

    #[tokio::test]
    async fn test_models_list() {
        let mut server = mockito::Server::new_async().await;
        let mock = server
            .mock("GET", "/models")
            .match_header("authorization", "Bearer sk-test")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(
                r#"{
                    "object": "list",
                    "data": [
                        {"id": "gpt-4o", "object": "model", "created": 1687882411, "owned_by": "openai"},
                        {"id": "gpt-3.5-turbo", "object": "model", "created": 1677610602, "owned_by": "openai"}
                    ]
                }"#,
            )
            .create_async()
            .await;

        let client = OpenAI::with_config(ClientConfig::new("sk-test").base_url(server.url()));
        let response = client.models().list().await.unwrap();
        assert_eq!(response.data.len(), 2);
        assert_eq!(response.data[0].id, "gpt-4o");
        mock.assert_async().await;
    }

    #[tokio::test]
    async fn test_models_retrieve() {
        let mut server = mockito::Server::new_async().await;
        let mock = server
            .mock("GET", "/models/gpt-4o")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(
                r#"{"id": "gpt-4o", "object": "model", "created": 1687882411, "owned_by": "openai"}"#,
            )
            .create_async()
            .await;

        let client = OpenAI::with_config(ClientConfig::new("sk-test").base_url(server.url()));
        let model = client.models().retrieve("gpt-4o").await.unwrap();
        assert_eq!(model.id, "gpt-4o");
        assert_eq!(model.owned_by, "openai");
        mock.assert_async().await;
    }

    #[tokio::test]
    async fn test_models_delete() {
        let mut server = mockito::Server::new_async().await;
        let mock = server
            .mock("DELETE", "/models/ft:gpt-4o:org:custom:id")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(r#"{"id": "ft:gpt-4o:org:custom:id", "object": "model", "deleted": true}"#)
            .create_async()
            .await;

        let client = OpenAI::with_config(ClientConfig::new("sk-test").base_url(server.url()));
        let resp = client
            .models()
            .delete("ft:gpt-4o:org:custom:id")
            .await
            .unwrap();
        assert!(resp.deleted);
        mock.assert_async().await;
    }
}