1use anyhow::Result;
2use collections::BTreeMap;
3use credentials_provider::CredentialsProvider;
4use futures::{FutureExt, StreamExt, future::BoxFuture};
5use gpui::{AnyView, App, AsyncApp, Context, Entity, SharedString, Task, Window};
6use http_client::HttpClient;
7use language_model::{
8 ApiKeyState, AuthenticateError, EnvVar, IconOrSvg, LanguageModel, LanguageModelCompletionError,
9 LanguageModelCompletionEvent, LanguageModelId, LanguageModelName, LanguageModelProvider,
10 LanguageModelProviderId, LanguageModelProviderName, LanguageModelProviderState,
11 LanguageModelRequest, LanguageModelToolChoice, OPEN_AI_PROVIDER_ID, OPEN_AI_PROVIDER_NAME,
12 RateLimiter, env_var,
13};
14use menu;
15use open_ai::{
16 OPEN_AI_API_URL, ResponseStreamEvent,
17 responses::{Request as ResponseRequest, StreamEvent as ResponsesStreamEvent, stream_response},
18 stream_completion,
19};
20use settings::{OpenAiAvailableModel as AvailableModel, Settings, SettingsStore};
21use std::sync::{Arc, LazyLock};
22use strum::IntoEnumIterator;
23use ui::{ButtonLink, ConfiguredApiCard, List, ListBulletItem, prelude::*};
24use ui_input::InputField;
25use util::ResultExt;
26
27pub use open_ai::completion::{
28 OpenAiEventMapper, OpenAiResponseEventMapper, collect_tiktoken_messages, count_open_ai_tokens,
29 into_open_ai, into_open_ai_response,
30};
31
32const PROVIDER_ID: LanguageModelProviderId = OPEN_AI_PROVIDER_ID;
33const PROVIDER_NAME: LanguageModelProviderName = OPEN_AI_PROVIDER_NAME;
34
35const API_KEY_ENV_VAR_NAME: &str = "OPENAI_API_KEY";
36static API_KEY_ENV_VAR: LazyLock<EnvVar> = env_var!(API_KEY_ENV_VAR_NAME);
37
38#[derive(Default, Clone, Debug, PartialEq)]
39pub struct OpenAiSettings {
40 pub api_url: String,
41 pub available_models: Vec<AvailableModel>,
42}
43
44pub struct OpenAiLanguageModelProvider {
45 http_client: Arc<dyn HttpClient>,
46 state: Entity<State>,
47}
48
49pub struct State {
50 api_key_state: ApiKeyState,
51 credentials_provider: Arc<dyn CredentialsProvider>,
52}
53
54impl State {
55 fn is_authenticated(&self) -> bool {
56 self.api_key_state.has_key()
57 }
58
59 fn set_api_key(&mut self, api_key: Option<String>, cx: &mut Context<Self>) -> Task<Result<()>> {
60 let credentials_provider = self.credentials_provider.clone();
61 let api_url = OpenAiLanguageModelProvider::api_url(cx);
62 self.api_key_state.store(
63 api_url,
64 api_key,
65 |this| &mut this.api_key_state,
66 credentials_provider,
67 cx,
68 )
69 }
70
71 fn authenticate(&mut self, cx: &mut Context<Self>) -> Task<Result<(), AuthenticateError>> {
72 let credentials_provider = self.credentials_provider.clone();
73 let api_url = OpenAiLanguageModelProvider::api_url(cx);
74 self.api_key_state.load_if_needed(
75 api_url,
76 |this| &mut this.api_key_state,
77 credentials_provider,
78 cx,
79 )
80 }
81}
82
83impl OpenAiLanguageModelProvider {
84 pub fn new(
85 http_client: Arc<dyn HttpClient>,
86 credentials_provider: Arc<dyn CredentialsProvider>,
87 cx: &mut App,
88 ) -> Self {
89 let state = cx.new(|cx| {
90 cx.observe_global::<SettingsStore>(|this: &mut State, cx| {
91 let credentials_provider = this.credentials_provider.clone();
92 let api_url = Self::api_url(cx);
93 this.api_key_state.handle_url_change(
94 api_url,
95 |this| &mut this.api_key_state,
96 credentials_provider,
97 cx,
98 );
99 cx.notify();
100 })
101 .detach();
102 State {
103 api_key_state: ApiKeyState::new(Self::api_url(cx), (*API_KEY_ENV_VAR).clone()),
104 credentials_provider,
105 }
106 });
107
108 Self { http_client, state }
109 }
110
111 fn create_language_model(&self, model: open_ai::Model) -> Arc<dyn LanguageModel> {
112 Arc::new(OpenAiLanguageModel {
113 id: LanguageModelId::from(model.id().to_string()),
114 model,
115 state: self.state.clone(),
116 http_client: self.http_client.clone(),
117 request_limiter: RateLimiter::new(4),
118 })
119 }
120
121 fn settings(cx: &App) -> &OpenAiSettings {
122 &crate::AllLanguageModelSettings::get_global(cx).openai
123 }
124
125 fn api_url(cx: &App) -> SharedString {
126 let api_url = &Self::settings(cx).api_url;
127 if api_url.is_empty() {
128 open_ai::OPEN_AI_API_URL.into()
129 } else {
130 SharedString::new(api_url.as_str())
131 }
132 }
133}
134
135impl LanguageModelProviderState for OpenAiLanguageModelProvider {
136 type ObservableEntity = State;
137
138 fn observable_entity(&self) -> Option<Entity<Self::ObservableEntity>> {
139 Some(self.state.clone())
140 }
141}
142
143impl LanguageModelProvider for OpenAiLanguageModelProvider {
144 fn id(&self) -> LanguageModelProviderId {
145 PROVIDER_ID
146 }
147
148 fn name(&self) -> LanguageModelProviderName {
149 PROVIDER_NAME
150 }
151
152 fn icon(&self) -> IconOrSvg {
153 IconOrSvg::Icon(IconName::AiOpenAi)
154 }
155
156 fn default_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
157 Some(self.create_language_model(open_ai::Model::default()))
158 }
159
160 fn default_fast_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
161 Some(self.create_language_model(open_ai::Model::default_fast()))
162 }
163
164 fn provided_models(&self, cx: &App) -> Vec<Arc<dyn LanguageModel>> {
165 let mut models = BTreeMap::default();
166
167 // Add base models from open_ai::Model::iter()
168 for model in open_ai::Model::iter() {
169 if !matches!(model, open_ai::Model::Custom { .. }) {
170 models.insert(model.id().to_string(), model);
171 }
172 }
173
174 // Override with available models from settings
175 for model in &OpenAiLanguageModelProvider::settings(cx).available_models {
176 models.insert(
177 model.name.clone(),
178 open_ai::Model::Custom {
179 name: model.name.clone(),
180 display_name: model.display_name.clone(),
181 max_tokens: model.max_tokens,
182 max_output_tokens: model.max_output_tokens,
183 max_completion_tokens: model.max_completion_tokens,
184 reasoning_effort: model.reasoning_effort,
185 supports_chat_completions: model.capabilities.chat_completions,
186 },
187 );
188 }
189
190 models
191 .into_values()
192 .map(|model| self.create_language_model(model))
193 .collect()
194 }
195
196 fn is_authenticated(&self, cx: &App) -> bool {
197 self.state.read(cx).is_authenticated()
198 }
199
200 fn authenticate(&self, cx: &mut App) -> Task<Result<(), AuthenticateError>> {
201 self.state.update(cx, |state, cx| state.authenticate(cx))
202 }
203
204 fn configuration_view(
205 &self,
206 _target_agent: language_model::ConfigurationViewTargetAgent,
207 window: &mut Window,
208 cx: &mut App,
209 ) -> AnyView {
210 cx.new(|cx| ConfigurationView::new(self.state.clone(), window, cx))
211 .into()
212 }
213
214 fn reset_credentials(&self, cx: &mut App) -> Task<Result<()>> {
215 self.state
216 .update(cx, |state, cx| state.set_api_key(None, cx))
217 }
218}
219
220pub struct OpenAiLanguageModel {
221 id: LanguageModelId,
222 model: open_ai::Model,
223 state: Entity<State>,
224 http_client: Arc<dyn HttpClient>,
225 request_limiter: RateLimiter,
226}
227
228impl OpenAiLanguageModel {
229 fn stream_completion(
230 &self,
231 request: open_ai::Request,
232 cx: &AsyncApp,
233 ) -> BoxFuture<'static, Result<futures::stream::BoxStream<'static, Result<ResponseStreamEvent>>>>
234 {
235 let http_client = self.http_client.clone();
236
237 let (api_key, api_url) = self.state.read_with(cx, |state, cx| {
238 let api_url = OpenAiLanguageModelProvider::api_url(cx);
239 (state.api_key_state.key(&api_url), api_url)
240 });
241
242 let future = self.request_limiter.stream(async move {
243 let provider = PROVIDER_NAME;
244 let Some(api_key) = api_key else {
245 return Err(LanguageModelCompletionError::NoApiKey { provider });
246 };
247 let request = stream_completion(
248 http_client.as_ref(),
249 provider.0.as_str(),
250 &api_url,
251 &api_key,
252 request,
253 );
254 let response = request.await?;
255 Ok(response)
256 });
257
258 async move { Ok(future.await?.boxed()) }.boxed()
259 }
260
261 fn stream_response(
262 &self,
263 request: ResponseRequest,
264 cx: &AsyncApp,
265 ) -> BoxFuture<'static, Result<futures::stream::BoxStream<'static, Result<ResponsesStreamEvent>>>>
266 {
267 let http_client = self.http_client.clone();
268
269 let (api_key, api_url) = self.state.read_with(cx, |state, cx| {
270 let api_url = OpenAiLanguageModelProvider::api_url(cx);
271 (state.api_key_state.key(&api_url), api_url)
272 });
273
274 let provider = PROVIDER_NAME;
275 let future = self.request_limiter.stream(async move {
276 let Some(api_key) = api_key else {
277 return Err(LanguageModelCompletionError::NoApiKey { provider });
278 };
279 let request = stream_response(
280 http_client.as_ref(),
281 provider.0.as_str(),
282 &api_url,
283 &api_key,
284 request,
285 vec![],
286 );
287 let response = request.await?;
288 Ok(response)
289 });
290
291 async move { Ok(future.await?.boxed()) }.boxed()
292 }
293}
294
295impl LanguageModel for OpenAiLanguageModel {
296 fn id(&self) -> LanguageModelId {
297 self.id.clone()
298 }
299
300 fn name(&self) -> LanguageModelName {
301 LanguageModelName::from(self.model.display_name().to_string())
302 }
303
304 fn provider_id(&self) -> LanguageModelProviderId {
305 PROVIDER_ID
306 }
307
308 fn provider_name(&self) -> LanguageModelProviderName {
309 PROVIDER_NAME
310 }
311
312 fn supports_tools(&self) -> bool {
313 true
314 }
315
316 fn supports_images(&self) -> bool {
317 use open_ai::Model;
318 match &self.model {
319 Model::FourOmniMini
320 | Model::FourPointOneNano
321 | Model::Five
322 | Model::FiveCodex
323 | Model::FiveMini
324 | Model::FiveNano
325 | Model::FivePointOne
326 | Model::FivePointTwo
327 | Model::FivePointTwoCodex
328 | Model::FivePointThreeCodex
329 | Model::FivePointFour
330 | Model::FivePointFourPro
331 | Model::O1
332 | Model::O3
333 | Model::O4Mini => true,
334 Model::ThreePointFiveTurbo
335 | Model::Four
336 | Model::FourTurbo
337 | Model::O3Mini
338 | Model::Custom { .. } => false,
339 }
340 }
341
342 fn supports_tool_choice(&self, choice: LanguageModelToolChoice) -> bool {
343 match choice {
344 LanguageModelToolChoice::Auto => true,
345 LanguageModelToolChoice::Any => true,
346 LanguageModelToolChoice::None => true,
347 }
348 }
349
350 fn supports_streaming_tools(&self) -> bool {
351 true
352 }
353
354 fn supports_thinking(&self) -> bool {
355 self.model.reasoning_effort().is_some()
356 }
357
358 fn supports_split_token_display(&self) -> bool {
359 true
360 }
361
362 fn telemetry_id(&self) -> String {
363 format!("openai/{}", self.model.id())
364 }
365
366 fn max_token_count(&self) -> u64 {
367 self.model.max_token_count()
368 }
369
370 fn max_output_tokens(&self) -> Option<u64> {
371 self.model.max_output_tokens()
372 }
373
374 fn count_tokens(
375 &self,
376 request: LanguageModelRequest,
377 cx: &App,
378 ) -> BoxFuture<'static, Result<u64>> {
379 let model = self.model.clone();
380 cx.background_spawn(async move { count_open_ai_tokens(request, model) })
381 .boxed()
382 }
383
384 fn stream_completion(
385 &self,
386 request: LanguageModelRequest,
387 cx: &AsyncApp,
388 ) -> BoxFuture<
389 'static,
390 Result<
391 futures::stream::BoxStream<
392 'static,
393 Result<LanguageModelCompletionEvent, LanguageModelCompletionError>,
394 >,
395 LanguageModelCompletionError,
396 >,
397 > {
398 if self.model.supports_chat_completions() {
399 let request = into_open_ai(
400 request,
401 self.model.id(),
402 self.model.supports_parallel_tool_calls(),
403 self.model.supports_prompt_cache_key(),
404 self.max_output_tokens(),
405 self.model.reasoning_effort(),
406 );
407 let completions = self.stream_completion(request, cx);
408 async move {
409 let mapper = OpenAiEventMapper::new();
410 Ok(mapper.map_stream(completions.await?).boxed())
411 }
412 .boxed()
413 } else {
414 let request = into_open_ai_response(
415 request,
416 self.model.id(),
417 self.model.supports_parallel_tool_calls(),
418 self.model.supports_prompt_cache_key(),
419 self.max_output_tokens(),
420 self.model.reasoning_effort(),
421 );
422 let completions = self.stream_response(request, cx);
423 async move {
424 let mapper = OpenAiResponseEventMapper::new();
425 Ok(mapper.map_stream(completions.await?).boxed())
426 }
427 .boxed()
428 }
429 }
430}
431
432struct ConfigurationView {
433 api_key_editor: Entity<InputField>,
434 state: Entity<State>,
435 load_credentials_task: Option<Task<()>>,
436}
437
438impl ConfigurationView {
439 fn new(state: Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
440 let api_key_editor = cx.new(|cx| {
441 InputField::new(
442 window,
443 cx,
444 "sk-000000000000000000000000000000000000000000000000",
445 )
446 });
447
448 cx.observe(&state, |_, _, cx| {
449 cx.notify();
450 })
451 .detach();
452
453 let load_credentials_task = Some(cx.spawn_in(window, {
454 let state = state.clone();
455 async move |this, cx| {
456 if let Some(task) = Some(state.update(cx, |state, cx| state.authenticate(cx))) {
457 // We don't log an error, because "not signed in" is also an error.
458 let _ = task.await;
459 }
460 this.update(cx, |this, cx| {
461 this.load_credentials_task = None;
462 cx.notify();
463 })
464 .log_err();
465 }
466 }));
467
468 Self {
469 api_key_editor,
470 state,
471 load_credentials_task,
472 }
473 }
474
475 fn save_api_key(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
476 let api_key = self.api_key_editor.read(cx).text(cx).trim().to_string();
477 if api_key.is_empty() {
478 return;
479 }
480
481 // url changes can cause the editor to be displayed again
482 self.api_key_editor
483 .update(cx, |editor, cx| editor.set_text("", window, cx));
484
485 let state = self.state.clone();
486 cx.spawn_in(window, async move |_, cx| {
487 state
488 .update(cx, |state, cx| state.set_api_key(Some(api_key), cx))
489 .await
490 })
491 .detach_and_log_err(cx);
492 }
493
494 fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
495 self.api_key_editor
496 .update(cx, |input, cx| input.set_text("", window, cx));
497
498 let state = self.state.clone();
499 cx.spawn_in(window, async move |_, cx| {
500 state
501 .update(cx, |state, cx| state.set_api_key(None, cx))
502 .await
503 })
504 .detach_and_log_err(cx);
505 }
506
507 fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
508 !self.state.read(cx).is_authenticated()
509 }
510}
511
512impl Render for ConfigurationView {
513 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
514 let env_var_set = self.state.read(cx).api_key_state.is_from_env_var();
515 let configured_card_label = if env_var_set {
516 format!("API key set in {API_KEY_ENV_VAR_NAME} environment variable")
517 } else {
518 let api_url = OpenAiLanguageModelProvider::api_url(cx);
519 if api_url == OPEN_AI_API_URL {
520 "API key configured".to_string()
521 } else {
522 format!("API key configured for {}", api_url)
523 }
524 };
525
526 let api_key_section = if self.should_render_editor(cx) {
527 v_flex()
528 .on_action(cx.listener(Self::save_api_key))
529 .child(Label::new("To use Zed's agent with OpenAI, you need to add an API key. Follow these steps:"))
530 .child(
531 List::new()
532 .child(
533 ListBulletItem::new("")
534 .child(Label::new("Create one by visiting"))
535 .child(ButtonLink::new("OpenAI's console", "https://platform.openai.com/api-keys"))
536 )
537 .child(
538 ListBulletItem::new("Ensure your OpenAI account has credits")
539 )
540 .child(
541 ListBulletItem::new("Paste your API key below and hit enter to start using the agent")
542 ),
543 )
544 .child(self.api_key_editor.clone())
545 .child(
546 Label::new(format!(
547 "You can also set the {API_KEY_ENV_VAR_NAME} environment variable and restart Zed."
548 ))
549 .size(LabelSize::Small)
550 .color(Color::Muted),
551 )
552 .child(
553 Label::new(
554 "Note that having a subscription for another service like GitHub Copilot won't work.",
555 )
556 .size(LabelSize::Small).color(Color::Muted),
557 )
558 .into_any_element()
559 } else {
560 ConfiguredApiCard::new(configured_card_label)
561 .disabled(env_var_set)
562 .on_click(cx.listener(|this, _, window, cx| this.reset_api_key(window, cx)))
563 .when(env_var_set, |this| {
564 this.tooltip_label(format!("To reset your API key, unset the {API_KEY_ENV_VAR_NAME} environment variable."))
565 })
566 .into_any_element()
567 };
568
569 let compatible_api_section = h_flex()
570 .mt_1p5()
571 .gap_0p5()
572 .flex_wrap()
573 .when(self.should_render_editor(cx), |this| {
574 this.pt_1p5()
575 .border_t_1()
576 .border_color(cx.theme().colors().border_variant)
577 })
578 .child(
579 h_flex()
580 .gap_2()
581 .child(
582 Icon::new(IconName::Info)
583 .size(IconSize::XSmall)
584 .color(Color::Muted),
585 )
586 .child(Label::new("Zed also supports OpenAI-compatible models.")),
587 )
588 .child(
589 Button::new("docs", "Learn More")
590 .end_icon(
591 Icon::new(IconName::ArrowUpRight)
592 .size(IconSize::Small)
593 .color(Color::Muted),
594 )
595 .on_click(move |_, _window, cx| {
596 cx.open_url("https://zed.dev/docs/ai/llm-providers#openai-api-compatible")
597 }),
598 );
599
600 if self.load_credentials_task.is_some() {
601 div().child(Label::new("Loading credentials…")).into_any()
602 } else {
603 v_flex()
604 .size_full()
605 .child(api_key_section)
606 .child(compatible_api_section)
607 .into_any()
608 }
609 }
610}