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