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) -> crate::fake_provider::FakeLanguageModelProvider {
122 let fake_provider = 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: Arc::new(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 pub fn register_provider<T: LanguageModelProvider + LanguageModelProviderState>(
139 &mut self,
140 provider: T,
141 cx: &mut Context<Self>,
142 ) {
143 let id = provider.id();
144
145 let subscription = provider.subscribe(cx, {
146 let id = id.clone();
147 move |_, cx| {
148 cx.emit(Event::ProviderStateChanged(id.clone()));
149 }
150 });
151 if let Some(subscription) = subscription {
152 subscription.detach();
153 }
154
155 self.providers.insert(id.clone(), Arc::new(provider));
156 cx.emit(Event::AddedProvider(id));
157 }
158
159 pub fn unregister_provider(&mut self, id: LanguageModelProviderId, cx: &mut Context<Self>) {
160 if self.providers.remove(&id).is_some() {
161 cx.emit(Event::RemovedProvider(id));
162 }
163 }
164
165 pub fn providers(&self) -> Vec<Arc<dyn LanguageModelProvider>> {
166 let zed_provider_id = LanguageModelProviderId("zed.dev".into());
167 let mut providers = Vec::with_capacity(self.providers.len());
168 if let Some(provider) = self.providers.get(&zed_provider_id) {
169 providers.push(provider.clone());
170 }
171 providers.extend(self.providers.values().filter_map(|p| {
172 if p.id() != zed_provider_id {
173 Some(p.clone())
174 } else {
175 None
176 }
177 }));
178 providers
179 }
180
181 pub fn configuration_error(
182 &self,
183 model: Option<ConfiguredModel>,
184 cx: &App,
185 ) -> Option<ConfigurationError> {
186 let Some(model) = model else {
187 if !self.has_authenticated_provider(cx) {
188 return Some(ConfigurationError::NoProvider);
189 }
190 return Some(ConfigurationError::ModelNotFound);
191 };
192
193 if !model.provider.is_authenticated(cx) {
194 return Some(ConfigurationError::ProviderNotAuthenticated(model.provider));
195 }
196
197 None
198 }
199
200 /// Returns `true` if at least one provider that is authenticated.
201 pub fn has_authenticated_provider(&self, cx: &App) -> bool {
202 self.providers.values().any(|p| p.is_authenticated(cx))
203 }
204
205 pub fn available_models<'a>(
206 &'a self,
207 cx: &'a App,
208 ) -> impl Iterator<Item = Arc<dyn LanguageModel>> + 'a {
209 self.providers
210 .values()
211 .flat_map(|provider| provider.provided_models(cx))
212 }
213
214 pub fn provider(&self, id: &LanguageModelProviderId) -> Option<Arc<dyn LanguageModelProvider>> {
215 self.providers.get(id).cloned()
216 }
217
218 pub fn select_default_model(&mut self, model: Option<&SelectedModel>, cx: &mut Context<Self>) {
219 let configured_model = model.and_then(|model| self.select_model(model, cx));
220 self.set_default_model(configured_model, cx);
221 }
222
223 pub fn select_inline_assistant_model(
224 &mut self,
225 model: Option<&SelectedModel>,
226 cx: &mut Context<Self>,
227 ) {
228 let configured_model = model.and_then(|model| self.select_model(model, cx));
229 self.set_inline_assistant_model(configured_model, cx);
230 }
231
232 pub fn select_commit_message_model(
233 &mut self,
234 model: Option<&SelectedModel>,
235 cx: &mut Context<Self>,
236 ) {
237 let configured_model = model.and_then(|model| self.select_model(model, cx));
238 self.set_commit_message_model(configured_model, cx);
239 }
240
241 pub fn select_thread_summary_model(
242 &mut self,
243 model: Option<&SelectedModel>,
244 cx: &mut Context<Self>,
245 ) {
246 let configured_model = model.and_then(|model| self.select_model(model, cx));
247 self.set_thread_summary_model(configured_model, cx);
248 }
249
250 /// Selects and sets the inline alternatives for language models based on
251 /// provider name and id.
252 pub fn select_inline_alternative_models(
253 &mut self,
254 alternatives: impl IntoIterator<Item = SelectedModel>,
255 cx: &mut Context<Self>,
256 ) {
257 self.inline_alternatives = alternatives
258 .into_iter()
259 .flat_map(|alternative| {
260 self.select_model(&alternative, cx)
261 .map(|configured_model| configured_model.model)
262 })
263 .collect::<Vec<_>>();
264 }
265
266 pub fn select_model(
267 &mut self,
268 selected_model: &SelectedModel,
269 cx: &mut Context<Self>,
270 ) -> Option<ConfiguredModel> {
271 let provider = self.provider(&selected_model.provider)?;
272 let model = provider
273 .provided_models(cx)
274 .iter()
275 .find(|model| model.id() == selected_model.model)?
276 .clone();
277 Some(ConfiguredModel { provider, model })
278 }
279
280 pub fn set_default_model(&mut self, model: Option<ConfiguredModel>, cx: &mut Context<Self>) {
281 match (self.default_model.as_ref(), model.as_ref()) {
282 (Some(old), Some(new)) if old.is_same_as(new) => {}
283 (None, None) => {}
284 _ => cx.emit(Event::DefaultModelChanged),
285 }
286 self.default_fast_model = maybe!({
287 let provider = &model.as_ref()?.provider;
288 let fast_model = provider.default_fast_model(cx)?;
289 Some(ConfiguredModel {
290 provider: provider.clone(),
291 model: fast_model,
292 })
293 });
294 self.default_model = model;
295 }
296
297 pub fn set_inline_assistant_model(
298 &mut self,
299 model: Option<ConfiguredModel>,
300 cx: &mut Context<Self>,
301 ) {
302 match (self.inline_assistant_model.as_ref(), model.as_ref()) {
303 (Some(old), Some(new)) if old.is_same_as(new) => {}
304 (None, None) => {}
305 _ => cx.emit(Event::InlineAssistantModelChanged),
306 }
307 self.inline_assistant_model = model;
308 }
309
310 pub fn set_commit_message_model(
311 &mut self,
312 model: Option<ConfiguredModel>,
313 cx: &mut Context<Self>,
314 ) {
315 match (self.commit_message_model.as_ref(), model.as_ref()) {
316 (Some(old), Some(new)) if old.is_same_as(new) => {}
317 (None, None) => {}
318 _ => cx.emit(Event::CommitMessageModelChanged),
319 }
320 self.commit_message_model = model;
321 }
322
323 pub fn set_thread_summary_model(
324 &mut self,
325 model: Option<ConfiguredModel>,
326 cx: &mut Context<Self>,
327 ) {
328 match (self.thread_summary_model.as_ref(), model.as_ref()) {
329 (Some(old), Some(new)) if old.is_same_as(new) => {}
330 (None, None) => {}
331 _ => cx.emit(Event::ThreadSummaryModelChanged),
332 }
333 self.thread_summary_model = model;
334 }
335
336 pub fn default_model(&self) -> Option<ConfiguredModel> {
337 #[cfg(debug_assertions)]
338 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
339 return None;
340 }
341
342 self.default_model.clone()
343 }
344
345 pub fn inline_assistant_model(&self) -> Option<ConfiguredModel> {
346 #[cfg(debug_assertions)]
347 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
348 return None;
349 }
350
351 self.inline_assistant_model
352 .clone()
353 .or_else(|| self.default_model.clone())
354 }
355
356 pub fn commit_message_model(&self) -> Option<ConfiguredModel> {
357 #[cfg(debug_assertions)]
358 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
359 return None;
360 }
361
362 self.commit_message_model
363 .clone()
364 .or_else(|| self.default_fast_model.clone())
365 .or_else(|| self.default_model.clone())
366 }
367
368 pub fn thread_summary_model(&self) -> Option<ConfiguredModel> {
369 #[cfg(debug_assertions)]
370 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
371 return None;
372 }
373
374 self.thread_summary_model
375 .clone()
376 .or_else(|| self.default_fast_model.clone())
377 .or_else(|| self.default_model.clone())
378 }
379
380 /// The models to use for inline assists. Returns the union of the active
381 /// model and all inline alternatives. When there are multiple models, the
382 /// user will be able to cycle through results.
383 pub fn inline_alternative_models(&self) -> &[Arc<dyn LanguageModel>] {
384 &self.inline_alternatives
385 }
386}
387
388#[cfg(test)]
389mod tests {
390 use super::*;
391 use crate::fake_provider::FakeLanguageModelProvider;
392
393 #[gpui::test]
394 fn test_register_providers(cx: &mut App) {
395 let registry = cx.new(|_| LanguageModelRegistry::default());
396
397 let provider = FakeLanguageModelProvider::default();
398 registry.update(cx, |registry, cx| {
399 registry.register_provider(provider.clone(), cx);
400 });
401
402 let providers = registry.read(cx).providers();
403 assert_eq!(providers.len(), 1);
404 assert_eq!(providers[0].id(), provider.id());
405
406 registry.update(cx, |registry, cx| {
407 registry.unregister_provider(provider.id(), cx);
408 });
409
410 let providers = registry.read(cx).providers();
411 assert!(providers.is_empty());
412 }
413}