fieri 0.7.0

Unofficial Rust client for OpenAI.
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

//! List and describe the various models available in the API.

use serde::{Deserialize, Serialize};

use crate::{api_resources::TokenUsage, Client, Result};

/// Response from [List Models](list) request.
#[derive(Debug, Default, Deserialize, Serialize)]
pub struct Models {
    pub data: Vec<Model>,

    pub token_usage: Option<TokenUsage>,
}

/// Response from [Retrieve a Model](retrieve) request.
#[derive(Debug, Default, Deserialize, Serialize)]
pub struct Model {
    pub id: String,
    pub object: String,
    pub created: u64,
    pub owned_by: String,
    pub permission: Vec<Permissions>,
    pub root: String,
    pub parent: Option<String>,

    pub token_usage: Option<TokenUsage>,
}

/// Types of permissions that can be applied to a model.
#[derive(Debug, Default, Deserialize, Serialize)]
pub struct Permissions {
    pub id: String,
    pub object: String,
    pub created: u64,
    pub allow_create_engine: bool,
    pub allow_sampling: bool,
    pub allow_logprobs: bool,
    pub allow_search_indices: bool,
    pub allow_view: bool,
    pub allow_fine_tuning: bool,
    pub organization: String,
    pub group: Option<String>,
    pub is_blocking: bool,
}

/// Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
///
/// Related OpenAI docs: [Retrieve a Model](https://beta.openai.com/docs/api-reference/models/retrieve)
///
/// ## Example:
/// ```no_run
/// use fieri::{Client, model::retrieve};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
///     let client = Client::new();
///     let resp = retrieve(&client, "text-babbage-001").await?;
///     println!("{:#?}", resp);
///
///     Ok(())
/// }
/// ```
pub async fn retrieve(client: &Client, model: impl Into<String>) -> Result<Model> {
    client.retrieve(model.into()).await
}

/// Lists the currently available models, and provides basic information about each one.
///
/// Related OpenAI docs: [List Models](https://beta.openai.com/docs/api-reference/models/list)
///
/// ## Example
/// ```no_run
/// use fieri::{Client, model::list};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
///     let client = Client::new();
///     let resp = list(&client).await?;
///     println!("{:#?}", resp);
///
///     Ok(())
/// }
/// ```
pub async fn list(client: &Client) -> Result<Models> {
    client.list().await
}

impl Client {
    async fn retrieve(&self, model: String) -> Result<Model> {
        self.get::<(), Model>(&format!("models/{model}"), None)
            .await
    }

    async fn list(&self) -> Result<Models> {
        self.get::<(), Models>("models", None).await
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_model_list() {
        let resp: Models = serde_json::from_str(
            r#"
            {
                "data": [
                  {
                    "id": "model-id-0",
                    "object": "model",
                    "created": 1623155849,
                    "owned_by": "organization-owner",
                    "permission": [],
                    "root": "model-id-1"
                  },
                  {
                    "id": "model-id-1",
                    "object": "model",
                    "created": 11,
                    "owned_by": "organization-owner",
                    "permission": [],
                    "root": "model-id-0"
                  },
                  {
                    "id": "model-id-2",
                    "object": "model",
                    "created": 1234567890,
                    "owned_by": "openai",
                    "permission": [],
                    "root": "model-id-2"
                  }
                ],
                "object": "list"
              }              
            "#,
        )
        .unwrap();

        assert_eq!(resp.data.len(), 3);
        assert_eq!(resp.data[0].id, "model-id-0");
        assert!(resp.token_usage.is_none());
    }

    #[test]
    fn test_model_retrieve() {
        let resp: Model = serde_json::from_str(
            r#"
            {
                "id": "text-davinci-003",
                "object": "model",
                "created": 1623155849,
                "owned_by": "openai",
                "permission": [],
                "root": "text-davinci-003"
              }              
            "#,
        )
        .unwrap();

        assert_eq!(resp.id, "text-davinci-003");
        assert!(resp.token_usage.is_none());
    }
}