1use crate::{
2 LanguageModel, LanguageModelId, LanguageModelProvider, LanguageModelProviderId,
3 LanguageModelProviderState,
4};
5use collections::BTreeMap;
6use gpui::{App, Context, Entity, EventEmitter, Global, prelude::*};
7use std::{str::FromStr, sync::Arc};
8use thiserror::Error;
9use util::maybe;
10
11pub fn init(cx: &mut App) {
12 let registry = cx.new(|_cx| LanguageModelRegistry::default());
13 cx.set_global(GlobalLanguageModelRegistry(registry));
14}
15
16struct GlobalLanguageModelRegistry(Entity<LanguageModelRegistry>);
17
18impl Global for GlobalLanguageModelRegistry {}
19
20#[derive(Error)]
21pub enum ConfigurationError {
22 #[error("Configure at least one LLM provider to start using the panel.")]
23 NoProvider,
24 #[error("LLM provider is not configured or does not support the configured model.")]
25 ModelNotFound,
26 #[error("{} LLM provider is not configured.", .0.name().0)]
27 ProviderNotAuthenticated(Arc<dyn LanguageModelProvider>),
28}
29
30impl std::fmt::Debug for ConfigurationError {
31 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
32 match self {
33 Self::NoProvider => write!(f, "NoProvider"),
34 Self::ModelNotFound => write!(f, "ModelNotFound"),
35 Self::ProviderNotAuthenticated(provider) => {
36 write!(f, "ProviderNotAuthenticated({})", provider.id())
37 }
38 }
39 }
40}
41
42#[derive(Default)]
43pub struct LanguageModelRegistry {
44 default_model: Option<ConfiguredModel>,
45 default_fast_model: Option<ConfiguredModel>,
46 inline_assistant_model: Option<ConfiguredModel>,
47 commit_message_model: Option<ConfiguredModel>,
48 thread_summary_model: Option<ConfiguredModel>,
49 providers: BTreeMap<LanguageModelProviderId, Arc<dyn LanguageModelProvider>>,
50 inline_alternatives: Vec<Arc<dyn LanguageModel>>,
51}
52
53#[derive(Debug)]
54pub struct SelectedModel {
55 pub provider: LanguageModelProviderId,
56 pub model: LanguageModelId,
57}
58
59impl FromStr for SelectedModel {
60 type Err = String;
61
62 /// Parse string identifiers like `provider_id/model_id` into a `SelectedModel`
63 fn from_str(id: &str) -> Result<SelectedModel, Self::Err> {
64 let parts: Vec<&str> = id.split('/').collect();
65 let [provider_id, model_id] = parts.as_slice() else {
66 return Err(format!(
67 "Invalid model identifier format: `{}`. Expected `provider_id/model_id`",
68 id
69 ));
70 };
71
72 if provider_id.is_empty() || model_id.is_empty() {
73 return Err(format!("Provider and model ids can't be empty: `{}`", id));
74 }
75
76 Ok(SelectedModel {
77 provider: LanguageModelProviderId(provider_id.to_string().into()),
78 model: LanguageModelId(model_id.to_string().into()),
79 })
80 }
81}
82
83#[derive(Clone)]
84pub struct ConfiguredModel {
85 pub provider: Arc<dyn LanguageModelProvider>,
86 pub model: Arc<dyn LanguageModel>,
87}
88
89impl ConfiguredModel {
90 pub fn is_same_as(&self, other: &ConfiguredModel) -> bool {
91 self.model.id() == other.model.id() && self.provider.id() == other.provider.id()
92 }
93
94 pub fn is_provided_by_zed(&self) -> bool {
95 self.provider.id() == crate::ZED_CLOUD_PROVIDER_ID
96 }
97}
98
99pub enum Event {
100 DefaultModelChanged,
101 InlineAssistantModelChanged,
102 CommitMessageModelChanged,
103 ThreadSummaryModelChanged,
104 ProviderStateChanged(LanguageModelProviderId),
105 AddedProvider(LanguageModelProviderId),
106 RemovedProvider(LanguageModelProviderId),
107}
108
109impl EventEmitter<Event> for LanguageModelRegistry {}
110
111impl LanguageModelRegistry {
112 pub fn global(cx: &App) -> Entity<Self> {
113 cx.global::<GlobalLanguageModelRegistry>().0.clone()
114 }
115
116 pub fn read_global(cx: &App) -> &Self {
117 cx.global::<GlobalLanguageModelRegistry>().0.read(cx)
118 }
119
120 #[cfg(any(test, feature = "test-support"))]
121 pub fn test(cx: &mut App) -> Arc<crate::fake_provider::FakeLanguageModelProvider> {
122 let fake_provider = Arc::new(crate::fake_provider::FakeLanguageModelProvider::default());
123 let registry = cx.new(|cx| {
124 let mut registry = Self::default();
125 registry.register_provider(fake_provider.clone(), cx);
126 let model = fake_provider.provided_models(cx)[0].clone();
127 let configured_model = ConfiguredModel {
128 provider: fake_provider.clone(),
129 model,
130 };
131 registry.set_default_model(Some(configured_model), cx);
132 registry
133 });
134 cx.set_global(GlobalLanguageModelRegistry(registry));
135 fake_provider
136 }
137
138 #[cfg(any(test, feature = "test-support"))]
139 pub fn fake_model(&self) -> Arc<dyn LanguageModel> {
140 self.default_model.as_ref().unwrap().model.clone()
141 }
142
143 pub fn register_provider<T: LanguageModelProvider + LanguageModelProviderState>(
144 &mut self,
145 provider: Arc<T>,
146 cx: &mut Context<Self>,
147 ) {
148 let id = provider.id();
149
150 let subscription = provider.subscribe(cx, {
151 let id = id.clone();
152 move |_, cx| {
153 cx.emit(Event::ProviderStateChanged(id.clone()));
154 }
155 });
156 if let Some(subscription) = subscription {
157 subscription.detach();
158 }
159
160 self.providers.insert(id.clone(), provider);
161 cx.emit(Event::AddedProvider(id));
162 }
163
164 pub fn unregister_provider(&mut self, id: LanguageModelProviderId, cx: &mut Context<Self>) {
165 if self.providers.remove(&id).is_some() {
166 cx.emit(Event::RemovedProvider(id));
167 }
168 }
169
170 pub fn providers(&self) -> Vec<Arc<dyn LanguageModelProvider>> {
171 let zed_provider_id = LanguageModelProviderId("zed.dev".into());
172 let mut providers = Vec::with_capacity(self.providers.len());
173 if let Some(provider) = self.providers.get(&zed_provider_id) {
174 providers.push(provider.clone());
175 }
176 providers.extend(self.providers.values().filter_map(|p| {
177 if p.id() != zed_provider_id {
178 Some(p.clone())
179 } else {
180 None
181 }
182 }));
183 providers
184 }
185
186 pub fn configuration_error(
187 &self,
188 model: Option<ConfiguredModel>,
189 cx: &App,
190 ) -> Option<ConfigurationError> {
191 let Some(model) = model else {
192 if !self.has_authenticated_provider(cx) {
193 return Some(ConfigurationError::NoProvider);
194 }
195 return Some(ConfigurationError::ModelNotFound);
196 };
197
198 if !model.provider.is_authenticated(cx) {
199 return Some(ConfigurationError::ProviderNotAuthenticated(model.provider));
200 }
201
202 None
203 }
204
205 /// Returns `true` if at least one provider that is authenticated.
206 pub fn has_authenticated_provider(&self, cx: &App) -> bool {
207 self.providers.values().any(|p| p.is_authenticated(cx))
208 }
209
210 pub fn available_models<'a>(
211 &'a self,
212 cx: &'a App,
213 ) -> impl Iterator<Item = Arc<dyn LanguageModel>> + 'a {
214 self.providers
215 .values()
216 .filter(|provider| provider.is_authenticated(cx))
217 .flat_map(|provider| provider.provided_models(cx))
218 }
219
220 pub fn provider(&self, id: &LanguageModelProviderId) -> Option<Arc<dyn LanguageModelProvider>> {
221 self.providers.get(id).cloned()
222 }
223
224 pub fn select_default_model(&mut self, model: Option<&SelectedModel>, cx: &mut Context<Self>) {
225 let configured_model = model.and_then(|model| self.select_model(model, cx));
226 self.set_default_model(configured_model, cx);
227 }
228
229 pub fn select_inline_assistant_model(
230 &mut self,
231 model: Option<&SelectedModel>,
232 cx: &mut Context<Self>,
233 ) {
234 let configured_model = model.and_then(|model| self.select_model(model, cx));
235 self.set_inline_assistant_model(configured_model, cx);
236 }
237
238 pub fn select_commit_message_model(
239 &mut self,
240 model: Option<&SelectedModel>,
241 cx: &mut Context<Self>,
242 ) {
243 let configured_model = model.and_then(|model| self.select_model(model, cx));
244 self.set_commit_message_model(configured_model, cx);
245 }
246
247 pub fn select_thread_summary_model(
248 &mut self,
249 model: Option<&SelectedModel>,
250 cx: &mut Context<Self>,
251 ) {
252 let configured_model = model.and_then(|model| self.select_model(model, cx));
253 self.set_thread_summary_model(configured_model, cx);
254 }
255
256 /// Selects and sets the inline alternatives for language models based on
257 /// provider name and id.
258 pub fn select_inline_alternative_models(
259 &mut self,
260 alternatives: impl IntoIterator<Item = SelectedModel>,
261 cx: &mut Context<Self>,
262 ) {
263 self.inline_alternatives = alternatives
264 .into_iter()
265 .flat_map(|alternative| {
266 self.select_model(&alternative, cx)
267 .map(|configured_model| configured_model.model)
268 })
269 .collect::<Vec<_>>();
270 }
271
272 pub fn select_model(
273 &mut self,
274 selected_model: &SelectedModel,
275 cx: &mut Context<Self>,
276 ) -> Option<ConfiguredModel> {
277 let provider = self.provider(&selected_model.provider)?;
278 let model = provider
279 .provided_models(cx)
280 .iter()
281 .find(|model| model.id() == selected_model.model)?
282 .clone();
283 Some(ConfiguredModel { provider, model })
284 }
285
286 pub fn set_default_model(&mut self, model: Option<ConfiguredModel>, cx: &mut Context<Self>) {
287 match (self.default_model.as_ref(), model.as_ref()) {
288 (Some(old), Some(new)) if old.is_same_as(new) => {}
289 (None, None) => {}
290 _ => cx.emit(Event::DefaultModelChanged),
291 }
292 self.default_fast_model = maybe!({
293 let provider = &model.as_ref()?.provider;
294 let fast_model = provider.default_fast_model(cx)?;
295 Some(ConfiguredModel {
296 provider: provider.clone(),
297 model: fast_model,
298 })
299 });
300 self.default_model = model;
301 }
302
303 pub fn set_inline_assistant_model(
304 &mut self,
305 model: Option<ConfiguredModel>,
306 cx: &mut Context<Self>,
307 ) {
308 match (self.inline_assistant_model.as_ref(), model.as_ref()) {
309 (Some(old), Some(new)) if old.is_same_as(new) => {}
310 (None, None) => {}
311 _ => cx.emit(Event::InlineAssistantModelChanged),
312 }
313 self.inline_assistant_model = model;
314 }
315
316 pub fn set_commit_message_model(
317 &mut self,
318 model: Option<ConfiguredModel>,
319 cx: &mut Context<Self>,
320 ) {
321 match (self.commit_message_model.as_ref(), model.as_ref()) {
322 (Some(old), Some(new)) if old.is_same_as(new) => {}
323 (None, None) => {}
324 _ => cx.emit(Event::CommitMessageModelChanged),
325 }
326 self.commit_message_model = model;
327 }
328
329 pub fn set_thread_summary_model(
330 &mut self,
331 model: Option<ConfiguredModel>,
332 cx: &mut Context<Self>,
333 ) {
334 match (self.thread_summary_model.as_ref(), model.as_ref()) {
335 (Some(old), Some(new)) if old.is_same_as(new) => {}
336 (None, None) => {}
337 _ => cx.emit(Event::ThreadSummaryModelChanged),
338 }
339 self.thread_summary_model = model;
340 }
341
342 pub fn default_model(&self) -> Option<ConfiguredModel> {
343 #[cfg(debug_assertions)]
344 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
345 return None;
346 }
347
348 self.default_model.clone()
349 }
350
351 pub fn inline_assistant_model(&self) -> Option<ConfiguredModel> {
352 #[cfg(debug_assertions)]
353 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
354 return None;
355 }
356
357 self.inline_assistant_model
358 .clone()
359 .or_else(|| self.default_model.clone())
360 }
361
362 pub fn commit_message_model(&self) -> Option<ConfiguredModel> {
363 #[cfg(debug_assertions)]
364 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
365 return None;
366 }
367
368 self.commit_message_model
369 .clone()
370 .or_else(|| self.default_fast_model.clone())
371 .or_else(|| self.default_model.clone())
372 }
373
374 pub fn thread_summary_model(&self) -> Option<ConfiguredModel> {
375 #[cfg(debug_assertions)]
376 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
377 return None;
378 }
379
380 self.thread_summary_model
381 .clone()
382 .or_else(|| self.default_fast_model.clone())
383 .or_else(|| self.default_model.clone())
384 }
385
386 /// The models to use for inline assists. Returns the union of the active
387 /// model and all inline alternatives. When there are multiple models, the
388 /// user will be able to cycle through results.
389 pub fn inline_alternative_models(&self) -> &[Arc<dyn LanguageModel>] {
390 &self.inline_alternatives
391 }
392}
393
394#[cfg(test)]
395mod tests {
396 use super::*;
397 use crate::fake_provider::FakeLanguageModelProvider;
398
399 #[gpui::test]
400 fn test_register_providers(cx: &mut App) {
401 let registry = cx.new(|_| LanguageModelRegistry::default());
402
403 let provider = Arc::new(FakeLanguageModelProvider::default());
404 registry.update(cx, |registry, cx| {
405 registry.register_provider(provider.clone(), cx);
406 });
407
408 let providers = registry.read(cx).providers();
409 assert_eq!(providers.len(), 1);
410 assert_eq!(providers[0].id(), provider.id());
411
412 registry.update(cx, |registry, cx| {
413 registry.unregister_provider(provider.id(), cx);
414 });
415
416 let providers = registry.read(cx).providers();
417 assert!(providers.is_empty());
418 }
419}