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![Err(LanguageModelCompletionError::Other(anyhow!(
533 "Response contained no choices"
534 )))];
535 };
536
537 let mut events = Vec::new();
538 if let Some(content) = choice.delta.content.clone() {
539 events.push(Ok(LanguageModelCompletionEvent::Text(content)));
540 }
541
542 if let Some(tool_calls) = choice.delta.tool_calls.as_ref() {
543 for tool_call in tool_calls {
544 let entry = self.tool_calls_by_index.entry(tool_call.index).or_default();
545
546 if let Some(tool_id) = tool_call.id.clone() {
547 entry.id = tool_id;
548 }
549
550 if let Some(function) = tool_call.function.as_ref() {
551 if let Some(name) = function.name.clone() {
552 entry.name = name;
553 }
554
555 if let Some(arguments) = function.arguments.clone() {
556 entry.arguments.push_str(&arguments);
557 }
558 }
559 }
560 }
561
562 match choice.finish_reason.as_deref() {
563 Some("stop") => {
564 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
565 }
566 Some("tool_calls") => {
567 events.extend(self.tool_calls_by_index.drain().map(|(_, tool_call)| {
568 match serde_json::Value::from_str(&tool_call.arguments) {
569 Ok(input) => Ok(LanguageModelCompletionEvent::ToolUse(
570 LanguageModelToolUse {
571 id: tool_call.id.clone().into(),
572 name: tool_call.name.as_str().into(),
573 is_input_complete: true,
574 input,
575 raw_input: tool_call.arguments.clone(),
576 },
577 )),
578 Err(error) => Err(LanguageModelCompletionError::BadInputJson {
579 id: tool_call.id.into(),
580 tool_name: tool_call.name.as_str().into(),
581 raw_input: tool_call.arguments.into(),
582 json_parse_error: error.to_string(),
583 }),
584 }
585 }));
586
587 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::ToolUse)));
588 }
589 Some(stop_reason) => {
590 log::error!("Unexpected OpenAI stop_reason: {stop_reason:?}",);
591 events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
592 }
593 None => {}
594 }
595
596 events
597 }
598}
599
600#[derive(Default)]
601struct RawToolCall {
602 id: String,
603 name: String,
604 arguments: String,
605}
606
607pub fn count_open_ai_tokens(
608 request: LanguageModelRequest,
609 model: Model,
610 cx: &App,
611) -> BoxFuture<'static, Result<u64>> {
612 cx.background_spawn(async move {
613 let messages = request
614 .messages
615 .into_iter()
616 .map(|message| tiktoken_rs::ChatCompletionRequestMessage {
617 role: match message.role {
618 Role::User => "user".into(),
619 Role::Assistant => "assistant".into(),
620 Role::System => "system".into(),
621 },
622 content: Some(message.string_contents()),
623 name: None,
624 function_call: None,
625 })
626 .collect::<Vec<_>>();
627
628 match model {
629 Model::Custom { max_tokens, .. } => {
630 let model = if max_tokens >= 100_000 {
631 // If the max tokens is 100k or more, it is likely the o200k_base tokenizer from gpt4o
632 "gpt-4o"
633 } else {
634 // Otherwise fallback to gpt-4, since only cl100k_base and o200k_base are
635 // supported with this tiktoken method
636 "gpt-4"
637 };
638 tiktoken_rs::num_tokens_from_messages(model, &messages)
639 }
640 // Currently supported by tiktoken_rs
641 // Sometimes tiktoken-rs is behind on model support. If that is the case, make a new branch
642 // arm with an override. We enumerate all supported models here so that we can check if new
643 // models are supported yet or not.
644 Model::ThreePointFiveTurbo
645 | Model::Four
646 | Model::FourTurbo
647 | Model::FourOmni
648 | Model::FourOmniMini
649 | Model::FourPointOne
650 | Model::FourPointOneMini
651 | Model::FourPointOneNano
652 | Model::O1
653 | Model::O3
654 | Model::O3Mini
655 | Model::O4Mini => tiktoken_rs::num_tokens_from_messages(model.id(), &messages),
656 }
657 .map(|tokens| tokens as u64)
658 })
659 .boxed()
660}
661
662struct ConfigurationView {
663 api_key_editor: Entity<SingleLineInput>,
664 api_url_editor: Entity<SingleLineInput>,
665 state: gpui::Entity<State>,
666 load_credentials_task: Option<Task<()>>,
667}
668
669impl ConfigurationView {
670 fn new(state: gpui::Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
671 let api_key_editor = cx.new(|cx| {
672 SingleLineInput::new(
673 window,
674 cx,
675 "sk-000000000000000000000000000000000000000000000000",
676 )
677 .label("API key")
678 });
679
680 let api_url = AllLanguageModelSettings::get_global(cx)
681 .openai
682 .api_url
683 .clone();
684
685 let api_url_editor = cx.new(|cx| {
686 let input = SingleLineInput::new(window, cx, open_ai::OPEN_AI_API_URL).label("API URL");
687
688 if !api_url.is_empty() {
689 input.editor.update(cx, |editor, cx| {
690 editor.set_text(&*api_url, window, cx);
691 });
692 }
693 input
694 });
695
696 cx.observe(&state, |_, _, cx| {
697 cx.notify();
698 })
699 .detach();
700
701 let load_credentials_task = Some(cx.spawn_in(window, {
702 let state = state.clone();
703 async move |this, cx| {
704 if let Some(task) = state
705 .update(cx, |state, cx| state.authenticate(cx))
706 .log_err()
707 {
708 // We don't log an error, because "not signed in" is also an error.
709 let _ = task.await;
710 }
711 this.update(cx, |this, cx| {
712 this.load_credentials_task = None;
713 cx.notify();
714 })
715 .log_err();
716 }
717 }));
718
719 Self {
720 api_key_editor,
721 api_url_editor,
722 state,
723 load_credentials_task,
724 }
725 }
726
727 fn save_api_key(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
728 let api_key = self
729 .api_key_editor
730 .read(cx)
731 .editor()
732 .read(cx)
733 .text(cx)
734 .trim()
735 .to_string();
736
737 // Don't proceed if no API key is provided and we're not authenticated
738 if api_key.is_empty() && !self.state.read(cx).is_authenticated() {
739 return;
740 }
741
742 let state = self.state.clone();
743 cx.spawn_in(window, async move |_, cx| {
744 state
745 .update(cx, |state, cx| state.set_api_key(api_key, cx))?
746 .await
747 })
748 .detach_and_log_err(cx);
749
750 cx.notify();
751 }
752
753 fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
754 self.api_key_editor.update(cx, |input, cx| {
755 input.editor.update(cx, |editor, cx| {
756 editor.set_text("", window, cx);
757 });
758 });
759
760 let state = self.state.clone();
761 cx.spawn_in(window, async move |_, cx| {
762 state.update(cx, |state, cx| state.reset_api_key(cx))?.await
763 })
764 .detach_and_log_err(cx);
765
766 cx.notify();
767 }
768
769 fn save_api_url(&mut self, cx: &mut Context<Self>) {
770 let api_url = self
771 .api_url_editor
772 .read(cx)
773 .editor()
774 .read(cx)
775 .text(cx)
776 .trim()
777 .to_string();
778
779 let current_url = AllLanguageModelSettings::get_global(cx)
780 .openai
781 .api_url
782 .clone();
783
784 let effective_current_url = if current_url.is_empty() {
785 open_ai::OPEN_AI_API_URL
786 } else {
787 ¤t_url
788 };
789
790 if !api_url.is_empty() && api_url != effective_current_url {
791 let fs = <dyn Fs>::global(cx);
792 update_settings_file::<AllLanguageModelSettings>(fs, cx, move |settings, _| {
793 use crate::settings::{OpenAiSettingsContent, VersionedOpenAiSettingsContent};
794
795 if settings.openai.is_none() {
796 settings.openai = Some(OpenAiSettingsContent::Versioned(
797 VersionedOpenAiSettingsContent::V1(
798 crate::settings::OpenAiSettingsContentV1 {
799 api_url: Some(api_url.clone()),
800 available_models: None,
801 },
802 ),
803 ));
804 } else {
805 if let Some(openai) = settings.openai.as_mut() {
806 match openai {
807 OpenAiSettingsContent::Versioned(versioned) => match versioned {
808 VersionedOpenAiSettingsContent::V1(v1) => {
809 v1.api_url = Some(api_url.clone());
810 }
811 },
812 OpenAiSettingsContent::Legacy(legacy) => {
813 legacy.api_url = Some(api_url.clone());
814 }
815 }
816 }
817 }
818 });
819 }
820 }
821
822 fn reset_api_url(&mut self, window: &mut Window, cx: &mut Context<Self>) {
823 self.api_url_editor.update(cx, |input, cx| {
824 input.editor.update(cx, |editor, cx| {
825 editor.set_text("", window, cx);
826 });
827 });
828 let fs = <dyn Fs>::global(cx);
829 update_settings_file::<AllLanguageModelSettings>(fs, cx, |settings, _cx| {
830 use crate::settings::{OpenAiSettingsContent, VersionedOpenAiSettingsContent};
831
832 if let Some(openai) = settings.openai.as_mut() {
833 match openai {
834 OpenAiSettingsContent::Versioned(versioned) => match versioned {
835 VersionedOpenAiSettingsContent::V1(v1) => {
836 v1.api_url = None;
837 }
838 },
839 OpenAiSettingsContent::Legacy(legacy) => {
840 legacy.api_url = None;
841 }
842 }
843 }
844 });
845 cx.notify();
846 }
847
848 fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
849 !self.state.read(cx).is_authenticated()
850 }
851}
852
853impl Render for ConfigurationView {
854 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
855 let env_var_set = self.state.read(cx).api_key_from_env;
856
857 let api_key_section = if self.should_render_editor(cx) {
858 v_flex()
859 .on_action(cx.listener(Self::save_api_key))
860
861 .child(Label::new("To use Zed's assistant with OpenAI, you need to add an API key. Follow these steps:"))
862 .child(
863 List::new()
864 .child(InstructionListItem::new(
865 "Create one by visiting",
866 Some("OpenAI's console"),
867 Some("https://platform.openai.com/api-keys"),
868 ))
869 .child(InstructionListItem::text_only(
870 "Ensure your OpenAI account has credits",
871 ))
872 .child(InstructionListItem::text_only(
873 "Paste your API key below and hit enter to start using the assistant",
874 )),
875 )
876 .child(self.api_key_editor.clone())
877 .child(
878 Label::new(
879 format!("You can also assign the {OPENAI_API_KEY_VAR} environment variable and restart Zed."),
880 )
881 .size(LabelSize::Small).color(Color::Muted),
882 )
883 .child(
884 Label::new(
885 "Note that having a subscription for another service like GitHub Copilot won't work.",
886 )
887 .size(LabelSize::Small).color(Color::Muted),
888 )
889 .into_any()
890 } else {
891 h_flex()
892 .mt_1()
893 .p_1()
894 .justify_between()
895 .rounded_md()
896 .border_1()
897 .border_color(cx.theme().colors().border)
898 .bg(cx.theme().colors().background)
899 .child(
900 h_flex()
901 .gap_1()
902 .child(Icon::new(IconName::Check).color(Color::Success))
903 .child(Label::new(if env_var_set {
904 format!("API key set in {OPENAI_API_KEY_VAR} environment variable.")
905 } else {
906 "API key configured.".to_string()
907 })),
908 )
909 .child(
910 Button::new("reset-key", "Reset API Key")
911 .label_size(LabelSize::Small)
912 .icon(IconName::Undo)
913 .icon_size(IconSize::Small)
914 .icon_position(IconPosition::Start)
915 .layer(ElevationIndex::ModalSurface)
916 .when(env_var_set, |this| {
917 this.tooltip(Tooltip::text(format!("To reset your API key, unset the {OPENAI_API_KEY_VAR} environment variable.")))
918 })
919 .on_click(cx.listener(|this, _, window, cx| this.reset_api_key(window, cx))),
920 )
921 .into_any()
922 };
923
924 let custom_api_url_set =
925 AllLanguageModelSettings::get_global(cx).openai.api_url != open_ai::OPEN_AI_API_URL;
926
927 let api_url_section = if custom_api_url_set {
928 h_flex()
929 .mt_1()
930 .p_1()
931 .justify_between()
932 .rounded_md()
933 .border_1()
934 .border_color(cx.theme().colors().border)
935 .bg(cx.theme().colors().background)
936 .child(
937 h_flex()
938 .gap_1()
939 .child(Icon::new(IconName::Check).color(Color::Success))
940 .child(Label::new("Custom API URL configured.")),
941 )
942 .child(
943 Button::new("reset-key", "Reset API URL")
944 .label_size(LabelSize::Small)
945 .icon(IconName::Undo)
946 .icon_size(IconSize::Small)
947 .icon_position(IconPosition::Start)
948 .layer(ElevationIndex::ModalSurface)
949 .on_click(
950 cx.listener(|this, _, window, cx| this.reset_api_url(window, cx)),
951 ),
952 )
953 .into_any()
954 } else {
955 v_flex()
956 .on_action(cx.listener(|this, _: &menu::Confirm, _window, cx| {
957 this.save_api_url(cx);
958 cx.notify();
959 }))
960 .mt_2()
961 .pt_2()
962 .border_t_1()
963 .border_color(cx.theme().colors().border_variant)
964 .gap_1()
965 .child(
966 List::new()
967 .child(InstructionListItem::text_only(
968 "Optionally, you can change the base URL for the OpenAI API request.",
969 ))
970 .child(InstructionListItem::text_only(
971 "Paste the new API endpoint below and hit enter",
972 )),
973 )
974 .child(self.api_url_editor.clone())
975 .into_any()
976 };
977
978 if self.load_credentials_task.is_some() {
979 div().child(Label::new("Loading credentials…")).into_any()
980 } else {
981 v_flex()
982 .size_full()
983 .child(api_key_section)
984 .child(api_url_section)
985 .into_any()
986 }
987 }
988}
989
990#[cfg(test)]
991mod tests {
992 use gpui::TestAppContext;
993 use language_model::LanguageModelRequestMessage;
994
995 use super::*;
996
997 #[gpui::test]
998 fn tiktoken_rs_support(cx: &TestAppContext) {
999 let request = LanguageModelRequest {
1000 thread_id: None,
1001 prompt_id: None,
1002 intent: None,
1003 mode: None,
1004 messages: vec![LanguageModelRequestMessage {
1005 role: Role::User,
1006 content: vec![MessageContent::Text("message".into())],
1007 cache: false,
1008 }],
1009 tools: vec![],
1010 tool_choice: None,
1011 stop: vec![],
1012 temperature: None,
1013 };
1014
1015 // Validate that all models are supported by tiktoken-rs
1016 for model in Model::iter() {
1017 let count = cx
1018 .executor()
1019 .block(count_open_ai_tokens(
1020 request.clone(),
1021 model,
1022 &cx.app.borrow(),
1023 ))
1024 .unwrap();
1025 assert!(count > 0);
1026 }
1027 }
1028}