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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
use std::pin::Pin;
use futures::{stream::StreamExt, Stream};
use reqwest::header::HeaderMap;
use reqwest_eventsource::{Event, EventSource, RequestBuilderExt};
use serde::{de::DeserializeOwned, Serialize};
use crate::{
edit::Edits,
error::{OpenAIError, WrappedError},
file::Files,
image::Images,
moderation::Moderations,
Audio, Chat, Completions, Embeddings, FineTunes, Models,
};
#[derive(Debug, Clone)]
pub struct Client {
api_key: String,
api_base: String,
org_id: String,
backoff: backoff::ExponentialBackoff,
}
pub const API_BASE: &str = "https://api.openai.com/v1";
pub const ORGANIZATION_HEADER: &str = "OpenAI-Organization";
impl Default for Client {
fn default() -> Self {
Self {
api_base: API_BASE.to_string(),
api_key: std::env::var("OPENAI_API_KEY").unwrap_or_else(|_| "".to_string()),
org_id: Default::default(),
backoff: Default::default(),
}
}
}
impl Client {
pub fn new() -> Self {
Default::default()
}
pub fn with_api_key<S: Into<String>>(mut self, api_key: S) -> Self {
self.api_key = api_key.into();
self
}
pub fn with_org_id<S: Into<String>>(mut self, org_id: S) -> Self {
self.org_id = org_id.into();
self
}
pub fn with_api_base<S: Into<String>>(mut self, api_base: S) -> Self {
self.api_base = api_base.into();
self
}
pub fn with_backoff(mut self, backoff: backoff::ExponentialBackoff) -> Self {
self.backoff = backoff;
self
}
pub fn api_base(&self) -> &str {
&self.api_base
}
pub fn api_key(&self) -> &str {
&self.api_key
}
pub fn models(&self) -> Models {
Models::new(self)
}
pub fn completions(&self) -> Completions {
Completions::new(self)
}
pub fn chat(&self) -> Chat {
Chat::new(self)
}
pub fn edits(&self) -> Edits {
Edits::new(self)
}
pub fn images(&self) -> Images {
Images::new(self)
}
pub fn moderations(&self) -> Moderations {
Moderations::new(self)
}
pub fn files(&self) -> Files {
Files::new(self)
}
pub fn fine_tunes(&self) -> FineTunes {
FineTunes::new(self)
}
pub fn embeddings(&self) -> Embeddings {
Embeddings::new(self)
}
pub fn audio(&self) -> Audio {
Audio::new(self)
}
fn headers(&self) -> HeaderMap {
let mut headers = HeaderMap::new();
if !self.org_id.is_empty() {
headers.insert(ORGANIZATION_HEADER, self.org_id.as_str().parse().unwrap());
}
headers
}
pub(crate) async fn get<O>(&self, path: &str) -> Result<O, OpenAIError>
where
O: DeserializeOwned,
{
let request = reqwest::Client::new()
.get(format!("{}{path}", self.api_base()))
.bearer_auth(self.api_key())
.headers(self.headers())
.build()?;
self.execute(request).await
}
pub(crate) async fn delete<O>(&self, path: &str) -> Result<O, OpenAIError>
where
O: DeserializeOwned,
{
let request = reqwest::Client::new()
.delete(format!("{}{path}", self.api_base()))
.bearer_auth(self.api_key())
.headers(self.headers())
.build()?;
self.execute(request).await
}
pub(crate) async fn post<I, O>(&self, path: &str, request: I) -> Result<O, OpenAIError>
where
I: Serialize,
O: DeserializeOwned,
{
let request = reqwest::Client::new()
.post(format!("{}{path}", self.api_base()))
.bearer_auth(self.api_key())
.headers(self.headers())
.json(&request)
.build()?;
self.execute(request).await
}
pub(crate) async fn post_form<O>(
&self,
path: &str,
form: reqwest::multipart::Form,
) -> Result<O, OpenAIError>
where
O: DeserializeOwned,
{
let request = reqwest::Client::new()
.post(format!("{}{path}", self.api_base()))
.bearer_auth(self.api_key())
.headers(self.headers())
.multipart(form)
.build()?;
self.execute(request).await
}
async fn process_response<O>(&self, response: reqwest::Response) -> Result<O, OpenAIError>
where
O: DeserializeOwned,
{
let status = response.status();
let bytes = response.bytes().await?;
if !status.is_success() {
let wrapped_error: WrappedError =
serde_json::from_slice(bytes.as_ref()).map_err(OpenAIError::JSONDeserialize)?;
return Err(OpenAIError::ApiError(wrapped_error.error));
}
let response: O =
serde_json::from_slice(bytes.as_ref()).map_err(OpenAIError::JSONDeserialize)?;
Ok(response)
}
async fn execute<O>(&self, request: reqwest::Request) -> Result<O, OpenAIError>
where
O: DeserializeOwned,
{
let client = reqwest::Client::new();
match request.try_clone() {
Some(request) => {
backoff::future::retry(self.backoff.clone(), || async {
let response = client
.execute(request.try_clone().unwrap())
.await
.map_err(OpenAIError::Reqwest)
.map_err(backoff::Error::Permanent)?;
let status = response.status();
let bytes = response
.bytes()
.await
.map_err(OpenAIError::Reqwest)
.map_err(backoff::Error::Permanent)?;
if !status.is_success() {
let wrapped_error: WrappedError = serde_json::from_slice(bytes.as_ref())
.map_err(OpenAIError::JSONDeserialize)
.map_err(backoff::Error::Permanent)?;
if status.as_u16() == 429
&& wrapped_error.error.r#type != "insufficient_quota"
{
tracing::warn!("Rate limited: {}", wrapped_error.error.message);
return Err(backoff::Error::Transient {
err: OpenAIError::ApiError(wrapped_error.error),
retry_after: None,
});
} else {
return Err(backoff::Error::Permanent(OpenAIError::ApiError(
wrapped_error.error,
)));
}
}
let response: O = serde_json::from_slice(bytes.as_ref())
.map_err(OpenAIError::JSONDeserialize)
.map_err(backoff::Error::Permanent)?;
Ok(response)
})
.await
}
None => {
let response = client.execute(request).await?;
self.process_response(response).await
}
}
}
pub(crate) async fn post_stream<I, O>(
&self,
path: &str,
request: I,
) -> Pin<Box<dyn Stream<Item = Result<O, OpenAIError>> + Send>>
where
I: Serialize,
O: DeserializeOwned + std::marker::Send + 'static,
{
let event_source = reqwest::Client::new()
.post(format!("{}{path}", self.api_base()))
.headers(self.headers())
.bearer_auth(self.api_key())
.json(&request)
.eventsource()
.unwrap();
Client::stream(event_source).await
}
pub(crate) async fn get_stream<Q, O>(
&self,
path: &str,
query: &Q,
) -> Pin<Box<dyn Stream<Item = Result<O, OpenAIError>> + Send>>
where
Q: Serialize + ?Sized,
O: DeserializeOwned + std::marker::Send + 'static,
{
let event_source = reqwest::Client::new()
.get(format!("{}{path}", self.api_base()))
.query(query)
.headers(self.headers())
.bearer_auth(self.api_key())
.eventsource()
.unwrap();
Client::stream(event_source).await
}
pub(crate) async fn stream<O>(
mut event_source: EventSource,
) -> Pin<Box<dyn Stream<Item = Result<O, OpenAIError>> + Send>>
where
O: DeserializeOwned + std::marker::Send + 'static,
{
let (tx, rx) = tokio::sync::mpsc::unbounded_channel();
tokio::spawn(async move {
while let Some(ev) = event_source.next().await {
match ev {
Err(e) => {
if let Err(_e) = tx.send(Err(OpenAIError::StreamError(e.to_string()))) {
break;
}
}
Ok(event) => match event {
Event::Message(message) => {
if message.data == "[DONE]" {
break;
}
let response = match serde_json::from_str::<O>(&message.data) {
Err(e) => Err(OpenAIError::JSONDeserialize(e)),
Ok(output) => Ok(output),
};
if let Err(_e) = tx.send(response) {
break;
}
}
Event::Open => continue,
},
}
}
event_source.close();
});
Box::pin(tokio_stream::wrappers::UnboundedReceiverStream::new(rx))
}
}