1use anyhow::{Context as _, Result, anyhow};
2use collections::{BTreeMap, HashMap};
3use credentials_provider::CredentialsProvider;
4use editor::{Editor, EditorElement, EditorStyle};
5use futures::Stream;
6use futures::{FutureExt, StreamExt, future::BoxFuture};
7use gpui::{
8 AnyView, App, AsyncApp, Context, Entity, FontStyle, Subscription, Task, TextStyle, WhiteSpace,
9};
10use http_client::HttpClient;
11use language_model::{
12 AuthenticateError, LanguageModel, LanguageModelCompletionEvent, LanguageModelId,
13 LanguageModelName, LanguageModelProvider, LanguageModelProviderId, LanguageModelProviderName,
14 LanguageModelProviderState, LanguageModelRequest, LanguageModelToolUse, MessageContent,
15 RateLimiter, Role, StopReason,
16};
17use open_ai::{Model, ResponseStreamEvent, stream_completion};
18use schemars::JsonSchema;
19use serde::{Deserialize, Serialize};
20use settings::{Settings, SettingsStore};
21use std::pin::Pin;
22use std::str::FromStr as _;
23use std::sync::Arc;
24use strum::IntoEnumIterator;
25use theme::ThemeSettings;
26use ui::{Icon, IconName, List, Tooltip, prelude::*};
27use util::{ResultExt, maybe};
28
29use crate::{AllLanguageModelSettings, ui::InstructionListItem};
30
31const PROVIDER_ID: &str = "openai";
32const PROVIDER_NAME: &str = "OpenAI";
33
34#[derive(Default, Clone, Debug, PartialEq)]
35pub struct OpenAiSettings {
36 pub api_url: String,
37 pub available_models: Vec<AvailableModel>,
38 pub needs_setting_migration: bool,
39}
40
41#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema)]
42pub struct AvailableModel {
43 pub name: String,
44 pub display_name: Option<String>,
45 pub max_tokens: usize,
46 pub max_output_tokens: Option<u32>,
47 pub max_completion_tokens: Option<u32>,
48}
49
50pub struct OpenAiLanguageModelProvider {
51 http_client: Arc<dyn HttpClient>,
52 state: gpui::Entity<State>,
53}
54
55pub struct State {
56 api_key: Option<String>,
57 api_key_from_env: bool,
58 _subscription: Subscription,
59}
60
61const OPENAI_API_KEY_VAR: &str = "OPENAI_API_KEY";
62
63impl State {
64 fn is_authenticated(&self) -> bool {
65 self.api_key.is_some()
66 }
67
68 fn reset_api_key(&self, cx: &mut Context<Self>) -> Task<Result<()>> {
69 let credentials_provider = <dyn CredentialsProvider>::global(cx);
70 let api_url = AllLanguageModelSettings::get_global(cx)
71 .openai
72 .api_url
73 .clone();
74 cx.spawn(async move |this, cx| {
75 credentials_provider
76 .delete_credentials(&api_url, &cx)
77 .await
78 .log_err();
79 this.update(cx, |this, cx| {
80 this.api_key = None;
81 this.api_key_from_env = false;
82 cx.notify();
83 })
84 })
85 }
86
87 fn set_api_key(&mut self, api_key: String, cx: &mut Context<Self>) -> Task<Result<()>> {
88 let credentials_provider = <dyn CredentialsProvider>::global(cx);
89 let api_url = AllLanguageModelSettings::get_global(cx)
90 .openai
91 .api_url
92 .clone();
93 cx.spawn(async move |this, cx| {
94 credentials_provider
95 .write_credentials(&api_url, "Bearer", api_key.as_bytes(), &cx)
96 .await
97 .log_err();
98 this.update(cx, |this, cx| {
99 this.api_key = Some(api_key);
100 cx.notify();
101 })
102 })
103 }
104
105 fn authenticate(&self, cx: &mut Context<Self>) -> Task<Result<(), AuthenticateError>> {
106 if self.is_authenticated() {
107 return Task::ready(Ok(()));
108 }
109
110 let credentials_provider = <dyn CredentialsProvider>::global(cx);
111 let api_url = AllLanguageModelSettings::get_global(cx)
112 .openai
113 .api_url
114 .clone();
115 cx.spawn(async move |this, cx| {
116 let (api_key, from_env) = if let Ok(api_key) = std::env::var(OPENAI_API_KEY_VAR) {
117 (api_key, true)
118 } else {
119 let (_, api_key) = credentials_provider
120 .read_credentials(&api_url, &cx)
121 .await?
122 .ok_or(AuthenticateError::CredentialsNotFound)?;
123 (
124 String::from_utf8(api_key).context("invalid {PROVIDER_NAME} API key")?,
125 false,
126 )
127 };
128 this.update(cx, |this, cx| {
129 this.api_key = Some(api_key);
130 this.api_key_from_env = from_env;
131 cx.notify();
132 })?;
133
134 Ok(())
135 })
136 }
137}
138
139impl OpenAiLanguageModelProvider {
140 pub fn new(http_client: Arc<dyn HttpClient>, cx: &mut App) -> Self {
141 let state = cx.new(|cx| State {
142 api_key: None,
143 api_key_from_env: false,
144 _subscription: cx.observe_global::<SettingsStore>(|_this: &mut State, cx| {
145 cx.notify();
146 }),
147 });
148
149 Self { http_client, state }
150 }
151}
152
153impl LanguageModelProviderState for OpenAiLanguageModelProvider {
154 type ObservableEntity = State;
155
156 fn observable_entity(&self) -> Option<gpui::Entity<Self::ObservableEntity>> {
157 Some(self.state.clone())
158 }
159}
160
161impl LanguageModelProvider for OpenAiLanguageModelProvider {
162 fn id(&self) -> LanguageModelProviderId {
163 LanguageModelProviderId(PROVIDER_ID.into())
164 }
165
166 fn name(&self) -> LanguageModelProviderName {
167 LanguageModelProviderName(PROVIDER_NAME.into())
168 }
169
170 fn icon(&self) -> IconName {
171 IconName::AiOpenAi
172 }
173
174 fn default_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
175 let model = open_ai::Model::default();
176 Some(Arc::new(OpenAiLanguageModel {
177 id: LanguageModelId::from(model.id().to_string()),
178 model,
179 state: self.state.clone(),
180 http_client: self.http_client.clone(),
181 request_limiter: RateLimiter::new(4),
182 }))
183 }
184
185 fn provided_models(&self, cx: &App) -> Vec<Arc<dyn LanguageModel>> {
186 let mut models = BTreeMap::default();
187
188 // Add base models from open_ai::Model::iter()
189 for model in open_ai::Model::iter() {
190 if !matches!(model, open_ai::Model::Custom { .. }) {
191 models.insert(model.id().to_string(), model);
192 }
193 }
194
195 // Override with available models from settings
196 for model in &AllLanguageModelSettings::get_global(cx)
197 .openai
198 .available_models
199 {
200 models.insert(
201 model.name.clone(),
202 open_ai::Model::Custom {
203 name: model.name.clone(),
204 display_name: model.display_name.clone(),
205 max_tokens: model.max_tokens,
206 max_output_tokens: model.max_output_tokens,
207 max_completion_tokens: model.max_completion_tokens,
208 },
209 );
210 }
211
212 models
213 .into_values()
214 .map(|model| {
215 Arc::new(OpenAiLanguageModel {
216 id: LanguageModelId::from(model.id().to_string()),
217 model,
218 state: self.state.clone(),
219 http_client: self.http_client.clone(),
220 request_limiter: RateLimiter::new(4),
221 }) as Arc<dyn LanguageModel>
222 })
223 .collect()
224 }
225
226 fn is_authenticated(&self, cx: &App) -> bool {
227 self.state.read(cx).is_authenticated()
228 }
229
230 fn authenticate(&self, cx: &mut App) -> Task<Result<(), AuthenticateError>> {
231 self.state.update(cx, |state, cx| state.authenticate(cx))
232 }
233
234 fn configuration_view(&self, window: &mut Window, cx: &mut App) -> AnyView {
235 cx.new(|cx| ConfigurationView::new(self.state.clone(), window, cx))
236 .into()
237 }
238
239 fn reset_credentials(&self, cx: &mut App) -> Task<Result<()>> {
240 self.state.update(cx, |state, cx| state.reset_api_key(cx))
241 }
242}
243
244pub struct OpenAiLanguageModel {
245 id: LanguageModelId,
246 model: open_ai::Model,
247 state: gpui::Entity<State>,
248 http_client: Arc<dyn HttpClient>,
249 request_limiter: RateLimiter,
250}
251
252impl OpenAiLanguageModel {
253 fn stream_completion(
254 &self,
255 request: open_ai::Request,
256 cx: &AsyncApp,
257 ) -> BoxFuture<'static, Result<futures::stream::BoxStream<'static, Result<ResponseStreamEvent>>>>
258 {
259 let http_client = self.http_client.clone();
260 let Ok((api_key, api_url)) = cx.read_entity(&self.state, |state, cx| {
261 let settings = &AllLanguageModelSettings::get_global(cx).openai;
262 (state.api_key.clone(), settings.api_url.clone())
263 }) else {
264 return futures::future::ready(Err(anyhow!("App state dropped"))).boxed();
265 };
266
267 let future = self.request_limiter.stream(async move {
268 let api_key = api_key.ok_or_else(|| anyhow!("Missing OpenAI API Key"))?;
269 let request = stream_completion(http_client.as_ref(), &api_url, &api_key, request);
270 let response = request.await?;
271 Ok(response)
272 });
273
274 async move { Ok(future.await?.boxed()) }.boxed()
275 }
276}
277
278impl LanguageModel for OpenAiLanguageModel {
279 fn id(&self) -> LanguageModelId {
280 self.id.clone()
281 }
282
283 fn name(&self) -> LanguageModelName {
284 LanguageModelName::from(self.model.display_name().to_string())
285 }
286
287 fn provider_id(&self) -> LanguageModelProviderId {
288 LanguageModelProviderId(PROVIDER_ID.into())
289 }
290
291 fn provider_name(&self) -> LanguageModelProviderName {
292 LanguageModelProviderName(PROVIDER_NAME.into())
293 }
294
295 fn supports_tools(&self) -> bool {
296 true
297 }
298
299 fn telemetry_id(&self) -> String {
300 format!("openai/{}", self.model.id())
301 }
302
303 fn max_token_count(&self) -> usize {
304 self.model.max_token_count()
305 }
306
307 fn max_output_tokens(&self) -> Option<u32> {
308 self.model.max_output_tokens()
309 }
310
311 fn count_tokens(
312 &self,
313 request: LanguageModelRequest,
314 cx: &App,
315 ) -> BoxFuture<'static, Result<usize>> {
316 count_open_ai_tokens(request, self.model.clone(), cx)
317 }
318
319 fn stream_completion(
320 &self,
321 request: LanguageModelRequest,
322 cx: &AsyncApp,
323 ) -> BoxFuture<
324 'static,
325 Result<futures::stream::BoxStream<'static, Result<LanguageModelCompletionEvent>>>,
326 > {
327 let request = into_open_ai(request, &self.model, self.max_output_tokens());
328 let completions = self.stream_completion(request, cx);
329 async move { Ok(map_to_language_model_completion_events(completions.await?).boxed()) }
330 .boxed()
331 }
332}
333
334pub fn into_open_ai(
335 request: LanguageModelRequest,
336 model: &Model,
337 max_output_tokens: Option<u32>,
338) -> open_ai::Request {
339 let stream = !model.id().starts_with("o1-");
340
341 let mut messages = Vec::new();
342 for message in request.messages {
343 for content in message.content {
344 match content {
345 MessageContent::Text(text) | MessageContent::Thinking { text, .. } => messages
346 .push(match message.role {
347 Role::User => open_ai::RequestMessage::User { content: text },
348 Role::Assistant => open_ai::RequestMessage::Assistant {
349 content: Some(text),
350 tool_calls: Vec::new(),
351 },
352 Role::System => open_ai::RequestMessage::System { content: text },
353 }),
354 MessageContent::RedactedThinking(_) => {}
355 MessageContent::Image(_) => {}
356 MessageContent::ToolUse(tool_use) => {
357 let tool_call = open_ai::ToolCall {
358 id: tool_use.id.to_string(),
359 content: open_ai::ToolCallContent::Function {
360 function: open_ai::FunctionContent {
361 name: tool_use.name.to_string(),
362 arguments: serde_json::to_string(&tool_use.input)
363 .unwrap_or_default(),
364 },
365 },
366 };
367
368 if let Some(last_assistant_message) = messages.iter_mut().rfind(|message| {
369 matches!(message, open_ai::RequestMessage::Assistant { .. })
370 }) {
371 if let open_ai::RequestMessage::Assistant { tool_calls, .. } =
372 last_assistant_message
373 {
374 tool_calls.push(tool_call);
375 }
376 } else {
377 messages.push(open_ai::RequestMessage::Assistant {
378 content: None,
379 tool_calls: vec![tool_call],
380 });
381 }
382 }
383 MessageContent::ToolResult(tool_result) => {
384 messages.push(open_ai::RequestMessage::Tool {
385 content: tool_result.content.to_string(),
386 tool_call_id: tool_result.tool_use_id.to_string(),
387 });
388 }
389 }
390 }
391 }
392
393 open_ai::Request {
394 model: model.id().into(),
395 messages,
396 stream,
397 stop: request.stop,
398 temperature: request.temperature.unwrap_or(1.0),
399 max_tokens: max_output_tokens,
400 parallel_tool_calls: if model.supports_parallel_tool_calls() && !request.tools.is_empty() {
401 // Disable parallel tool calls, as the Agent currently expects a maximum of one per turn.
402 Some(false)
403 } else {
404 None
405 },
406 tools: request
407 .tools
408 .into_iter()
409 .map(|tool| open_ai::ToolDefinition::Function {
410 function: open_ai::FunctionDefinition {
411 name: tool.name,
412 description: Some(tool.description),
413 parameters: Some(tool.input_schema),
414 },
415 })
416 .collect(),
417 tool_choice: None,
418 }
419}
420
421pub fn map_to_language_model_completion_events(
422 events: Pin<Box<dyn Send + Stream<Item = Result<ResponseStreamEvent>>>>,
423) -> impl Stream<Item = Result<LanguageModelCompletionEvent>> {
424 #[derive(Default)]
425 struct RawToolCall {
426 id: String,
427 name: String,
428 arguments: String,
429 }
430
431 struct State {
432 events: Pin<Box<dyn Send + Stream<Item = Result<ResponseStreamEvent>>>>,
433 tool_calls_by_index: HashMap<usize, RawToolCall>,
434 }
435
436 futures::stream::unfold(
437 State {
438 events,
439 tool_calls_by_index: HashMap::default(),
440 },
441 |mut state| async move {
442 if let Some(event) = state.events.next().await {
443 match event {
444 Ok(event) => {
445 let Some(choice) = event.choices.first() else {
446 return Some((
447 vec![Err(anyhow!("Response contained no choices"))],
448 state,
449 ));
450 };
451
452 let mut events = Vec::new();
453 if let Some(content) = choice.delta.content.clone() {
454 events.push(Ok(LanguageModelCompletionEvent::Text(content)));
455 }
456
457 if let Some(tool_calls) = choice.delta.tool_calls.as_ref() {
458 for tool_call in tool_calls {
459 let entry = state
460 .tool_calls_by_index
461 .entry(tool_call.index)
462 .or_default();
463
464 if let Some(tool_id) = tool_call.id.clone() {
465 entry.id = tool_id;
466 }
467
468 if let Some(function) = tool_call.function.as_ref() {
469 if let Some(name) = function.name.clone() {
470 entry.name = name;
471 }
472
473 if let Some(arguments) = function.arguments.clone() {
474 entry.arguments.push_str(&arguments);
475 }
476 }
477 }
478 }
479
480 match choice.finish_reason.as_deref() {
481 Some("stop") => {
482 events.push(Ok(LanguageModelCompletionEvent::Stop(
483 StopReason::EndTurn,
484 )));
485 }
486 Some("tool_calls") => {
487 events.extend(state.tool_calls_by_index.drain().map(
488 |(_, tool_call)| {
489 maybe!({
490 Ok(LanguageModelCompletionEvent::ToolUse(
491 LanguageModelToolUse {
492 id: tool_call.id.into(),
493 name: tool_call.name.as_str().into(),
494 input: serde_json::Value::from_str(
495 &tool_call.arguments,
496 )?,
497 },
498 ))
499 })
500 },
501 ));
502
503 events.push(Ok(LanguageModelCompletionEvent::Stop(
504 StopReason::ToolUse,
505 )));
506 }
507 Some(stop_reason) => {
508 log::error!("Unexpected OpenAI stop_reason: {stop_reason:?}",);
509 events.push(Ok(LanguageModelCompletionEvent::Stop(
510 StopReason::EndTurn,
511 )));
512 }
513 None => {}
514 }
515
516 return Some((events, state));
517 }
518 Err(err) => return Some((vec![Err(err)], state)),
519 }
520 }
521
522 None
523 },
524 )
525 .flat_map(futures::stream::iter)
526}
527
528pub fn count_open_ai_tokens(
529 request: LanguageModelRequest,
530 model: open_ai::Model,
531 cx: &App,
532) -> BoxFuture<'static, Result<usize>> {
533 cx.background_spawn(async move {
534 let messages = request
535 .messages
536 .into_iter()
537 .map(|message| tiktoken_rs::ChatCompletionRequestMessage {
538 role: match message.role {
539 Role::User => "user".into(),
540 Role::Assistant => "assistant".into(),
541 Role::System => "system".into(),
542 },
543 content: Some(message.string_contents()),
544 name: None,
545 function_call: None,
546 })
547 .collect::<Vec<_>>();
548
549 match model {
550 open_ai::Model::Custom { .. }
551 | open_ai::Model::O1Mini
552 | open_ai::Model::O1
553 | open_ai::Model::O3Mini => tiktoken_rs::num_tokens_from_messages("gpt-4", &messages),
554 _ => tiktoken_rs::num_tokens_from_messages(model.id(), &messages),
555 }
556 })
557 .boxed()
558}
559
560struct ConfigurationView {
561 api_key_editor: Entity<Editor>,
562 state: gpui::Entity<State>,
563 load_credentials_task: Option<Task<()>>,
564}
565
566impl ConfigurationView {
567 fn new(state: gpui::Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
568 let api_key_editor = cx.new(|cx| {
569 let mut editor = Editor::single_line(window, cx);
570 editor.set_placeholder_text("sk-000000000000000000000000000000000000000000000000", cx);
571 editor
572 });
573
574 cx.observe(&state, |_, _, cx| {
575 cx.notify();
576 })
577 .detach();
578
579 let load_credentials_task = Some(cx.spawn_in(window, {
580 let state = state.clone();
581 async move |this, cx| {
582 if let Some(task) = state
583 .update(cx, |state, cx| state.authenticate(cx))
584 .log_err()
585 {
586 // We don't log an error, because "not signed in" is also an error.
587 let _ = task.await;
588 }
589
590 this.update(cx, |this, cx| {
591 this.load_credentials_task = None;
592 cx.notify();
593 })
594 .log_err();
595 }
596 }));
597
598 Self {
599 api_key_editor,
600 state,
601 load_credentials_task,
602 }
603 }
604
605 fn save_api_key(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
606 let api_key = self.api_key_editor.read(cx).text(cx);
607 if api_key.is_empty() {
608 return;
609 }
610
611 let state = self.state.clone();
612 cx.spawn_in(window, async move |_, cx| {
613 state
614 .update(cx, |state, cx| state.set_api_key(api_key, cx))?
615 .await
616 })
617 .detach_and_log_err(cx);
618
619 cx.notify();
620 }
621
622 fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
623 self.api_key_editor
624 .update(cx, |editor, cx| editor.set_text("", window, cx));
625
626 let state = self.state.clone();
627 cx.spawn_in(window, async move |_, cx| {
628 state.update(cx, |state, cx| state.reset_api_key(cx))?.await
629 })
630 .detach_and_log_err(cx);
631
632 cx.notify();
633 }
634
635 fn render_api_key_editor(&self, cx: &mut Context<Self>) -> impl IntoElement {
636 let settings = ThemeSettings::get_global(cx);
637 let text_style = TextStyle {
638 color: cx.theme().colors().text,
639 font_family: settings.ui_font.family.clone(),
640 font_features: settings.ui_font.features.clone(),
641 font_fallbacks: settings.ui_font.fallbacks.clone(),
642 font_size: rems(0.875).into(),
643 font_weight: settings.ui_font.weight,
644 font_style: FontStyle::Normal,
645 line_height: relative(1.3),
646 white_space: WhiteSpace::Normal,
647 ..Default::default()
648 };
649 EditorElement::new(
650 &self.api_key_editor,
651 EditorStyle {
652 background: cx.theme().colors().editor_background,
653 local_player: cx.theme().players().local(),
654 text: text_style,
655 ..Default::default()
656 },
657 )
658 }
659
660 fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
661 !self.state.read(cx).is_authenticated()
662 }
663}
664
665impl Render for ConfigurationView {
666 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
667 let env_var_set = self.state.read(cx).api_key_from_env;
668
669 if self.load_credentials_task.is_some() {
670 div().child(Label::new("Loading credentials...")).into_any()
671 } else if self.should_render_editor(cx) {
672 v_flex()
673 .size_full()
674 .on_action(cx.listener(Self::save_api_key))
675 .child(Label::new("To use Zed's assistant with OpenAI, you need to add an API key. Follow these steps:"))
676 .child(
677 List::new()
678 .child(InstructionListItem::new(
679 "Create one by visiting",
680 Some("OpenAI's console"),
681 Some("https://platform.openai.com/api-keys"),
682 ))
683 .child(InstructionListItem::text_only(
684 "Ensure your OpenAI account has credits",
685 ))
686 .child(InstructionListItem::text_only(
687 "Paste your API key below and hit enter to start using the assistant",
688 )),
689 )
690 .child(
691 h_flex()
692 .w_full()
693 .my_2()
694 .px_2()
695 .py_1()
696 .bg(cx.theme().colors().editor_background)
697 .border_1()
698 .border_color(cx.theme().colors().border)
699 .rounded_sm()
700 .child(self.render_api_key_editor(cx)),
701 )
702 .child(
703 Label::new(
704 format!("You can also assign the {OPENAI_API_KEY_VAR} environment variable and restart Zed."),
705 )
706 .size(LabelSize::Small).color(Color::Muted),
707 )
708 .child(
709 Label::new(
710 "Note that having a subscription for another service like GitHub Copilot won't work.".to_string(),
711 )
712 .size(LabelSize::Small).color(Color::Muted),
713 )
714 .into_any()
715 } else {
716 h_flex()
717 .mt_1()
718 .p_1()
719 .justify_between()
720 .rounded_md()
721 .border_1()
722 .border_color(cx.theme().colors().border)
723 .bg(cx.theme().colors().background)
724 .child(
725 h_flex()
726 .gap_1()
727 .child(Icon::new(IconName::Check).color(Color::Success))
728 .child(Label::new(if env_var_set {
729 format!("API key set in {OPENAI_API_KEY_VAR} environment variable.")
730 } else {
731 "API key configured.".to_string()
732 })),
733 )
734 .child(
735 Button::new("reset-key", "Reset Key")
736 .label_size(LabelSize::Small)
737 .icon(Some(IconName::Trash))
738 .icon_size(IconSize::Small)
739 .icon_position(IconPosition::Start)
740 .disabled(env_var_set)
741 .when(env_var_set, |this| {
742 this.tooltip(Tooltip::text(format!("To reset your API key, unset the {OPENAI_API_KEY_VAR} environment variable.")))
743 })
744 .on_click(cx.listener(|this, _, window, cx| this.reset_api_key(window, cx))),
745 )
746 .into_any()
747 }
748 }
749}