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