1use anyhow::{Context as _, Result, anyhow};
2use collections::BTreeMap;
3use credentials_provider::CredentialsProvider;
4use futures::{FutureExt, StreamExt, future::BoxFuture};
5use gpui::{AnyView, App, AsyncApp, Context, Entity, Subscription, Task, Window};
6use http_client::HttpClient;
7use language_model::{
8 AuthenticateError, LanguageModel, LanguageModelCompletionError, LanguageModelCompletionEvent,
9 LanguageModelId, LanguageModelName, LanguageModelProvider, LanguageModelProviderId,
10 LanguageModelProviderName, LanguageModelProviderState, LanguageModelRequest,
11 LanguageModelToolChoice, LanguageModelToolSchemaFormat, RateLimiter, Role,
12};
13use menu;
14use open_ai::ResponseStreamEvent;
15use schemars::JsonSchema;
16use serde::{Deserialize, Serialize};
17use settings::{Settings, SettingsStore};
18use std::sync::Arc;
19use strum::IntoEnumIterator;
20use x_ai::Model;
21
22use ui::{ElevationIndex, List, Tooltip, prelude::*};
23use ui_input::SingleLineInput;
24use util::ResultExt;
25
26use crate::{AllLanguageModelSettings, ui::InstructionListItem};
27
28const PROVIDER_ID: &str = "x_ai";
29const PROVIDER_NAME: &str = "xAI";
30
31#[derive(Default, Clone, Debug, PartialEq)]
32pub struct XAiSettings {
33 pub api_url: String,
34 pub available_models: Vec<AvailableModel>,
35}
36
37#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema)]
38pub struct AvailableModel {
39 pub name: String,
40 pub display_name: Option<String>,
41 pub max_tokens: u64,
42 pub max_output_tokens: Option<u64>,
43 pub max_completion_tokens: Option<u64>,
44}
45
46pub struct XAiLanguageModelProvider {
47 http_client: Arc<dyn HttpClient>,
48 state: gpui::Entity<State>,
49}
50
51pub struct State {
52 api_key: Option<String>,
53 api_key_from_env: bool,
54 _subscription: Subscription,
55}
56
57const XAI_API_KEY_VAR: &str = "XAI_API_KEY";
58
59impl State {
60 fn is_authenticated(&self) -> bool {
61 self.api_key.is_some()
62 }
63
64 fn reset_api_key(&self, cx: &mut Context<Self>) -> Task<Result<()>> {
65 let credentials_provider = <dyn CredentialsProvider>::global(cx);
66 let settings = &AllLanguageModelSettings::get_global(cx).x_ai;
67 let api_url = if settings.api_url.is_empty() {
68 x_ai::XAI_API_URL.to_string()
69 } else {
70 settings.api_url.clone()
71 };
72 cx.spawn(async move |this, cx| {
73 credentials_provider
74 .delete_credentials(&api_url, cx)
75 .await
76 .log_err();
77 this.update(cx, |this, cx| {
78 this.api_key = None;
79 this.api_key_from_env = false;
80 cx.notify();
81 })
82 })
83 }
84
85 fn set_api_key(&mut self, api_key: String, cx: &mut Context<Self>) -> Task<Result<()>> {
86 let credentials_provider = <dyn CredentialsProvider>::global(cx);
87 let settings = &AllLanguageModelSettings::get_global(cx).x_ai;
88 let api_url = if settings.api_url.is_empty() {
89 x_ai::XAI_API_URL.to_string()
90 } else {
91 settings.api_url.clone()
92 };
93 cx.spawn(async move |this, cx| {
94 credentials_provider
95 .write_credentials(&api_url, "Bearer", api_key.as_bytes(), cx)
96 .await
97 .log_err();
98 this.update(cx, |this, cx| {
99 this.api_key = Some(api_key);
100 cx.notify();
101 })
102 })
103 }
104
105 fn authenticate(&self, cx: &mut Context<Self>) -> Task<Result<(), AuthenticateError>> {
106 if self.is_authenticated() {
107 return Task::ready(Ok(()));
108 }
109
110 let credentials_provider = <dyn CredentialsProvider>::global(cx);
111 let settings = &AllLanguageModelSettings::get_global(cx).x_ai;
112 let api_url = if settings.api_url.is_empty() {
113 x_ai::XAI_API_URL.to_string()
114 } else {
115 settings.api_url.clone()
116 };
117 cx.spawn(async move |this, cx| {
118 let (api_key, from_env) = if let Ok(api_key) = std::env::var(XAI_API_KEY_VAR) {
119 (api_key, true)
120 } else {
121 let (_, api_key) = credentials_provider
122 .read_credentials(&api_url, cx)
123 .await?
124 .ok_or(AuthenticateError::CredentialsNotFound)?;
125 (
126 String::from_utf8(api_key).context("invalid {PROVIDER_NAME} API key")?,
127 false,
128 )
129 };
130 this.update(cx, |this, cx| {
131 this.api_key = Some(api_key);
132 this.api_key_from_env = from_env;
133 cx.notify();
134 })?;
135
136 Ok(())
137 })
138 }
139}
140
141impl XAiLanguageModelProvider {
142 pub fn new(http_client: Arc<dyn HttpClient>, cx: &mut App) -> Self {
143 let state = cx.new(|cx| State {
144 api_key: None,
145 api_key_from_env: false,
146 _subscription: cx.observe_global::<SettingsStore>(|_this: &mut State, cx| {
147 cx.notify();
148 }),
149 });
150
151 Self { http_client, state }
152 }
153
154 fn create_language_model(&self, model: x_ai::Model) -> Arc<dyn LanguageModel> {
155 Arc::new(XAiLanguageModel {
156 id: LanguageModelId::from(model.id().to_string()),
157 model,
158 state: self.state.clone(),
159 http_client: self.http_client.clone(),
160 request_limiter: RateLimiter::new(4),
161 })
162 }
163}
164
165impl LanguageModelProviderState for XAiLanguageModelProvider {
166 type ObservableEntity = State;
167
168 fn observable_entity(&self) -> Option<gpui::Entity<Self::ObservableEntity>> {
169 Some(self.state.clone())
170 }
171}
172
173impl LanguageModelProvider for XAiLanguageModelProvider {
174 fn id(&self) -> LanguageModelProviderId {
175 LanguageModelProviderId(PROVIDER_ID.into())
176 }
177
178 fn name(&self) -> LanguageModelProviderName {
179 LanguageModelProviderName(PROVIDER_NAME.into())
180 }
181
182 fn icon(&self) -> IconName {
183 IconName::AiXAi
184 }
185
186 fn default_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
187 Some(self.create_language_model(x_ai::Model::default()))
188 }
189
190 fn default_fast_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
191 Some(self.create_language_model(x_ai::Model::default_fast()))
192 }
193
194 fn provided_models(&self, cx: &App) -> Vec<Arc<dyn LanguageModel>> {
195 let mut models = BTreeMap::default();
196
197 for model in x_ai::Model::iter() {
198 if !matches!(model, x_ai::Model::Custom { .. }) {
199 models.insert(model.id().to_string(), model);
200 }
201 }
202
203 for model in &AllLanguageModelSettings::get_global(cx)
204 .x_ai
205 .available_models
206 {
207 models.insert(
208 model.name.clone(),
209 x_ai::Model::Custom {
210 name: model.name.clone(),
211 display_name: model.display_name.clone(),
212 max_tokens: model.max_tokens,
213 max_output_tokens: model.max_output_tokens,
214 max_completion_tokens: model.max_completion_tokens,
215 },
216 );
217 }
218
219 models
220 .into_values()
221 .map(|model| self.create_language_model(model))
222 .collect()
223 }
224
225 fn is_authenticated(&self, cx: &App) -> bool {
226 self.state.read(cx).is_authenticated()
227 }
228
229 fn authenticate(&self, cx: &mut App) -> Task<Result<(), AuthenticateError>> {
230 self.state.update(cx, |state, cx| state.authenticate(cx))
231 }
232
233 fn configuration_view(
234 &self,
235 _target_agent: language_model::ConfigurationViewTargetAgent,
236 window: &mut Window,
237 cx: &mut App,
238 ) -> AnyView {
239 cx.new(|cx| ConfigurationView::new(self.state.clone(), window, cx))
240 .into()
241 }
242
243 fn reset_credentials(&self, cx: &mut App) -> Task<Result<()>> {
244 self.state.update(cx, |state, cx| state.reset_api_key(cx))
245 }
246}
247
248pub struct XAiLanguageModel {
249 id: LanguageModelId,
250 model: x_ai::Model,
251 state: gpui::Entity<State>,
252 http_client: Arc<dyn HttpClient>,
253 request_limiter: RateLimiter,
254}
255
256impl XAiLanguageModel {
257 fn stream_completion(
258 &self,
259 request: open_ai::Request,
260 cx: &AsyncApp,
261 ) -> BoxFuture<'static, Result<futures::stream::BoxStream<'static, Result<ResponseStreamEvent>>>>
262 {
263 let http_client = self.http_client.clone();
264 let Ok((api_key, api_url)) = cx.read_entity(&self.state, |state, cx| {
265 let settings = &AllLanguageModelSettings::get_global(cx).x_ai;
266 let api_url = if settings.api_url.is_empty() {
267 x_ai::XAI_API_URL.to_string()
268 } else {
269 settings.api_url.clone()
270 };
271 (state.api_key.clone(), api_url)
272 }) else {
273 return futures::future::ready(Err(anyhow!("App state dropped"))).boxed();
274 };
275
276 let future = self.request_limiter.stream(async move {
277 let api_key = api_key.context("Missing xAI API Key")?;
278 let request =
279 open_ai::stream_completion(http_client.as_ref(), &api_url, &api_key, request);
280 let response = request.await?;
281 Ok(response)
282 });
283
284 async move { Ok(future.await?.boxed()) }.boxed()
285 }
286}
287
288impl LanguageModel for XAiLanguageModel {
289 fn id(&self) -> LanguageModelId {
290 self.id.clone()
291 }
292
293 fn name(&self) -> LanguageModelName {
294 LanguageModelName::from(self.model.display_name().to_string())
295 }
296
297 fn provider_id(&self) -> LanguageModelProviderId {
298 LanguageModelProviderId(PROVIDER_ID.into())
299 }
300
301 fn provider_name(&self) -> LanguageModelProviderName {
302 LanguageModelProviderName(PROVIDER_NAME.into())
303 }
304
305 fn supports_tools(&self) -> bool {
306 self.model.supports_tool()
307 }
308
309 fn supports_images(&self) -> bool {
310 self.model.supports_images()
311 }
312
313 fn supports_tool_choice(&self, choice: LanguageModelToolChoice) -> bool {
314 match choice {
315 LanguageModelToolChoice::Auto
316 | LanguageModelToolChoice::Any
317 | LanguageModelToolChoice::None => true,
318 }
319 }
320 fn tool_input_format(&self) -> LanguageModelToolSchemaFormat {
321 let model_id = self.model.id().trim().to_lowercase();
322 if model_id.eq(x_ai::Model::Grok4.id()) || model_id.eq(x_ai::Model::GrokCodeFast1.id()) {
323 LanguageModelToolSchemaFormat::JsonSchemaSubset
324 } else {
325 LanguageModelToolSchemaFormat::JsonSchema
326 }
327 }
328
329 fn telemetry_id(&self) -> String {
330 format!("x_ai/{}", self.model.id())
331 }
332
333 fn max_token_count(&self) -> u64 {
334 self.model.max_token_count()
335 }
336
337 fn max_output_tokens(&self) -> Option<u64> {
338 self.model.max_output_tokens()
339 }
340
341 fn count_tokens(
342 &self,
343 request: LanguageModelRequest,
344 cx: &App,
345 ) -> BoxFuture<'static, Result<u64>> {
346 count_xai_tokens(request, self.model.clone(), cx)
347 }
348
349 fn stream_completion(
350 &self,
351 request: LanguageModelRequest,
352 cx: &AsyncApp,
353 ) -> BoxFuture<
354 'static,
355 Result<
356 futures::stream::BoxStream<
357 'static,
358 Result<LanguageModelCompletionEvent, LanguageModelCompletionError>,
359 >,
360 LanguageModelCompletionError,
361 >,
362 > {
363 let request = crate::provider::open_ai::into_open_ai(
364 request,
365 self.model.id(),
366 self.model.supports_parallel_tool_calls(),
367 self.model.supports_prompt_cache_key(),
368 self.max_output_tokens(),
369 None,
370 );
371 let completions = self.stream_completion(request, cx);
372 async move {
373 let mapper = crate::provider::open_ai::OpenAiEventMapper::new();
374 Ok(mapper.map_stream(completions.await?).boxed())
375 }
376 .boxed()
377 }
378}
379
380pub fn count_xai_tokens(
381 request: LanguageModelRequest,
382 model: Model,
383 cx: &App,
384) -> BoxFuture<'static, Result<u64>> {
385 cx.background_spawn(async move {
386 let messages = request
387 .messages
388 .into_iter()
389 .map(|message| tiktoken_rs::ChatCompletionRequestMessage {
390 role: match message.role {
391 Role::User => "user".into(),
392 Role::Assistant => "assistant".into(),
393 Role::System => "system".into(),
394 },
395 content: Some(message.string_contents()),
396 name: None,
397 function_call: None,
398 })
399 .collect::<Vec<_>>();
400
401 let model_name = if model.max_token_count() >= 100_000 {
402 "gpt-4o"
403 } else {
404 "gpt-4"
405 };
406 tiktoken_rs::num_tokens_from_messages(model_name, &messages).map(|tokens| tokens as u64)
407 })
408 .boxed()
409}
410
411struct ConfigurationView {
412 api_key_editor: Entity<SingleLineInput>,
413 state: gpui::Entity<State>,
414 load_credentials_task: Option<Task<()>>,
415}
416
417impl ConfigurationView {
418 fn new(state: gpui::Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
419 let api_key_editor = cx.new(|cx| {
420 SingleLineInput::new(
421 window,
422 cx,
423 "xai-0000000000000000000000000000000000000000000000000",
424 )
425 .label("API key")
426 });
427
428 cx.observe(&state, |_, _, cx| {
429 cx.notify();
430 })
431 .detach();
432
433 let load_credentials_task = Some(cx.spawn_in(window, {
434 let state = state.clone();
435 async move |this, cx| {
436 if let Some(task) = state
437 .update(cx, |state, cx| state.authenticate(cx))
438 .log_err()
439 {
440 // We don't log an error, because "not signed in" is also an error.
441 let _ = task.await;
442 }
443 this.update(cx, |this, cx| {
444 this.load_credentials_task = None;
445 cx.notify();
446 })
447 .log_err();
448 }
449 }));
450
451 Self {
452 api_key_editor,
453 state,
454 load_credentials_task,
455 }
456 }
457
458 fn save_api_key(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
459 let api_key = self
460 .api_key_editor
461 .read(cx)
462 .editor()
463 .read(cx)
464 .text(cx)
465 .trim()
466 .to_string();
467
468 // Don't proceed if no API key is provided and we're not authenticated
469 if api_key.is_empty() && !self.state.read(cx).is_authenticated() {
470 return;
471 }
472
473 let state = self.state.clone();
474 cx.spawn_in(window, async move |_, cx| {
475 state
476 .update(cx, |state, cx| state.set_api_key(api_key, cx))?
477 .await
478 })
479 .detach_and_log_err(cx);
480
481 cx.notify();
482 }
483
484 fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
485 self.api_key_editor.update(cx, |input, cx| {
486 input.editor.update(cx, |editor, cx| {
487 editor.set_text("", window, cx);
488 });
489 });
490
491 let state = self.state.clone();
492 cx.spawn_in(window, async move |_, cx| {
493 state.update(cx, |state, cx| state.reset_api_key(cx))?.await
494 })
495 .detach_and_log_err(cx);
496
497 cx.notify();
498 }
499
500 fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
501 !self.state.read(cx).is_authenticated()
502 }
503}
504
505impl Render for ConfigurationView {
506 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
507 let env_var_set = self.state.read(cx).api_key_from_env;
508
509 let api_key_section = if self.should_render_editor(cx) {
510 v_flex()
511 .on_action(cx.listener(Self::save_api_key))
512 .child(Label::new("To use Zed's agent with xAI, you need to add an API key. Follow these steps:"))
513 .child(
514 List::new()
515 .child(InstructionListItem::new(
516 "Create one by visiting",
517 Some("xAI console"),
518 Some("https://console.x.ai/team/default/api-keys"),
519 ))
520 .child(InstructionListItem::text_only(
521 "Paste your API key below and hit enter to start using the agent",
522 )),
523 )
524 .child(self.api_key_editor.clone())
525 .child(
526 Label::new(format!(
527 "You can also assign the {XAI_API_KEY_VAR} environment variable and restart Zed."
528 ))
529 .size(LabelSize::Small)
530 .color(Color::Muted),
531 )
532 .child(
533 Label::new("Note that xAI is a custom OpenAI-compatible provider.")
534 .size(LabelSize::Small)
535 .color(Color::Muted),
536 )
537 .into_any()
538 } else {
539 h_flex()
540 .mt_1()
541 .p_1()
542 .justify_between()
543 .rounded_md()
544 .border_1()
545 .border_color(cx.theme().colors().border)
546 .bg(cx.theme().colors().background)
547 .child(
548 h_flex()
549 .gap_1()
550 .child(Icon::new(IconName::Check).color(Color::Success))
551 .child(Label::new(if env_var_set {
552 format!("API key set in {XAI_API_KEY_VAR} environment variable.")
553 } else {
554 "API key configured.".to_string()
555 })),
556 )
557 .child(
558 Button::new("reset-api-key", "Reset API Key")
559 .label_size(LabelSize::Small)
560 .icon(IconName::Undo)
561 .icon_size(IconSize::Small)
562 .icon_position(IconPosition::Start)
563 .layer(ElevationIndex::ModalSurface)
564 .when(env_var_set, |this| {
565 this.tooltip(Tooltip::text(format!("To reset your API key, unset the {XAI_API_KEY_VAR} environment variable.")))
566 })
567 .on_click(cx.listener(|this, _, window, cx| this.reset_api_key(window, cx))),
568 )
569 .into_any()
570 };
571
572 if self.load_credentials_task.is_some() {
573 div().child(Label::new("Loading credentials…")).into_any()
574 } else {
575 v_flex().size_full().child(api_key_section).into_any()
576 }
577 }
578}