1use anyhow::{anyhow, Result};
2use async_trait::async_trait;
3use futures::AsyncReadExt;
4use gpui::BackgroundExecutor;
5use gpui::{serde_json, AppContext};
6use isahc::http::StatusCode;
7use isahc::prelude::Configurable;
8use isahc::{AsyncBody, Response};
9use lazy_static::lazy_static;
10use parking_lot::{Mutex, RwLock};
11use parse_duration::parse;
12use postage::watch;
13use serde::{Deserialize, Serialize};
14use std::env;
15use std::ops::Add;
16use std::sync::Arc;
17use std::time::{Duration, Instant};
18use tiktoken_rs::{cl100k_base, CoreBPE};
19use util::http::{HttpClient, Request};
20use util::ResultExt;
21
22use crate::auth::{CredentialProvider, ProviderCredential};
23use crate::embedding::{Embedding, EmbeddingProvider};
24use crate::models::LanguageModel;
25use crate::providers::open_ai::OpenAILanguageModel;
26
27use crate::providers::open_ai::OPENAI_API_URL;
28
29lazy_static! {
30 static ref OPENAI_BPE_TOKENIZER: CoreBPE = cl100k_base().unwrap();
31}
32
33#[derive(Clone)]
34pub struct OpenAIEmbeddingProvider {
35 model: OpenAILanguageModel,
36 credential: Arc<RwLock<ProviderCredential>>,
37 pub client: Arc<dyn HttpClient>,
38 pub executor: BackgroundExecutor,
39 rate_limit_count_rx: watch::Receiver<Option<Instant>>,
40 rate_limit_count_tx: Arc<Mutex<watch::Sender<Option<Instant>>>>,
41}
42
43#[derive(Serialize)]
44struct OpenAIEmbeddingRequest<'a> {
45 model: &'static str,
46 input: Vec<&'a str>,
47}
48
49#[derive(Deserialize)]
50struct OpenAIEmbeddingResponse {
51 data: Vec<OpenAIEmbedding>,
52 usage: OpenAIEmbeddingUsage,
53}
54
55#[derive(Debug, Deserialize)]
56struct OpenAIEmbedding {
57 embedding: Vec<f32>,
58 index: usize,
59 object: String,
60}
61
62#[derive(Deserialize)]
63struct OpenAIEmbeddingUsage {
64 prompt_tokens: usize,
65 total_tokens: usize,
66}
67
68impl OpenAIEmbeddingProvider {
69 pub fn new(client: Arc<dyn HttpClient>, executor: BackgroundExecutor) -> Self {
70 let (rate_limit_count_tx, rate_limit_count_rx) = watch::channel_with(None);
71 let rate_limit_count_tx = Arc::new(Mutex::new(rate_limit_count_tx));
72
73 let model = OpenAILanguageModel::load("text-embedding-ada-002");
74 let credential = Arc::new(RwLock::new(ProviderCredential::NoCredentials));
75
76 OpenAIEmbeddingProvider {
77 model,
78 credential,
79 client,
80 executor,
81 rate_limit_count_rx,
82 rate_limit_count_tx,
83 }
84 }
85
86 fn get_api_key(&self) -> Result<String> {
87 match self.credential.read().clone() {
88 ProviderCredential::Credentials { api_key } => Ok(api_key),
89 _ => Err(anyhow!("api credentials not provided")),
90 }
91 }
92
93 fn resolve_rate_limit(&self) {
94 let reset_time = *self.rate_limit_count_tx.lock().borrow();
95
96 if let Some(reset_time) = reset_time {
97 if Instant::now() >= reset_time {
98 *self.rate_limit_count_tx.lock().borrow_mut() = None
99 }
100 }
101
102 log::trace!(
103 "resolving reset time: {:?}",
104 *self.rate_limit_count_tx.lock().borrow()
105 );
106 }
107
108 fn update_reset_time(&self, reset_time: Instant) {
109 let original_time = *self.rate_limit_count_tx.lock().borrow();
110
111 let updated_time = if let Some(original_time) = original_time {
112 if reset_time < original_time {
113 Some(reset_time)
114 } else {
115 Some(original_time)
116 }
117 } else {
118 Some(reset_time)
119 };
120
121 log::trace!("updating rate limit time: {:?}", updated_time);
122
123 *self.rate_limit_count_tx.lock().borrow_mut() = updated_time;
124 }
125 async fn send_request(
126 &self,
127 api_key: &str,
128 spans: Vec<&str>,
129 request_timeout: u64,
130 ) -> Result<Response<AsyncBody>> {
131 let request = Request::post("https://api.openai.com/v1/embeddings")
132 .redirect_policy(isahc::config::RedirectPolicy::Follow)
133 .timeout(Duration::from_secs(request_timeout))
134 .header("Content-Type", "application/json")
135 .header("Authorization", format!("Bearer {}", api_key))
136 .body(
137 serde_json::to_string(&OpenAIEmbeddingRequest {
138 input: spans.clone(),
139 model: "text-embedding-ada-002",
140 })
141 .unwrap()
142 .into(),
143 )?;
144
145 Ok(self.client.send(request).await?)
146 }
147}
148
149impl CredentialProvider for OpenAIEmbeddingProvider {
150 fn has_credentials(&self) -> bool {
151 match *self.credential.read() {
152 ProviderCredential::Credentials { .. } => true,
153 _ => false,
154 }
155 }
156 fn retrieve_credentials(&self, cx: &mut AppContext) -> ProviderCredential {
157 let existing_credential = self.credential.read().clone();
158
159 let retrieved_credential = match existing_credential {
160 ProviderCredential::Credentials { .. } => existing_credential.clone(),
161 _ => {
162 if let Some(api_key) = env::var("OPENAI_API_KEY").log_err() {
163 ProviderCredential::Credentials { api_key }
164 } else if let Some(Some((_, api_key))) =
165 cx.read_credentials(OPENAI_API_URL).log_err()
166 {
167 if let Some(api_key) = String::from_utf8(api_key).log_err() {
168 ProviderCredential::Credentials { api_key }
169 } else {
170 ProviderCredential::NoCredentials
171 }
172 } else {
173 ProviderCredential::NoCredentials
174 }
175 }
176 };
177
178 *self.credential.write() = retrieved_credential.clone();
179 retrieved_credential
180 }
181
182 fn save_credentials(&self, cx: &mut AppContext, credential: ProviderCredential) {
183 *self.credential.write() = credential.clone();
184 match credential {
185 ProviderCredential::Credentials { api_key } => {
186 cx.write_credentials(OPENAI_API_URL, "Bearer", api_key.as_bytes())
187 .log_err();
188 }
189 _ => {}
190 }
191 }
192
193 fn delete_credentials(&self, cx: &mut AppContext) {
194 cx.delete_credentials(OPENAI_API_URL).log_err();
195 *self.credential.write() = ProviderCredential::NoCredentials;
196 }
197}
198
199#[async_trait]
200impl EmbeddingProvider for OpenAIEmbeddingProvider {
201 fn base_model(&self) -> Box<dyn LanguageModel> {
202 let model: Box<dyn LanguageModel> = Box::new(self.model.clone());
203 model
204 }
205
206 fn max_tokens_per_batch(&self) -> usize {
207 50000
208 }
209
210 fn rate_limit_expiration(&self) -> Option<Instant> {
211 *self.rate_limit_count_rx.borrow()
212 }
213
214 async fn embed_batch(&self, spans: Vec<String>) -> Result<Vec<Embedding>> {
215 const BACKOFF_SECONDS: [usize; 4] = [3, 5, 15, 45];
216 const MAX_RETRIES: usize = 4;
217
218 let api_key = self.get_api_key()?;
219
220 let mut request_number = 0;
221 let mut rate_limiting = false;
222 let mut request_timeout: u64 = 15;
223 let mut response: Response<AsyncBody>;
224 while request_number < MAX_RETRIES {
225 response = self
226 .send_request(
227 &api_key,
228 spans.iter().map(|x| &**x).collect(),
229 request_timeout,
230 )
231 .await?;
232
233 request_number += 1;
234
235 match response.status() {
236 StatusCode::REQUEST_TIMEOUT => {
237 request_timeout += 5;
238 }
239 StatusCode::OK => {
240 let mut body = String::new();
241 response.body_mut().read_to_string(&mut body).await?;
242 let response: OpenAIEmbeddingResponse = serde_json::from_str(&body)?;
243
244 log::trace!(
245 "openai embedding completed. tokens: {:?}",
246 response.usage.total_tokens
247 );
248
249 // If we complete a request successfully that was previously rate_limited
250 // resolve the rate limit
251 if rate_limiting {
252 self.resolve_rate_limit()
253 }
254
255 return Ok(response
256 .data
257 .into_iter()
258 .map(|embedding| Embedding::from(embedding.embedding))
259 .collect());
260 }
261 StatusCode::TOO_MANY_REQUESTS => {
262 rate_limiting = true;
263 let mut body = String::new();
264 response.body_mut().read_to_string(&mut body).await?;
265
266 let delay_duration = {
267 let delay = Duration::from_secs(BACKOFF_SECONDS[request_number - 1] as u64);
268 if let Some(time_to_reset) =
269 response.headers().get("x-ratelimit-reset-tokens")
270 {
271 if let Ok(time_str) = time_to_reset.to_str() {
272 parse(time_str).unwrap_or(delay)
273 } else {
274 delay
275 }
276 } else {
277 delay
278 }
279 };
280
281 // If we've previously rate limited, increment the duration but not the count
282 let reset_time = Instant::now().add(delay_duration);
283 self.update_reset_time(reset_time);
284
285 log::trace!(
286 "openai rate limiting: waiting {:?} until lifted",
287 &delay_duration
288 );
289
290 self.executor.timer(delay_duration).await;
291 }
292 _ => {
293 let mut body = String::new();
294 response.body_mut().read_to_string(&mut body).await?;
295 return Err(anyhow!(
296 "open ai bad request: {:?} {:?}",
297 &response.status(),
298 body
299 ));
300 }
301 }
302 }
303 Err(anyhow!("openai max retries"))
304 }
305}