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, LanguageModelCompletionError, LanguageModelCompletionEvent,
13 LanguageModelId, LanguageModelName, LanguageModelProvider, LanguageModelProviderId,
14 LanguageModelProviderName, LanguageModelProviderState, LanguageModelRequest,
15 LanguageModelToolUse, MessageContent, 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;
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<
325 futures::stream::BoxStream<
326 'static,
327 Result<LanguageModelCompletionEvent, LanguageModelCompletionError>,
328 >,
329 >,
330 > {
331 let request = into_open_ai(request, &self.model, self.max_output_tokens());
332 let completions = self.stream_completion(request, cx);
333 async move {
334 let mapper = OpenAiEventMapper::new();
335 Ok(mapper.map_stream(completions.await?).boxed())
336 }
337 .boxed()
338 }
339}
340
341pub fn into_open_ai(
342 request: LanguageModelRequest,
343 model: &Model,
344 max_output_tokens: Option<u32>,
345) -> open_ai::Request {
346 let stream = !model.id().starts_with("o1-");
347
348 let mut messages = Vec::new();
349 for message in request.messages {
350 for content in message.content {
351 match content {
352 MessageContent::Text(text) | MessageContent::Thinking { text, .. } => messages
353 .push(match message.role {
354 Role::User => open_ai::RequestMessage::User { content: text },
355 Role::Assistant => open_ai::RequestMessage::Assistant {
356 content: Some(text),
357 tool_calls: Vec::new(),
358 },
359 Role::System => open_ai::RequestMessage::System { content: text },
360 }),
361 MessageContent::RedactedThinking(_) => {}
362 MessageContent::Image(_) => {}
363 MessageContent::ToolUse(tool_use) => {
364 let tool_call = open_ai::ToolCall {
365 id: tool_use.id.to_string(),
366 content: open_ai::ToolCallContent::Function {
367 function: open_ai::FunctionContent {
368 name: tool_use.name.to_string(),
369 arguments: serde_json::to_string(&tool_use.input)
370 .unwrap_or_default(),
371 },
372 },
373 };
374
375 if let Some(last_assistant_message) = messages.iter_mut().rfind(|message| {
376 matches!(message, open_ai::RequestMessage::Assistant { .. })
377 }) {
378 if let open_ai::RequestMessage::Assistant { tool_calls, .. } =
379 last_assistant_message
380 {
381 tool_calls.push(tool_call);
382 }
383 } else {
384 messages.push(open_ai::RequestMessage::Assistant {
385 content: None,
386 tool_calls: vec![tool_call],
387 });
388 }
389 }
390 MessageContent::ToolResult(tool_result) => {
391 messages.push(open_ai::RequestMessage::Tool {
392 content: tool_result.content.to_string(),
393 tool_call_id: tool_result.tool_use_id.to_string(),
394 });
395 }
396 }
397 }
398 }
399
400 open_ai::Request {
401 model: model.id().into(),
402 messages,
403 stream,
404 stop: request.stop,
405 temperature: request.temperature.unwrap_or(1.0),
406 max_tokens: max_output_tokens,
407 parallel_tool_calls: if model.supports_parallel_tool_calls() && !request.tools.is_empty() {
408 // Disable parallel tool calls, as the Agent currently expects a maximum of one per turn.
409 Some(false)
410 } else {
411 None
412 },
413 tools: request
414 .tools
415 .into_iter()
416 .map(|tool| open_ai::ToolDefinition::Function {
417 function: open_ai::FunctionDefinition {
418 name: tool.name,
419 description: Some(tool.description),
420 parameters: Some(tool.input_schema),
421 },
422 })
423 .collect(),
424 tool_choice: None,
425 }
426}
427
428pub struct OpenAiEventMapper {
429 tool_calls_by_index: HashMap<usize, RawToolCall>,
430}
431
432impl OpenAiEventMapper {
433 pub fn new() -> Self {
434 Self {
435 tool_calls_by_index: HashMap::default(),
436 }
437 }
438
439 pub fn map_stream(
440 mut self,
441 events: Pin<Box<dyn Send + Stream<Item = Result<ResponseStreamEvent>>>>,
442 ) -> impl Stream<Item = Result<LanguageModelCompletionEvent, LanguageModelCompletionError>>
443 {
444 events.flat_map(move |event| {
445 futures::stream::iter(match event {
446 Ok(event) => self.map_event(event),
447 Err(error) => vec![Err(LanguageModelCompletionError::Other(anyhow!(error)))],
448 })
449 })
450 }
451
452 pub fn map_event(
453 &mut self,
454 event: ResponseStreamEvent,
455 ) -> Vec<Result<LanguageModelCompletionEvent, LanguageModelCompletionError>> {
456 let Some(choice) = event.choices.first() else {
457 return vec![Err(LanguageModelCompletionError::Other(anyhow!(
458 "Response contained no choices"
459 )))];
460 };
461
462 let mut events = Vec::new();
463 if let Some(content) = choice.delta.content.clone() {
464 events.push(Ok(LanguageModelCompletionEvent::Text(content)));
465 }
466
467 if let Some(tool_calls) = choice.delta.tool_calls.as_ref() {
468 for tool_call in tool_calls {
469 let entry = self.tool_calls_by_index.entry(tool_call.index).or_default();
470
471 if let Some(tool_id) = tool_call.id.clone() {
472 entry.id = tool_id;
473 }
474
475 if let Some(function) = tool_call.function.as_ref() {
476 if let Some(name) = function.name.clone() {
477 entry.name = name;
478 }
479
480 if let Some(arguments) = function.arguments.clone() {
481 entry.arguments.push_str(&arguments);
482 }
483 }
484 }
485 }
486
487 match choice.finish_reason.as_deref() {
488 Some("stop") => {
489 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
490 }
491 Some("tool_calls") => {
492 events.extend(self.tool_calls_by_index.drain().map(|(_, tool_call)| {
493 match serde_json::Value::from_str(&tool_call.arguments) {
494 Ok(input) => Ok(LanguageModelCompletionEvent::ToolUse(
495 LanguageModelToolUse {
496 id: tool_call.id.clone().into(),
497 name: tool_call.name.as_str().into(),
498 is_input_complete: true,
499 input,
500 raw_input: tool_call.arguments.clone(),
501 },
502 )),
503 Err(error) => Err(LanguageModelCompletionError::BadInputJson {
504 id: tool_call.id.into(),
505 tool_name: tool_call.name.as_str().into(),
506 raw_input: tool_call.arguments.into(),
507 json_parse_error: error.to_string(),
508 }),
509 }
510 }));
511
512 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::ToolUse)));
513 }
514 Some(stop_reason) => {
515 log::error!("Unexpected OpenAI stop_reason: {stop_reason:?}",);
516 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
517 }
518 None => {}
519 }
520
521 events
522 }
523}
524
525#[derive(Default)]
526struct RawToolCall {
527 id: String,
528 name: String,
529 arguments: String,
530}
531
532pub fn count_open_ai_tokens(
533 request: LanguageModelRequest,
534 model: open_ai::Model,
535 cx: &App,
536) -> BoxFuture<'static, Result<usize>> {
537 cx.background_spawn(async move {
538 let messages = request
539 .messages
540 .into_iter()
541 .map(|message| tiktoken_rs::ChatCompletionRequestMessage {
542 role: match message.role {
543 Role::User => "user".into(),
544 Role::Assistant => "assistant".into(),
545 Role::System => "system".into(),
546 },
547 content: Some(message.string_contents()),
548 name: None,
549 function_call: None,
550 })
551 .collect::<Vec<_>>();
552
553 match model {
554 open_ai::Model::Custom { .. }
555 | open_ai::Model::O1Mini
556 | open_ai::Model::O1
557 | open_ai::Model::O3Mini => tiktoken_rs::num_tokens_from_messages("gpt-4", &messages),
558 _ => tiktoken_rs::num_tokens_from_messages(model.id(), &messages),
559 }
560 })
561 .boxed()
562}
563
564struct ConfigurationView {
565 api_key_editor: Entity<Editor>,
566 state: gpui::Entity<State>,
567 load_credentials_task: Option<Task<()>>,
568}
569
570impl ConfigurationView {
571 fn new(state: gpui::Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
572 let api_key_editor = cx.new(|cx| {
573 let mut editor = Editor::single_line(window, cx);
574 editor.set_placeholder_text("sk-000000000000000000000000000000000000000000000000", cx);
575 editor
576 });
577
578 cx.observe(&state, |_, _, cx| {
579 cx.notify();
580 })
581 .detach();
582
583 let load_credentials_task = Some(cx.spawn_in(window, {
584 let state = state.clone();
585 async move |this, cx| {
586 if let Some(task) = state
587 .update(cx, |state, cx| state.authenticate(cx))
588 .log_err()
589 {
590 // We don't log an error, because "not signed in" is also an error.
591 let _ = task.await;
592 }
593
594 this.update(cx, |this, cx| {
595 this.load_credentials_task = None;
596 cx.notify();
597 })
598 .log_err();
599 }
600 }));
601
602 Self {
603 api_key_editor,
604 state,
605 load_credentials_task,
606 }
607 }
608
609 fn save_api_key(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
610 let api_key = self.api_key_editor.read(cx).text(cx);
611 if api_key.is_empty() {
612 return;
613 }
614
615 let state = self.state.clone();
616 cx.spawn_in(window, async move |_, cx| {
617 state
618 .update(cx, |state, cx| state.set_api_key(api_key, cx))?
619 .await
620 })
621 .detach_and_log_err(cx);
622
623 cx.notify();
624 }
625
626 fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
627 self.api_key_editor
628 .update(cx, |editor, cx| editor.set_text("", window, cx));
629
630 let state = self.state.clone();
631 cx.spawn_in(window, async move |_, cx| {
632 state.update(cx, |state, cx| state.reset_api_key(cx))?.await
633 })
634 .detach_and_log_err(cx);
635
636 cx.notify();
637 }
638
639 fn render_api_key_editor(&self, cx: &mut Context<Self>) -> impl IntoElement {
640 let settings = ThemeSettings::get_global(cx);
641 let text_style = TextStyle {
642 color: cx.theme().colors().text,
643 font_family: settings.ui_font.family.clone(),
644 font_features: settings.ui_font.features.clone(),
645 font_fallbacks: settings.ui_font.fallbacks.clone(),
646 font_size: rems(0.875).into(),
647 font_weight: settings.ui_font.weight,
648 font_style: FontStyle::Normal,
649 line_height: relative(1.3),
650 white_space: WhiteSpace::Normal,
651 ..Default::default()
652 };
653 EditorElement::new(
654 &self.api_key_editor,
655 EditorStyle {
656 background: cx.theme().colors().editor_background,
657 local_player: cx.theme().players().local(),
658 text: text_style,
659 ..Default::default()
660 },
661 )
662 }
663
664 fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
665 !self.state.read(cx).is_authenticated()
666 }
667}
668
669impl Render for ConfigurationView {
670 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
671 let env_var_set = self.state.read(cx).api_key_from_env;
672
673 if self.load_credentials_task.is_some() {
674 div().child(Label::new("Loading credentials...")).into_any()
675 } else if self.should_render_editor(cx) {
676 v_flex()
677 .size_full()
678 .on_action(cx.listener(Self::save_api_key))
679 .child(Label::new("To use Zed's assistant with OpenAI, you need to add an API key. Follow these steps:"))
680 .child(
681 List::new()
682 .child(InstructionListItem::new(
683 "Create one by visiting",
684 Some("OpenAI's console"),
685 Some("https://platform.openai.com/api-keys"),
686 ))
687 .child(InstructionListItem::text_only(
688 "Ensure your OpenAI account has credits",
689 ))
690 .child(InstructionListItem::text_only(
691 "Paste your API key below and hit enter to start using the assistant",
692 )),
693 )
694 .child(
695 h_flex()
696 .w_full()
697 .my_2()
698 .px_2()
699 .py_1()
700 .bg(cx.theme().colors().editor_background)
701 .border_1()
702 .border_color(cx.theme().colors().border)
703 .rounded_sm()
704 .child(self.render_api_key_editor(cx)),
705 )
706 .child(
707 Label::new(
708 format!("You can also assign the {OPENAI_API_KEY_VAR} environment variable and restart Zed."),
709 )
710 .size(LabelSize::Small).color(Color::Muted),
711 )
712 .child(
713 Label::new(
714 "Note that having a subscription for another service like GitHub Copilot won't work.".to_string(),
715 )
716 .size(LabelSize::Small).color(Color::Muted),
717 )
718 .into_any()
719 } else {
720 h_flex()
721 .mt_1()
722 .p_1()
723 .justify_between()
724 .rounded_md()
725 .border_1()
726 .border_color(cx.theme().colors().border)
727 .bg(cx.theme().colors().background)
728 .child(
729 h_flex()
730 .gap_1()
731 .child(Icon::new(IconName::Check).color(Color::Success))
732 .child(Label::new(if env_var_set {
733 format!("API key set in {OPENAI_API_KEY_VAR} environment variable.")
734 } else {
735 "API key configured.".to_string()
736 })),
737 )
738 .child(
739 Button::new("reset-key", "Reset Key")
740 .label_size(LabelSize::Small)
741 .icon(Some(IconName::Trash))
742 .icon_size(IconSize::Small)
743 .icon_position(IconPosition::Start)
744 .disabled(env_var_set)
745 .when(env_var_set, |this| {
746 this.tooltip(Tooltip::text(format!("To reset your API key, unset the {OPENAI_API_KEY_VAR} environment variable.")))
747 })
748 .on_click(cx.listener(|this, _, window, cx| this.reset_api_key(window, cx))),
749 )
750 .into_any()
751 }
752 }
753}