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 .filter(|provider| provider.is_authenticated(cx))
212 .flat_map(|provider| provider.provided_models(cx))
213 }
214
215 pub fn provider(&self, id: &LanguageModelProviderId) -> Option<Arc<dyn LanguageModelProvider>> {
216 self.providers.get(id).cloned()
217 }
218
219 pub fn select_default_model(&mut self, model: Option<&SelectedModel>, cx: &mut Context<Self>) {
220 let configured_model = model.and_then(|model| self.select_model(model, cx));
221 self.set_default_model(configured_model, cx);
222 }
223
224 pub fn select_inline_assistant_model(
225 &mut self,
226 model: Option<&SelectedModel>,
227 cx: &mut Context<Self>,
228 ) {
229 let configured_model = model.and_then(|model| self.select_model(model, cx));
230 self.set_inline_assistant_model(configured_model, cx);
231 }
232
233 pub fn select_commit_message_model(
234 &mut self,
235 model: Option<&SelectedModel>,
236 cx: &mut Context<Self>,
237 ) {
238 let configured_model = model.and_then(|model| self.select_model(model, cx));
239 self.set_commit_message_model(configured_model, cx);
240 }
241
242 pub fn select_thread_summary_model(
243 &mut self,
244 model: Option<&SelectedModel>,
245 cx: &mut Context<Self>,
246 ) {
247 let configured_model = model.and_then(|model| self.select_model(model, cx));
248 self.set_thread_summary_model(configured_model, cx);
249 }
250
251 /// Selects and sets the inline alternatives for language models based on
252 /// provider name and id.
253 pub fn select_inline_alternative_models(
254 &mut self,
255 alternatives: impl IntoIterator<Item = SelectedModel>,
256 cx: &mut Context<Self>,
257 ) {
258 self.inline_alternatives = alternatives
259 .into_iter()
260 .flat_map(|alternative| {
261 self.select_model(&alternative, cx)
262 .map(|configured_model| configured_model.model)
263 })
264 .collect::<Vec<_>>();
265 }
266
267 pub fn select_model(
268 &mut self,
269 selected_model: &SelectedModel,
270 cx: &mut Context<Self>,
271 ) -> Option<ConfiguredModel> {
272 let provider = self.provider(&selected_model.provider)?;
273 let model = provider
274 .provided_models(cx)
275 .iter()
276 .find(|model| model.id() == selected_model.model)?
277 .clone();
278 Some(ConfiguredModel { provider, model })
279 }
280
281 pub fn set_default_model(&mut self, model: Option<ConfiguredModel>, cx: &mut Context<Self>) {
282 match (self.default_model.as_ref(), model.as_ref()) {
283 (Some(old), Some(new)) if old.is_same_as(new) => {}
284 (None, None) => {}
285 _ => cx.emit(Event::DefaultModelChanged),
286 }
287 self.default_fast_model = maybe!({
288 let provider = &model.as_ref()?.provider;
289 let fast_model = provider.default_fast_model(cx)?;
290 Some(ConfiguredModel {
291 provider: provider.clone(),
292 model: fast_model,
293 })
294 });
295 self.default_model = model;
296 }
297
298 pub fn set_inline_assistant_model(
299 &mut self,
300 model: Option<ConfiguredModel>,
301 cx: &mut Context<Self>,
302 ) {
303 match (self.inline_assistant_model.as_ref(), model.as_ref()) {
304 (Some(old), Some(new)) if old.is_same_as(new) => {}
305 (None, None) => {}
306 _ => cx.emit(Event::InlineAssistantModelChanged),
307 }
308 self.inline_assistant_model = model;
309 }
310
311 pub fn set_commit_message_model(
312 &mut self,
313 model: Option<ConfiguredModel>,
314 cx: &mut Context<Self>,
315 ) {
316 match (self.commit_message_model.as_ref(), model.as_ref()) {
317 (Some(old), Some(new)) if old.is_same_as(new) => {}
318 (None, None) => {}
319 _ => cx.emit(Event::CommitMessageModelChanged),
320 }
321 self.commit_message_model = model;
322 }
323
324 pub fn set_thread_summary_model(
325 &mut self,
326 model: Option<ConfiguredModel>,
327 cx: &mut Context<Self>,
328 ) {
329 match (self.thread_summary_model.as_ref(), model.as_ref()) {
330 (Some(old), Some(new)) if old.is_same_as(new) => {}
331 (None, None) => {}
332 _ => cx.emit(Event::ThreadSummaryModelChanged),
333 }
334 self.thread_summary_model = model;
335 }
336
337 pub fn default_model(&self) -> Option<ConfiguredModel> {
338 #[cfg(debug_assertions)]
339 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
340 return None;
341 }
342
343 self.default_model.clone()
344 }
345
346 pub fn inline_assistant_model(&self) -> Option<ConfiguredModel> {
347 #[cfg(debug_assertions)]
348 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
349 return None;
350 }
351
352 self.inline_assistant_model
353 .clone()
354 .or_else(|| self.default_model.clone())
355 }
356
357 pub fn commit_message_model(&self) -> Option<ConfiguredModel> {
358 #[cfg(debug_assertions)]
359 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
360 return None;
361 }
362
363 self.commit_message_model
364 .clone()
365 .or_else(|| self.default_fast_model.clone())
366 .or_else(|| self.default_model.clone())
367 }
368
369 pub fn thread_summary_model(&self) -> Option<ConfiguredModel> {
370 #[cfg(debug_assertions)]
371 if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
372 return None;
373 }
374
375 self.thread_summary_model
376 .clone()
377 .or_else(|| self.default_fast_model.clone())
378 .or_else(|| self.default_model.clone())
379 }
380
381 /// The models to use for inline assists. Returns the union of the active
382 /// model and all inline alternatives. When there are multiple models, the
383 /// user will be able to cycle through results.
384 pub fn inline_alternative_models(&self) -> &[Arc<dyn LanguageModel>] {
385 &self.inline_alternatives
386 }
387}
388
389#[cfg(test)]
390mod tests {
391 use super::*;
392 use crate::fake_provider::FakeLanguageModelProvider;
393
394 #[gpui::test]
395 fn test_register_providers(cx: &mut App) {
396 let registry = cx.new(|_| LanguageModelRegistry::default());
397
398 let provider = FakeLanguageModelProvider::default();
399 registry.update(cx, |registry, cx| {
400 registry.register_provider(provider.clone(), cx);
401 });
402
403 let providers = registry.read(cx).providers();
404 assert_eq!(providers.len(), 1);
405 assert_eq!(providers[0].id(), provider.id());
406
407 registry.update(cx, |registry, cx| {
408 registry.unregister_provider(provider.id(), cx);
409 });
410
411 let providers = registry.read(cx).providers();
412 assert!(providers.is_empty());
413 }
414}