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,
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(request, &self.model, self.max_output_tokens());
348 let completions = self.stream_completion(request, cx);
349 async move {
350 let mapper = OpenAiEventMapper::new();
351 Ok(mapper.map_stream(completions.await?).boxed())
352 }
353 .boxed()
354 }
355}
356
357pub fn into_open_ai(
358 request: LanguageModelRequest,
359 model: &Model,
360 max_output_tokens: Option<u64>,
361) -> open_ai::Request {
362 let stream = !model.id().starts_with("o1-");
363
364 let mut messages = Vec::new();
365 for message in request.messages {
366 for content in message.content {
367 match content {
368 MessageContent::Text(text) | MessageContent::Thinking { text, .. } => {
369 add_message_content_part(
370 open_ai::MessagePart::Text { text: text },
371 message.role,
372 &mut messages,
373 )
374 }
375 MessageContent::RedactedThinking(_) => {}
376 MessageContent::Image(image) => {
377 add_message_content_part(
378 open_ai::MessagePart::Image {
379 image_url: ImageUrl {
380 url: image.to_base64_url(),
381 detail: None,
382 },
383 },
384 message.role,
385 &mut messages,
386 );
387 }
388 MessageContent::ToolUse(tool_use) => {
389 let tool_call = open_ai::ToolCall {
390 id: tool_use.id.to_string(),
391 content: open_ai::ToolCallContent::Function {
392 function: open_ai::FunctionContent {
393 name: tool_use.name.to_string(),
394 arguments: serde_json::to_string(&tool_use.input)
395 .unwrap_or_default(),
396 },
397 },
398 };
399
400 if let Some(open_ai::RequestMessage::Assistant { tool_calls, .. }) =
401 messages.last_mut()
402 {
403 tool_calls.push(tool_call);
404 } else {
405 messages.push(open_ai::RequestMessage::Assistant {
406 content: None,
407 tool_calls: vec![tool_call],
408 });
409 }
410 }
411 MessageContent::ToolResult(tool_result) => {
412 let content = match &tool_result.content {
413 LanguageModelToolResultContent::Text(text) => {
414 vec![open_ai::MessagePart::Text {
415 text: text.to_string(),
416 }]
417 }
418 LanguageModelToolResultContent::Image(image) => {
419 vec![open_ai::MessagePart::Image {
420 image_url: ImageUrl {
421 url: image.to_base64_url(),
422 detail: None,
423 },
424 }]
425 }
426 };
427
428 messages.push(open_ai::RequestMessage::Tool {
429 content: content.into(),
430 tool_call_id: tool_result.tool_use_id.to_string(),
431 });
432 }
433 }
434 }
435 }
436
437 open_ai::Request {
438 model: model.id().into(),
439 messages,
440 stream,
441 stop: request.stop,
442 temperature: request.temperature.unwrap_or(1.0),
443 max_completion_tokens: max_output_tokens,
444 parallel_tool_calls: if model.supports_parallel_tool_calls() && !request.tools.is_empty() {
445 // Disable parallel tool calls, as the Agent currently expects a maximum of one per turn.
446 Some(false)
447 } else {
448 None
449 },
450 tools: request
451 .tools
452 .into_iter()
453 .map(|tool| open_ai::ToolDefinition::Function {
454 function: open_ai::FunctionDefinition {
455 name: tool.name,
456 description: Some(tool.description),
457 parameters: Some(tool.input_schema),
458 },
459 })
460 .collect(),
461 tool_choice: request.tool_choice.map(|choice| match choice {
462 LanguageModelToolChoice::Auto => open_ai::ToolChoice::Auto,
463 LanguageModelToolChoice::Any => open_ai::ToolChoice::Required,
464 LanguageModelToolChoice::None => open_ai::ToolChoice::None,
465 }),
466 }
467}
468
469fn add_message_content_part(
470 new_part: open_ai::MessagePart,
471 role: Role,
472 messages: &mut Vec<open_ai::RequestMessage>,
473) {
474 match (role, messages.last_mut()) {
475 (Role::User, Some(open_ai::RequestMessage::User { content }))
476 | (
477 Role::Assistant,
478 Some(open_ai::RequestMessage::Assistant {
479 content: Some(content),
480 ..
481 }),
482 )
483 | (Role::System, Some(open_ai::RequestMessage::System { content, .. })) => {
484 content.push_part(new_part);
485 }
486 _ => {
487 messages.push(match role {
488 Role::User => open_ai::RequestMessage::User {
489 content: open_ai::MessageContent::from(vec![new_part]),
490 },
491 Role::Assistant => open_ai::RequestMessage::Assistant {
492 content: Some(open_ai::MessageContent::from(vec![new_part])),
493 tool_calls: Vec::new(),
494 },
495 Role::System => open_ai::RequestMessage::System {
496 content: open_ai::MessageContent::from(vec![new_part]),
497 },
498 });
499 }
500 }
501}
502
503pub struct OpenAiEventMapper {
504 tool_calls_by_index: HashMap<usize, RawToolCall>,
505}
506
507impl OpenAiEventMapper {
508 pub fn new() -> Self {
509 Self {
510 tool_calls_by_index: HashMap::default(),
511 }
512 }
513
514 pub fn map_stream(
515 mut self,
516 events: Pin<Box<dyn Send + Stream<Item = Result<ResponseStreamEvent>>>>,
517 ) -> impl Stream<Item = Result<LanguageModelCompletionEvent, LanguageModelCompletionError>>
518 {
519 events.flat_map(move |event| {
520 futures::stream::iter(match event {
521 Ok(event) => self.map_event(event),
522 Err(error) => vec![Err(LanguageModelCompletionError::Other(anyhow!(error)))],
523 })
524 })
525 }
526
527 pub fn map_event(
528 &mut self,
529 event: ResponseStreamEvent,
530 ) -> Vec<Result<LanguageModelCompletionEvent, LanguageModelCompletionError>> {
531 let Some(choice) = event.choices.first() else {
532 return Vec::new();
533 };
534
535 let mut events = Vec::new();
536 if let Some(content) = choice.delta.content.clone() {
537 events.push(Ok(LanguageModelCompletionEvent::Text(content)));
538 }
539
540 if let Some(tool_calls) = choice.delta.tool_calls.as_ref() {
541 for tool_call in tool_calls {
542 let entry = self.tool_calls_by_index.entry(tool_call.index).or_default();
543
544 if let Some(tool_id) = tool_call.id.clone() {
545 entry.id = tool_id;
546 }
547
548 if let Some(function) = tool_call.function.as_ref() {
549 if let Some(name) = function.name.clone() {
550 entry.name = name;
551 }
552
553 if let Some(arguments) = function.arguments.clone() {
554 entry.arguments.push_str(&arguments);
555 }
556 }
557 }
558 }
559
560 match choice.finish_reason.as_deref() {
561 Some("stop") => {
562 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
563 }
564 Some("tool_calls") => {
565 events.extend(self.tool_calls_by_index.drain().map(|(_, tool_call)| {
566 match serde_json::Value::from_str(&tool_call.arguments) {
567 Ok(input) => Ok(LanguageModelCompletionEvent::ToolUse(
568 LanguageModelToolUse {
569 id: tool_call.id.clone().into(),
570 name: tool_call.name.as_str().into(),
571 is_input_complete: true,
572 input,
573 raw_input: tool_call.arguments.clone(),
574 },
575 )),
576 Err(error) => Err(LanguageModelCompletionError::BadInputJson {
577 id: tool_call.id.into(),
578 tool_name: tool_call.name.as_str().into(),
579 raw_input: tool_call.arguments.into(),
580 json_parse_error: error.to_string(),
581 }),
582 }
583 }));
584
585 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::ToolUse)));
586 }
587 Some(stop_reason) => {
588 log::error!("Unexpected OpenAI stop_reason: {stop_reason:?}",);
589 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
590 }
591 None => {}
592 }
593
594 events
595 }
596}
597
598#[derive(Default)]
599struct RawToolCall {
600 id: String,
601 name: String,
602 arguments: String,
603}
604
605pub fn count_open_ai_tokens(
606 request: LanguageModelRequest,
607 model: Model,
608 cx: &App,
609) -> BoxFuture<'static, Result<u64>> {
610 cx.background_spawn(async move {
611 let messages = request
612 .messages
613 .into_iter()
614 .map(|message| tiktoken_rs::ChatCompletionRequestMessage {
615 role: match message.role {
616 Role::User => "user".into(),
617 Role::Assistant => "assistant".into(),
618 Role::System => "system".into(),
619 },
620 content: Some(message.string_contents()),
621 name: None,
622 function_call: None,
623 })
624 .collect::<Vec<_>>();
625
626 match model {
627 Model::Custom { max_tokens, .. } => {
628 let model = if max_tokens >= 100_000 {
629 // If the max tokens is 100k or more, it is likely the o200k_base tokenizer from gpt4o
630 "gpt-4o"
631 } else {
632 // Otherwise fallback to gpt-4, since only cl100k_base and o200k_base are
633 // supported with this tiktoken method
634 "gpt-4"
635 };
636 tiktoken_rs::num_tokens_from_messages(model, &messages)
637 }
638 // Currently supported by tiktoken_rs
639 // Sometimes tiktoken-rs is behind on model support. If that is the case, make a new branch
640 // arm with an override. We enumerate all supported models here so that we can check if new
641 // models are supported yet or not.
642 Model::ThreePointFiveTurbo
643 | Model::Four
644 | Model::FourTurbo
645 | Model::FourOmni
646 | Model::FourOmniMini
647 | Model::FourPointOne
648 | Model::FourPointOneMini
649 | Model::FourPointOneNano
650 | Model::O1
651 | Model::O3
652 | Model::O3Mini
653 | Model::O4Mini => tiktoken_rs::num_tokens_from_messages(model.id(), &messages),
654 }
655 .map(|tokens| tokens as u64)
656 })
657 .boxed()
658}
659
660struct ConfigurationView {
661 api_key_editor: Entity<SingleLineInput>,
662 api_url_editor: Entity<SingleLineInput>,
663 state: gpui::Entity<State>,
664 load_credentials_task: Option<Task<()>>,
665}
666
667impl ConfigurationView {
668 fn new(state: gpui::Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
669 let api_key_editor = cx.new(|cx| {
670 SingleLineInput::new(
671 window,
672 cx,
673 "sk-000000000000000000000000000000000000000000000000",
674 )
675 .label("API key")
676 });
677
678 let api_url = AllLanguageModelSettings::get_global(cx)
679 .openai
680 .api_url
681 .clone();
682
683 let api_url_editor = cx.new(|cx| {
684 let input = SingleLineInput::new(window, cx, open_ai::OPEN_AI_API_URL).label("API URL");
685
686 if !api_url.is_empty() {
687 input.editor.update(cx, |editor, cx| {
688 editor.set_text(&*api_url, window, cx);
689 });
690 }
691 input
692 });
693
694 cx.observe(&state, |_, _, cx| {
695 cx.notify();
696 })
697 .detach();
698
699 let load_credentials_task = Some(cx.spawn_in(window, {
700 let state = state.clone();
701 async move |this, cx| {
702 if let Some(task) = state
703 .update(cx, |state, cx| state.authenticate(cx))
704 .log_err()
705 {
706 // We don't log an error, because "not signed in" is also an error.
707 let _ = task.await;
708 }
709 this.update(cx, |this, cx| {
710 this.load_credentials_task = None;
711 cx.notify();
712 })
713 .log_err();
714 }
715 }));
716
717 Self {
718 api_key_editor,
719 api_url_editor,
720 state,
721 load_credentials_task,
722 }
723 }
724
725 fn save_api_key(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
726 let api_key = self
727 .api_key_editor
728 .read(cx)
729 .editor()
730 .read(cx)
731 .text(cx)
732 .trim()
733 .to_string();
734
735 // Don't proceed if no API key is provided and we're not authenticated
736 if api_key.is_empty() && !self.state.read(cx).is_authenticated() {
737 return;
738 }
739
740 let state = self.state.clone();
741 cx.spawn_in(window, async move |_, cx| {
742 state
743 .update(cx, |state, cx| state.set_api_key(api_key, cx))?
744 .await
745 })
746 .detach_and_log_err(cx);
747
748 cx.notify();
749 }
750
751 fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
752 self.api_key_editor.update(cx, |input, cx| {
753 input.editor.update(cx, |editor, cx| {
754 editor.set_text("", window, cx);
755 });
756 });
757
758 let state = self.state.clone();
759 cx.spawn_in(window, async move |_, cx| {
760 state.update(cx, |state, cx| state.reset_api_key(cx))?.await
761 })
762 .detach_and_log_err(cx);
763
764 cx.notify();
765 }
766
767 fn save_api_url(&mut self, cx: &mut Context<Self>) {
768 let api_url = self
769 .api_url_editor
770 .read(cx)
771 .editor()
772 .read(cx)
773 .text(cx)
774 .trim()
775 .to_string();
776
777 let current_url = AllLanguageModelSettings::get_global(cx)
778 .openai
779 .api_url
780 .clone();
781
782 let effective_current_url = if current_url.is_empty() {
783 open_ai::OPEN_AI_API_URL
784 } else {
785 ¤t_url
786 };
787
788 if !api_url.is_empty() && api_url != effective_current_url {
789 let fs = <dyn Fs>::global(cx);
790 update_settings_file::<AllLanguageModelSettings>(fs, cx, move |settings, _| {
791 use crate::settings::{OpenAiSettingsContent, VersionedOpenAiSettingsContent};
792
793 if settings.openai.is_none() {
794 settings.openai = Some(OpenAiSettingsContent::Versioned(
795 VersionedOpenAiSettingsContent::V1(
796 crate::settings::OpenAiSettingsContentV1 {
797 api_url: Some(api_url.clone()),
798 available_models: None,
799 },
800 ),
801 ));
802 } else {
803 if let Some(openai) = settings.openai.as_mut() {
804 match openai {
805 OpenAiSettingsContent::Versioned(versioned) => match versioned {
806 VersionedOpenAiSettingsContent::V1(v1) => {
807 v1.api_url = Some(api_url.clone());
808 }
809 },
810 OpenAiSettingsContent::Legacy(legacy) => {
811 legacy.api_url = Some(api_url.clone());
812 }
813 }
814 }
815 }
816 });
817 }
818 }
819
820 fn reset_api_url(&mut self, window: &mut Window, cx: &mut Context<Self>) {
821 self.api_url_editor.update(cx, |input, cx| {
822 input.editor.update(cx, |editor, cx| {
823 editor.set_text("", window, cx);
824 });
825 });
826 let fs = <dyn Fs>::global(cx);
827 update_settings_file::<AllLanguageModelSettings>(fs, cx, |settings, _cx| {
828 use crate::settings::{OpenAiSettingsContent, VersionedOpenAiSettingsContent};
829
830 if let Some(openai) = settings.openai.as_mut() {
831 match openai {
832 OpenAiSettingsContent::Versioned(versioned) => match versioned {
833 VersionedOpenAiSettingsContent::V1(v1) => {
834 v1.api_url = None;
835 }
836 },
837 OpenAiSettingsContent::Legacy(legacy) => {
838 legacy.api_url = None;
839 }
840 }
841 }
842 });
843 cx.notify();
844 }
845
846 fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
847 !self.state.read(cx).is_authenticated()
848 }
849}
850
851impl Render for ConfigurationView {
852 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
853 let env_var_set = self.state.read(cx).api_key_from_env;
854
855 let api_key_section = if self.should_render_editor(cx) {
856 v_flex()
857 .on_action(cx.listener(Self::save_api_key))
858
859 .child(Label::new("To use Zed's assistant with OpenAI, you need to add an API key. Follow these steps:"))
860 .child(
861 List::new()
862 .child(InstructionListItem::new(
863 "Create one by visiting",
864 Some("OpenAI's console"),
865 Some("https://platform.openai.com/api-keys"),
866 ))
867 .child(InstructionListItem::text_only(
868 "Ensure your OpenAI account has credits",
869 ))
870 .child(InstructionListItem::text_only(
871 "Paste your API key below and hit enter to start using the assistant",
872 )),
873 )
874 .child(self.api_key_editor.clone())
875 .child(
876 Label::new(
877 format!("You can also assign the {OPENAI_API_KEY_VAR} environment variable and restart Zed."),
878 )
879 .size(LabelSize::Small).color(Color::Muted),
880 )
881 .child(
882 Label::new(
883 "Note that having a subscription for another service like GitHub Copilot won't work.",
884 )
885 .size(LabelSize::Small).color(Color::Muted),
886 )
887 .into_any()
888 } else {
889 h_flex()
890 .mt_1()
891 .p_1()
892 .justify_between()
893 .rounded_md()
894 .border_1()
895 .border_color(cx.theme().colors().border)
896 .bg(cx.theme().colors().background)
897 .child(
898 h_flex()
899 .gap_1()
900 .child(Icon::new(IconName::Check).color(Color::Success))
901 .child(Label::new(if env_var_set {
902 format!("API key set in {OPENAI_API_KEY_VAR} environment variable.")
903 } else {
904 "API key configured.".to_string()
905 })),
906 )
907 .child(
908 Button::new("reset-api-key", "Reset API Key")
909 .label_size(LabelSize::Small)
910 .icon(IconName::Undo)
911 .icon_size(IconSize::Small)
912 .icon_position(IconPosition::Start)
913 .layer(ElevationIndex::ModalSurface)
914 .when(env_var_set, |this| {
915 this.tooltip(Tooltip::text(format!("To reset your API key, unset the {OPENAI_API_KEY_VAR} environment variable.")))
916 })
917 .on_click(cx.listener(|this, _, window, cx| this.reset_api_key(window, cx))),
918 )
919 .into_any()
920 };
921
922 let custom_api_url_set =
923 AllLanguageModelSettings::get_global(cx).openai.api_url != open_ai::OPEN_AI_API_URL;
924
925 let api_url_section = if custom_api_url_set {
926 h_flex()
927 .mt_1()
928 .p_1()
929 .justify_between()
930 .rounded_md()
931 .border_1()
932 .border_color(cx.theme().colors().border)
933 .bg(cx.theme().colors().background)
934 .child(
935 h_flex()
936 .gap_1()
937 .child(Icon::new(IconName::Check).color(Color::Success))
938 .child(Label::new("Custom API URL configured.")),
939 )
940 .child(
941 Button::new("reset-api-url", "Reset API URL")
942 .label_size(LabelSize::Small)
943 .icon(IconName::Undo)
944 .icon_size(IconSize::Small)
945 .icon_position(IconPosition::Start)
946 .layer(ElevationIndex::ModalSurface)
947 .on_click(
948 cx.listener(|this, _, window, cx| this.reset_api_url(window, cx)),
949 ),
950 )
951 .into_any()
952 } else {
953 v_flex()
954 .on_action(cx.listener(|this, _: &menu::Confirm, _window, cx| {
955 this.save_api_url(cx);
956 cx.notify();
957 }))
958 .mt_2()
959 .pt_2()
960 .border_t_1()
961 .border_color(cx.theme().colors().border_variant)
962 .gap_1()
963 .child(
964 List::new()
965 .child(InstructionListItem::text_only(
966 "Optionally, you can change the base URL for the OpenAI API request.",
967 ))
968 .child(InstructionListItem::text_only(
969 "Paste the new API endpoint below and hit enter",
970 )),
971 )
972 .child(self.api_url_editor.clone())
973 .into_any()
974 };
975
976 if self.load_credentials_task.is_some() {
977 div().child(Label::new("Loading credentials…")).into_any()
978 } else {
979 v_flex()
980 .size_full()
981 .child(api_key_section)
982 .child(api_url_section)
983 .into_any()
984 }
985 }
986}
987
988#[cfg(test)]
989mod tests {
990 use gpui::TestAppContext;
991 use language_model::LanguageModelRequestMessage;
992
993 use super::*;
994
995 #[gpui::test]
996 fn tiktoken_rs_support(cx: &TestAppContext) {
997 let request = LanguageModelRequest {
998 thread_id: None,
999 prompt_id: None,
1000 intent: None,
1001 mode: None,
1002 messages: vec![LanguageModelRequestMessage {
1003 role: Role::User,
1004 content: vec![MessageContent::Text("message".into())],
1005 cache: false,
1006 }],
1007 tools: vec![],
1008 tool_choice: None,
1009 stop: vec![],
1010 temperature: None,
1011 };
1012
1013 // Validate that all models are supported by tiktoken-rs
1014 for model in Model::iter() {
1015 let count = cx
1016 .executor()
1017 .block(count_open_ai_tokens(
1018 request.clone(),
1019 model,
1020 &cx.app.borrow(),
1021 ))
1022 .unwrap();
1023 assert!(count > 0);
1024 }
1025 }
1026}