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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
//! Models API client.
use super::{map_api_error, Client};
use crate::builders::models::{ModelDeleteBuilder, ModelRetrievalBuilder};
use crate::errors::Result;
use crate::interceptor::{AfterResponseContext, BeforeRequestContext, ErrorContext};
use crate::semantic_conventions::operation_names;
use crate::time::Instant;
use crate::Error;
use openai_client_base::apis::models_api;
use openai_client_base::models::{DeleteModelResponse, ListModelsResponse, Model};
/// Client for models API.
#[derive(Debug, Clone, Copy)]
pub struct ModelsClient<'a, T = ()> {
pub(super) client: &'a Client<T>,
}
impl_interceptor_helpers!(ModelsClient<'_, T>);
impl<T: Default + crate::MaybeSend + crate::MaybeSync> ModelsClient<'_, T> {
/// List all available models.
///
/// # Example
///
/// ```rust,no_run
/// use openai_ergonomic::Client;
///
/// # async fn example() -> openai_ergonomic::Result<()> {
/// let client = Client::from_env()?.build();
/// let models = client.models().list().await?;
/// println!("Available models: {}", models.data.len());
/// # Ok(())
/// # }
/// ```
pub async fn list(&self) -> Result<ListModelsResponse> {
// Prepare interceptor context
let mut state = T::default();
let operation = operation_names::MODEL_LIST;
let model = "models";
let request_json = "{}".to_string();
// Call before_request hook
self.call_before_request(operation, model, &request_json, &mut state)
.await?;
let start_time = Instant::now();
// Make the API call
let response = match models_api::list_models()
.configuration(&self.client.base_configuration)
.call()
.await
{
Ok(resp) => resp,
Err(e) => {
let error = self
.handle_api_error(e, operation, model, &request_json, &state)
.await;
return Err(error);
}
};
let duration = start_time.elapsed();
// Call after_response hook
self.call_after_response(
&response,
operation,
model,
&request_json,
&state,
duration,
None,
None,
)
.await;
Ok(response)
}
/// Retrieve information about a specific model.
///
/// # Example
///
/// ```rust,no_run
/// use openai_ergonomic::Client;
///
/// # async fn example() -> openai_ergonomic::Result<()> {
/// let client = Client::from_env()?.build();
/// let model = client.models().get("gpt-4").await?;
/// println!("Model ID: {}", model.id);
/// # Ok(())
/// # }
/// ```
pub async fn get(&self, model_id: impl Into<String>) -> Result<Model> {
let id = model_id.into();
// Prepare interceptor context
let mut state = T::default();
let operation = operation_names::MODEL_RETRIEVE;
let model = "models";
let request_json = format!("{{\"model_id\":\"{id}\"}}");
// Call before_request hook
self.call_before_request(operation, model, &request_json, &mut state)
.await?;
let start_time = Instant::now();
// Make the API call
let response = match models_api::retrieve_model()
.configuration(&self.client.base_configuration)
.model(&id)
.call()
.await
{
Ok(resp) => resp,
Err(e) => {
let error = self
.handle_api_error(e, operation, model, &request_json, &state)
.await;
return Err(error);
}
};
let duration = start_time.elapsed();
// Call after_response hook
self.call_after_response(
&response,
operation,
model,
&request_json,
&state,
duration,
None,
None,
)
.await;
Ok(response)
}
/// Retrieve information about a model using a builder.
pub async fn retrieve(&self, builder: ModelRetrievalBuilder) -> Result<Model> {
self.get(builder.model_id()).await
}
/// Delete a fine-tuned model.
///
/// You must have the Owner role in your organization to delete a model.
///
/// # Example
///
/// ```rust,no_run
/// use openai_ergonomic::Client;
///
/// # async fn example() -> openai_ergonomic::Result<()> {
/// let client = Client::from_env()?.build();
/// let response = client.models().delete("ft:gpt-3.5-turbo:my-org:custom:id").await?;
/// println!("Deleted: {}", response.deleted);
/// # Ok(())
/// # }
/// ```
pub async fn delete(&self, model_id: impl Into<String>) -> Result<DeleteModelResponse> {
let id = model_id.into();
// Prepare interceptor context
let mut state = T::default();
let operation = operation_names::MODEL_DELETE;
let model = "models";
let request_json = format!("{{\"model_id\":\"{id}\"}}");
// Call before_request hook
self.call_before_request(operation, model, &request_json, &mut state)
.await?;
let start_time = Instant::now();
// Make the API call
let response = match models_api::delete_model()
.configuration(&self.client.base_configuration)
.model(&id)
.call()
.await
{
Ok(resp) => resp,
Err(e) => {
let error = self
.handle_api_error(e, operation, model, &request_json, &state)
.await;
return Err(error);
}
};
let duration = start_time.elapsed();
// Call after_response hook
self.call_after_response(
&response,
operation,
model,
&request_json,
&state,
duration,
None,
None,
)
.await;
Ok(response)
}
/// Delete a fine-tuned model using a builder.
pub async fn remove(&self, builder: ModelDeleteBuilder) -> Result<DeleteModelResponse> {
self.delete(builder.model_id()).await
}
}