1use anyhow::{Context as _, Result, anyhow};
2use collections::{BTreeMap, HashMap};
3use credentials_provider::CredentialsProvider;
4
5use fs::Fs;
6use futures::Stream;
7use futures::{FutureExt, StreamExt, future::BoxFuture};
8use gpui::{AnyView, App, AsyncApp, Context, Entity, Subscription, Task, Window};
9use http_client::HttpClient;
10use language_model::{
11 AuthenticateError, LanguageModel, LanguageModelCompletionError, LanguageModelCompletionEvent,
12 LanguageModelId, LanguageModelName, LanguageModelProvider, LanguageModelProviderId,
13 LanguageModelProviderName, LanguageModelProviderState, LanguageModelRequest,
14 LanguageModelToolChoice, LanguageModelToolResultContent, LanguageModelToolUse, MessageContent,
15 RateLimiter, Role, StopReason, TokenUsage,
16};
17use menu;
18use open_ai::{ImageUrl, Model, ResponseStreamEvent, stream_completion};
19use schemars::JsonSchema;
20use serde::{Deserialize, Serialize};
21use settings::{Settings, SettingsStore, update_settings_file};
22use std::pin::Pin;
23use std::str::FromStr as _;
24use std::sync::Arc;
25use strum::IntoEnumIterator;
26
27use ui::{ElevationIndex, List, Tooltip, prelude::*};
28use ui_input::SingleLineInput;
29use util::ResultExt;
30
31use crate::{AllLanguageModelSettings, ui::InstructionListItem};
32
33const PROVIDER_ID: &str = "openai";
34const PROVIDER_NAME: &str = "OpenAI";
35
36#[derive(Default, Clone, Debug, PartialEq)]
37pub struct OpenAiSettings {
38 pub api_url: String,
39 pub available_models: Vec<AvailableModel>,
40 pub needs_setting_migration: bool,
41}
42
43#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema)]
44pub struct AvailableModel {
45 pub name: String,
46 pub display_name: Option<String>,
47 pub max_tokens: u64,
48 pub max_output_tokens: Option<u64>,
49 pub max_completion_tokens: Option<u64>,
50}
51
52pub struct OpenAiLanguageModelProvider {
53 http_client: Arc<dyn HttpClient>,
54 state: gpui::Entity<State>,
55}
56
57pub struct State {
58 api_key: Option<String>,
59 api_key_from_env: bool,
60 _subscription: Subscription,
61}
62
63const OPENAI_API_KEY_VAR: &str = "OPENAI_API_KEY";
64
65impl State {
66 //
67 fn is_authenticated(&self) -> bool {
68 self.api_key.is_some()
69 }
70
71 fn reset_api_key(&self, cx: &mut Context<Self>) -> Task<Result<()>> {
72 let credentials_provider = <dyn CredentialsProvider>::global(cx);
73 let api_url = AllLanguageModelSettings::get_global(cx)
74 .openai
75 .api_url
76 .clone();
77 cx.spawn(async move |this, cx| {
78 credentials_provider
79 .delete_credentials(&api_url, &cx)
80 .await
81 .log_err();
82 this.update(cx, |this, cx| {
83 this.api_key = None;
84 this.api_key_from_env = false;
85 cx.notify();
86 })
87 })
88 }
89
90 fn set_api_key(&mut self, api_key: String, cx: &mut Context<Self>) -> Task<Result<()>> {
91 let credentials_provider = <dyn CredentialsProvider>::global(cx);
92 let api_url = AllLanguageModelSettings::get_global(cx)
93 .openai
94 .api_url
95 .clone();
96 cx.spawn(async move |this, cx| {
97 credentials_provider
98 .write_credentials(&api_url, "Bearer", api_key.as_bytes(), &cx)
99 .await
100 .log_err();
101 this.update(cx, |this, cx| {
102 this.api_key = Some(api_key);
103 cx.notify();
104 })
105 })
106 }
107
108 fn authenticate(&self, cx: &mut Context<Self>) -> Task<Result<(), AuthenticateError>> {
109 if self.is_authenticated() {
110 return Task::ready(Ok(()));
111 }
112
113 let credentials_provider = <dyn CredentialsProvider>::global(cx);
114 let api_url = AllLanguageModelSettings::get_global(cx)
115 .openai
116 .api_url
117 .clone();
118 cx.spawn(async move |this, cx| {
119 let (api_key, from_env) = if let Ok(api_key) = std::env::var(OPENAI_API_KEY_VAR) {
120 (api_key, true)
121 } else {
122 let (_, api_key) = credentials_provider
123 .read_credentials(&api_url, &cx)
124 .await?
125 .ok_or(AuthenticateError::CredentialsNotFound)?;
126 (
127 String::from_utf8(api_key).context("invalid {PROVIDER_NAME} API key")?,
128 false,
129 )
130 };
131 this.update(cx, |this, cx| {
132 this.api_key = Some(api_key);
133 this.api_key_from_env = from_env;
134 cx.notify();
135 })?;
136
137 Ok(())
138 })
139 }
140}
141
142impl OpenAiLanguageModelProvider {
143 pub fn new(http_client: Arc<dyn HttpClient>, cx: &mut App) -> Self {
144 let state = cx.new(|cx| State {
145 api_key: None,
146 api_key_from_env: false,
147 _subscription: cx.observe_global::<SettingsStore>(|_this: &mut State, cx| {
148 cx.notify();
149 }),
150 });
151
152 Self { http_client, state }
153 }
154
155 fn create_language_model(&self, model: open_ai::Model) -> Arc<dyn LanguageModel> {
156 Arc::new(OpenAiLanguageModel {
157 id: LanguageModelId::from(model.id().to_string()),
158 model,
159 state: self.state.clone(),
160 http_client: self.http_client.clone(),
161 request_limiter: RateLimiter::new(4),
162 })
163 }
164}
165
166impl LanguageModelProviderState for OpenAiLanguageModelProvider {
167 type ObservableEntity = State;
168
169 fn observable_entity(&self) -> Option<gpui::Entity<Self::ObservableEntity>> {
170 Some(self.state.clone())
171 }
172}
173
174impl LanguageModelProvider for OpenAiLanguageModelProvider {
175 fn id(&self) -> LanguageModelProviderId {
176 LanguageModelProviderId(PROVIDER_ID.into())
177 }
178
179 fn name(&self) -> LanguageModelProviderName {
180 LanguageModelProviderName(PROVIDER_NAME.into())
181 }
182
183 fn icon(&self) -> IconName {
184 IconName::AiOpenAi
185 }
186
187 fn default_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
188 Some(self.create_language_model(open_ai::Model::default()))
189 }
190
191 fn default_fast_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
192 Some(self.create_language_model(open_ai::Model::default_fast()))
193 }
194
195 fn provided_models(&self, cx: &App) -> Vec<Arc<dyn LanguageModel>> {
196 let mut models = BTreeMap::default();
197
198 // Add base models from open_ai::Model::iter()
199 for model in open_ai::Model::iter() {
200 if !matches!(model, open_ai::Model::Custom { .. }) {
201 models.insert(model.id().to_string(), model);
202 }
203 }
204
205 // Override with available models from settings
206 for model in &AllLanguageModelSettings::get_global(cx)
207 .openai
208 .available_models
209 {
210 models.insert(
211 model.name.clone(),
212 open_ai::Model::Custom {
213 name: model.name.clone(),
214 display_name: model.display_name.clone(),
215 max_tokens: model.max_tokens,
216 max_output_tokens: model.max_output_tokens,
217 max_completion_tokens: model.max_completion_tokens,
218 },
219 );
220 }
221
222 models
223 .into_values()
224 .map(|model| self.create_language_model(model))
225 .collect()
226 }
227
228 fn is_authenticated(&self, cx: &App) -> bool {
229 self.state.read(cx).is_authenticated()
230 }
231
232 fn authenticate(&self, cx: &mut App) -> Task<Result<(), AuthenticateError>> {
233 self.state.update(cx, |state, cx| state.authenticate(cx))
234 }
235
236 fn configuration_view(&self, window: &mut Window, cx: &mut App) -> AnyView {
237 cx.new(|cx| ConfigurationView::new(self.state.clone(), window, cx))
238 .into()
239 }
240
241 fn reset_credentials(&self, cx: &mut App) -> Task<Result<()>> {
242 self.state.update(cx, |state, cx| state.reset_api_key(cx))
243 }
244}
245
246pub struct OpenAiLanguageModel {
247 id: LanguageModelId,
248 model: open_ai::Model,
249 state: gpui::Entity<State>,
250 http_client: Arc<dyn HttpClient>,
251 request_limiter: RateLimiter,
252}
253
254impl OpenAiLanguageModel {
255 fn stream_completion(
256 &self,
257 request: open_ai::Request,
258 cx: &AsyncApp,
259 ) -> BoxFuture<'static, Result<futures::stream::BoxStream<'static, Result<ResponseStreamEvent>>>>
260 {
261 let http_client = self.http_client.clone();
262 let Ok((api_key, api_url)) = cx.read_entity(&self.state, |state, cx| {
263 let settings = &AllLanguageModelSettings::get_global(cx).openai;
264 (state.api_key.clone(), settings.api_url.clone())
265 }) else {
266 return futures::future::ready(Err(anyhow!("App state dropped"))).boxed();
267 };
268
269 let future = self.request_limiter.stream(async move {
270 let api_key = api_key.context("Missing OpenAI API Key")?;
271 let request = stream_completion(http_client.as_ref(), &api_url, &api_key, request);
272 let response = request.await?;
273 Ok(response)
274 });
275
276 async move { Ok(future.await?.boxed()) }.boxed()
277 }
278}
279
280impl LanguageModel for OpenAiLanguageModel {
281 fn id(&self) -> LanguageModelId {
282 self.id.clone()
283 }
284
285 fn name(&self) -> LanguageModelName {
286 LanguageModelName::from(self.model.display_name().to_string())
287 }
288
289 fn provider_id(&self) -> LanguageModelProviderId {
290 LanguageModelProviderId(PROVIDER_ID.into())
291 }
292
293 fn provider_name(&self) -> LanguageModelProviderName {
294 LanguageModelProviderName(PROVIDER_NAME.into())
295 }
296
297 fn supports_tools(&self) -> bool {
298 true
299 }
300
301 fn supports_images(&self) -> bool {
302 false
303 }
304
305 fn supports_tool_choice(&self, choice: LanguageModelToolChoice) -> bool {
306 match choice {
307 LanguageModelToolChoice::Auto => true,
308 LanguageModelToolChoice::Any => true,
309 LanguageModelToolChoice::None => true,
310 }
311 }
312
313 fn telemetry_id(&self) -> String {
314 format!("openai/{}", self.model.id())
315 }
316
317 fn max_token_count(&self) -> u64 {
318 self.model.max_token_count()
319 }
320
321 fn max_output_tokens(&self) -> Option<u64> {
322 self.model.max_output_tokens()
323 }
324
325 fn count_tokens(
326 &self,
327 request: LanguageModelRequest,
328 cx: &App,
329 ) -> BoxFuture<'static, Result<u64>> {
330 count_open_ai_tokens(request, self.model.clone(), cx)
331 }
332
333 fn stream_completion(
334 &self,
335 request: LanguageModelRequest,
336 cx: &AsyncApp,
337 ) -> BoxFuture<
338 'static,
339 Result<
340 futures::stream::BoxStream<
341 'static,
342 Result<LanguageModelCompletionEvent, LanguageModelCompletionError>,
343 >,
344 LanguageModelCompletionError,
345 >,
346 > {
347 let request = into_open_ai(
348 request,
349 self.model.id(),
350 self.model.supports_parallel_tool_calls(),
351 self.max_output_tokens(),
352 );
353 let completions = self.stream_completion(request, cx);
354 async move {
355 let mapper = OpenAiEventMapper::new();
356 Ok(mapper.map_stream(completions.await?).boxed())
357 }
358 .boxed()
359 }
360}
361
362pub fn into_open_ai(
363 request: LanguageModelRequest,
364 model_id: &str,
365 supports_parallel_tool_calls: bool,
366 max_output_tokens: Option<u64>,
367) -> open_ai::Request {
368 let stream = !model_id.starts_with("o1-");
369
370 let mut messages = Vec::new();
371 for message in request.messages {
372 for content in message.content {
373 match content {
374 MessageContent::Text(text) | MessageContent::Thinking { text, .. } => {
375 add_message_content_part(
376 open_ai::MessagePart::Text { text: text },
377 message.role,
378 &mut messages,
379 )
380 }
381 MessageContent::RedactedThinking(_) => {}
382 MessageContent::Image(image) => {
383 add_message_content_part(
384 open_ai::MessagePart::Image {
385 image_url: ImageUrl {
386 url: image.to_base64_url(),
387 detail: None,
388 },
389 },
390 message.role,
391 &mut messages,
392 );
393 }
394 MessageContent::ToolUse(tool_use) => {
395 let tool_call = open_ai::ToolCall {
396 id: tool_use.id.to_string(),
397 content: open_ai::ToolCallContent::Function {
398 function: open_ai::FunctionContent {
399 name: tool_use.name.to_string(),
400 arguments: serde_json::to_string(&tool_use.input)
401 .unwrap_or_default(),
402 },
403 },
404 };
405
406 if let Some(open_ai::RequestMessage::Assistant { tool_calls, .. }) =
407 messages.last_mut()
408 {
409 tool_calls.push(tool_call);
410 } else {
411 messages.push(open_ai::RequestMessage::Assistant {
412 content: None,
413 tool_calls: vec![tool_call],
414 });
415 }
416 }
417 MessageContent::ToolResult(tool_result) => {
418 let content = match &tool_result.content {
419 LanguageModelToolResultContent::Text(text) => {
420 vec![open_ai::MessagePart::Text {
421 text: text.to_string(),
422 }]
423 }
424 LanguageModelToolResultContent::Image(image) => {
425 vec![open_ai::MessagePart::Image {
426 image_url: ImageUrl {
427 url: image.to_base64_url(),
428 detail: None,
429 },
430 }]
431 }
432 };
433
434 messages.push(open_ai::RequestMessage::Tool {
435 content: content.into(),
436 tool_call_id: tool_result.tool_use_id.to_string(),
437 });
438 }
439 }
440 }
441 }
442
443 open_ai::Request {
444 model: model_id.into(),
445 messages,
446 stream,
447 stop: request.stop,
448 temperature: request.temperature.unwrap_or(1.0),
449 max_completion_tokens: max_output_tokens,
450 parallel_tool_calls: if supports_parallel_tool_calls && !request.tools.is_empty() {
451 // Disable parallel tool calls, as the Agent currently expects a maximum of one per turn.
452 Some(false)
453 } else {
454 None
455 },
456 tools: request
457 .tools
458 .into_iter()
459 .map(|tool| open_ai::ToolDefinition::Function {
460 function: open_ai::FunctionDefinition {
461 name: tool.name,
462 description: Some(tool.description),
463 parameters: Some(tool.input_schema),
464 },
465 })
466 .collect(),
467 tool_choice: request.tool_choice.map(|choice| match choice {
468 LanguageModelToolChoice::Auto => open_ai::ToolChoice::Auto,
469 LanguageModelToolChoice::Any => open_ai::ToolChoice::Required,
470 LanguageModelToolChoice::None => open_ai::ToolChoice::None,
471 }),
472 }
473}
474
475fn add_message_content_part(
476 new_part: open_ai::MessagePart,
477 role: Role,
478 messages: &mut Vec<open_ai::RequestMessage>,
479) {
480 match (role, messages.last_mut()) {
481 (Role::User, Some(open_ai::RequestMessage::User { content }))
482 | (
483 Role::Assistant,
484 Some(open_ai::RequestMessage::Assistant {
485 content: Some(content),
486 ..
487 }),
488 )
489 | (Role::System, Some(open_ai::RequestMessage::System { content, .. })) => {
490 content.push_part(new_part);
491 }
492 _ => {
493 messages.push(match role {
494 Role::User => open_ai::RequestMessage::User {
495 content: open_ai::MessageContent::from(vec![new_part]),
496 },
497 Role::Assistant => open_ai::RequestMessage::Assistant {
498 content: Some(open_ai::MessageContent::from(vec![new_part])),
499 tool_calls: Vec::new(),
500 },
501 Role::System => open_ai::RequestMessage::System {
502 content: open_ai::MessageContent::from(vec![new_part]),
503 },
504 });
505 }
506 }
507}
508
509pub struct OpenAiEventMapper {
510 tool_calls_by_index: HashMap<usize, RawToolCall>,
511}
512
513impl OpenAiEventMapper {
514 pub fn new() -> Self {
515 Self {
516 tool_calls_by_index: HashMap::default(),
517 }
518 }
519
520 pub fn map_stream(
521 mut self,
522 events: Pin<Box<dyn Send + Stream<Item = Result<ResponseStreamEvent>>>>,
523 ) -> impl Stream<Item = Result<LanguageModelCompletionEvent, LanguageModelCompletionError>>
524 {
525 events.flat_map(move |event| {
526 futures::stream::iter(match event {
527 Ok(event) => self.map_event(event),
528 Err(error) => vec![Err(LanguageModelCompletionError::Other(anyhow!(error)))],
529 })
530 })
531 }
532
533 pub fn map_event(
534 &mut self,
535 event: ResponseStreamEvent,
536 ) -> Vec<Result<LanguageModelCompletionEvent, LanguageModelCompletionError>> {
537 let mut events = Vec::new();
538 if let Some(usage) = event.usage {
539 events.push(Ok(LanguageModelCompletionEvent::UsageUpdate(TokenUsage {
540 input_tokens: usage.prompt_tokens,
541 output_tokens: usage.completion_tokens,
542 cache_creation_input_tokens: 0,
543 cache_read_input_tokens: 0,
544 })));
545 }
546
547 let Some(choice) = event.choices.first() else {
548 return events;
549 };
550
551 if let Some(content) = choice.delta.content.clone() {
552 events.push(Ok(LanguageModelCompletionEvent::Text(content)));
553 }
554
555 if let Some(tool_calls) = choice.delta.tool_calls.as_ref() {
556 for tool_call in tool_calls {
557 let entry = self.tool_calls_by_index.entry(tool_call.index).or_default();
558
559 if let Some(tool_id) = tool_call.id.clone() {
560 entry.id = tool_id;
561 }
562
563 if let Some(function) = tool_call.function.as_ref() {
564 if let Some(name) = function.name.clone() {
565 entry.name = name;
566 }
567
568 if let Some(arguments) = function.arguments.clone() {
569 entry.arguments.push_str(&arguments);
570 }
571 }
572 }
573 }
574
575 match choice.finish_reason.as_deref() {
576 Some("stop") => {
577 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
578 }
579 Some("tool_calls") => {
580 events.extend(self.tool_calls_by_index.drain().map(|(_, tool_call)| {
581 match serde_json::Value::from_str(&tool_call.arguments) {
582 Ok(input) => Ok(LanguageModelCompletionEvent::ToolUse(
583 LanguageModelToolUse {
584 id: tool_call.id.clone().into(),
585 name: tool_call.name.as_str().into(),
586 is_input_complete: true,
587 input,
588 raw_input: tool_call.arguments.clone(),
589 },
590 )),
591 Err(error) => Err(LanguageModelCompletionError::BadInputJson {
592 id: tool_call.id.into(),
593 tool_name: tool_call.name.as_str().into(),
594 raw_input: tool_call.arguments.into(),
595 json_parse_error: error.to_string(),
596 }),
597 }
598 }));
599
600 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::ToolUse)));
601 }
602 Some(stop_reason) => {
603 log::error!("Unexpected OpenAI stop_reason: {stop_reason:?}",);
604 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
605 }
606 None => {}
607 }
608
609 events
610 }
611}
612
613#[derive(Default)]
614struct RawToolCall {
615 id: String,
616 name: String,
617 arguments: String,
618}
619
620pub fn count_open_ai_tokens(
621 request: LanguageModelRequest,
622 model: Model,
623 cx: &App,
624) -> BoxFuture<'static, Result<u64>> {
625 cx.background_spawn(async move {
626 let messages = request
627 .messages
628 .into_iter()
629 .map(|message| tiktoken_rs::ChatCompletionRequestMessage {
630 role: match message.role {
631 Role::User => "user".into(),
632 Role::Assistant => "assistant".into(),
633 Role::System => "system".into(),
634 },
635 content: Some(message.string_contents()),
636 name: None,
637 function_call: None,
638 })
639 .collect::<Vec<_>>();
640
641 match model {
642 Model::Custom { max_tokens, .. } => {
643 let model = if max_tokens >= 100_000 {
644 // If the max tokens is 100k or more, it is likely the o200k_base tokenizer from gpt4o
645 "gpt-4o"
646 } else {
647 // Otherwise fallback to gpt-4, since only cl100k_base and o200k_base are
648 // supported with this tiktoken method
649 "gpt-4"
650 };
651 tiktoken_rs::num_tokens_from_messages(model, &messages)
652 }
653 // Currently supported by tiktoken_rs
654 // Sometimes tiktoken-rs is behind on model support. If that is the case, make a new branch
655 // arm with an override. We enumerate all supported models here so that we can check if new
656 // models are supported yet or not.
657 Model::ThreePointFiveTurbo
658 | Model::Four
659 | Model::FourTurbo
660 | Model::FourOmni
661 | Model::FourOmniMini
662 | Model::FourPointOne
663 | Model::FourPointOneMini
664 | Model::FourPointOneNano
665 | Model::O1
666 | Model::O3
667 | Model::O3Mini
668 | Model::O4Mini => tiktoken_rs::num_tokens_from_messages(model.id(), &messages),
669 }
670 .map(|tokens| tokens as u64)
671 })
672 .boxed()
673}
674
675struct ConfigurationView {
676 api_key_editor: Entity<SingleLineInput>,
677 api_url_editor: Entity<SingleLineInput>,
678 state: gpui::Entity<State>,
679 load_credentials_task: Option<Task<()>>,
680}
681
682impl ConfigurationView {
683 fn new(state: gpui::Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
684 let api_key_editor = cx.new(|cx| {
685 SingleLineInput::new(
686 window,
687 cx,
688 "sk-000000000000000000000000000000000000000000000000",
689 )
690 .label("API key")
691 });
692
693 let api_url = AllLanguageModelSettings::get_global(cx)
694 .openai
695 .api_url
696 .clone();
697
698 let api_url_editor = cx.new(|cx| {
699 let input = SingleLineInput::new(window, cx, open_ai::OPEN_AI_API_URL).label("API URL");
700
701 if !api_url.is_empty() {
702 input.editor.update(cx, |editor, cx| {
703 editor.set_text(&*api_url, window, cx);
704 });
705 }
706 input
707 });
708
709 cx.observe(&state, |_, _, cx| {
710 cx.notify();
711 })
712 .detach();
713
714 let load_credentials_task = Some(cx.spawn_in(window, {
715 let state = state.clone();
716 async move |this, cx| {
717 if let Some(task) = state
718 .update(cx, |state, cx| state.authenticate(cx))
719 .log_err()
720 {
721 // We don't log an error, because "not signed in" is also an error.
722 let _ = task.await;
723 }
724 this.update(cx, |this, cx| {
725 this.load_credentials_task = None;
726 cx.notify();
727 })
728 .log_err();
729 }
730 }));
731
732 Self {
733 api_key_editor,
734 api_url_editor,
735 state,
736 load_credentials_task,
737 }
738 }
739
740 fn save_api_key(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
741 let api_key = self
742 .api_key_editor
743 .read(cx)
744 .editor()
745 .read(cx)
746 .text(cx)
747 .trim()
748 .to_string();
749
750 // Don't proceed if no API key is provided and we're not authenticated
751 if api_key.is_empty() && !self.state.read(cx).is_authenticated() {
752 return;
753 }
754
755 let state = self.state.clone();
756 cx.spawn_in(window, async move |_, cx| {
757 state
758 .update(cx, |state, cx| state.set_api_key(api_key, cx))?
759 .await
760 })
761 .detach_and_log_err(cx);
762
763 cx.notify();
764 }
765
766 fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
767 self.api_key_editor.update(cx, |input, cx| {
768 input.editor.update(cx, |editor, cx| {
769 editor.set_text("", window, cx);
770 });
771 });
772
773 let state = self.state.clone();
774 cx.spawn_in(window, async move |_, cx| {
775 state.update(cx, |state, cx| state.reset_api_key(cx))?.await
776 })
777 .detach_and_log_err(cx);
778
779 cx.notify();
780 }
781
782 fn save_api_url(&mut self, cx: &mut Context<Self>) {
783 let api_url = self
784 .api_url_editor
785 .read(cx)
786 .editor()
787 .read(cx)
788 .text(cx)
789 .trim()
790 .to_string();
791
792 let current_url = AllLanguageModelSettings::get_global(cx)
793 .openai
794 .api_url
795 .clone();
796
797 let effective_current_url = if current_url.is_empty() {
798 open_ai::OPEN_AI_API_URL
799 } else {
800 ¤t_url
801 };
802
803 if !api_url.is_empty() && api_url != effective_current_url {
804 let fs = <dyn Fs>::global(cx);
805 update_settings_file::<AllLanguageModelSettings>(fs, cx, move |settings, _| {
806 use crate::settings::{OpenAiSettingsContent, VersionedOpenAiSettingsContent};
807
808 if settings.openai.is_none() {
809 settings.openai = Some(OpenAiSettingsContent::Versioned(
810 VersionedOpenAiSettingsContent::V1(
811 crate::settings::OpenAiSettingsContentV1 {
812 api_url: Some(api_url.clone()),
813 available_models: None,
814 },
815 ),
816 ));
817 } else {
818 if let Some(openai) = settings.openai.as_mut() {
819 match openai {
820 OpenAiSettingsContent::Versioned(versioned) => match versioned {
821 VersionedOpenAiSettingsContent::V1(v1) => {
822 v1.api_url = Some(api_url.clone());
823 }
824 },
825 OpenAiSettingsContent::Legacy(legacy) => {
826 legacy.api_url = Some(api_url.clone());
827 }
828 }
829 }
830 }
831 });
832 }
833 }
834
835 fn reset_api_url(&mut self, window: &mut Window, cx: &mut Context<Self>) {
836 self.api_url_editor.update(cx, |input, cx| {
837 input.editor.update(cx, |editor, cx| {
838 editor.set_text("", window, cx);
839 });
840 });
841 let fs = <dyn Fs>::global(cx);
842 update_settings_file::<AllLanguageModelSettings>(fs, cx, |settings, _cx| {
843 use crate::settings::{OpenAiSettingsContent, VersionedOpenAiSettingsContent};
844
845 if let Some(openai) = settings.openai.as_mut() {
846 match openai {
847 OpenAiSettingsContent::Versioned(versioned) => match versioned {
848 VersionedOpenAiSettingsContent::V1(v1) => {
849 v1.api_url = None;
850 }
851 },
852 OpenAiSettingsContent::Legacy(legacy) => {
853 legacy.api_url = None;
854 }
855 }
856 }
857 });
858 cx.notify();
859 }
860
861 fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
862 !self.state.read(cx).is_authenticated()
863 }
864}
865
866impl Render for ConfigurationView {
867 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
868 let env_var_set = self.state.read(cx).api_key_from_env;
869
870 let api_key_section = if self.should_render_editor(cx) {
871 v_flex()
872 .on_action(cx.listener(Self::save_api_key))
873
874 .child(Label::new("To use Zed's assistant with OpenAI, you need to add an API key. Follow these steps:"))
875 .child(
876 List::new()
877 .child(InstructionListItem::new(
878 "Create one by visiting",
879 Some("OpenAI's console"),
880 Some("https://platform.openai.com/api-keys"),
881 ))
882 .child(InstructionListItem::text_only(
883 "Ensure your OpenAI account has credits",
884 ))
885 .child(InstructionListItem::text_only(
886 "Paste your API key below and hit enter to start using the assistant",
887 )),
888 )
889 .child(self.api_key_editor.clone())
890 .child(
891 Label::new(
892 format!("You can also assign the {OPENAI_API_KEY_VAR} environment variable and restart Zed."),
893 )
894 .size(LabelSize::Small).color(Color::Muted),
895 )
896 .child(
897 Label::new(
898 "Note that having a subscription for another service like GitHub Copilot won't work.",
899 )
900 .size(LabelSize::Small).color(Color::Muted),
901 )
902 .into_any()
903 } else {
904 h_flex()
905 .mt_1()
906 .p_1()
907 .justify_between()
908 .rounded_md()
909 .border_1()
910 .border_color(cx.theme().colors().border)
911 .bg(cx.theme().colors().background)
912 .child(
913 h_flex()
914 .gap_1()
915 .child(Icon::new(IconName::Check).color(Color::Success))
916 .child(Label::new(if env_var_set {
917 format!("API key set in {OPENAI_API_KEY_VAR} environment variable.")
918 } else {
919 "API key configured.".to_string()
920 })),
921 )
922 .child(
923 Button::new("reset-api-key", "Reset API Key")
924 .label_size(LabelSize::Small)
925 .icon(IconName::Undo)
926 .icon_size(IconSize::Small)
927 .icon_position(IconPosition::Start)
928 .layer(ElevationIndex::ModalSurface)
929 .when(env_var_set, |this| {
930 this.tooltip(Tooltip::text(format!("To reset your API key, unset the {OPENAI_API_KEY_VAR} environment variable.")))
931 })
932 .on_click(cx.listener(|this, _, window, cx| this.reset_api_key(window, cx))),
933 )
934 .into_any()
935 };
936
937 let custom_api_url_set =
938 AllLanguageModelSettings::get_global(cx).openai.api_url != open_ai::OPEN_AI_API_URL;
939
940 let api_url_section = if custom_api_url_set {
941 h_flex()
942 .mt_1()
943 .p_1()
944 .justify_between()
945 .rounded_md()
946 .border_1()
947 .border_color(cx.theme().colors().border)
948 .bg(cx.theme().colors().background)
949 .child(
950 h_flex()
951 .gap_1()
952 .child(Icon::new(IconName::Check).color(Color::Success))
953 .child(Label::new("Custom API URL configured.")),
954 )
955 .child(
956 Button::new("reset-api-url", "Reset API URL")
957 .label_size(LabelSize::Small)
958 .icon(IconName::Undo)
959 .icon_size(IconSize::Small)
960 .icon_position(IconPosition::Start)
961 .layer(ElevationIndex::ModalSurface)
962 .on_click(
963 cx.listener(|this, _, window, cx| this.reset_api_url(window, cx)),
964 ),
965 )
966 .into_any()
967 } else {
968 v_flex()
969 .on_action(cx.listener(|this, _: &menu::Confirm, _window, cx| {
970 this.save_api_url(cx);
971 cx.notify();
972 }))
973 .mt_2()
974 .pt_2()
975 .border_t_1()
976 .border_color(cx.theme().colors().border_variant)
977 .gap_1()
978 .child(
979 List::new()
980 .child(InstructionListItem::text_only(
981 "Optionally, you can change the base URL for the OpenAI API request.",
982 ))
983 .child(InstructionListItem::text_only(
984 "Paste the new API endpoint below and hit enter",
985 )),
986 )
987 .child(self.api_url_editor.clone())
988 .into_any()
989 };
990
991 if self.load_credentials_task.is_some() {
992 div().child(Label::new("Loading credentials…")).into_any()
993 } else {
994 v_flex()
995 .size_full()
996 .child(api_key_section)
997 .child(api_url_section)
998 .into_any()
999 }
1000 }
1001}
1002
1003#[cfg(test)]
1004mod tests {
1005 use gpui::TestAppContext;
1006 use language_model::LanguageModelRequestMessage;
1007
1008 use super::*;
1009
1010 #[gpui::test]
1011 fn tiktoken_rs_support(cx: &TestAppContext) {
1012 let request = LanguageModelRequest {
1013 thread_id: None,
1014 prompt_id: None,
1015 intent: None,
1016 mode: None,
1017 messages: vec![LanguageModelRequestMessage {
1018 role: Role::User,
1019 content: vec![MessageContent::Text("message".into())],
1020 cache: false,
1021 }],
1022 tools: vec![],
1023 tool_choice: None,
1024 stop: vec![],
1025 temperature: None,
1026 };
1027
1028 // Validate that all models are supported by tiktoken-rs
1029 for model in Model::iter() {
1030 let count = cx
1031 .executor()
1032 .block(count_open_ai_tokens(
1033 request.clone(),
1034 model,
1035 &cx.app.borrow(),
1036 ))
1037 .unwrap();
1038 assert!(count > 0);
1039 }
1040 }
1041}