model_selector.rs

  1use std::{cmp::Reverse, rc::Rc, sync::Arc};
  2
  3use acp_thread::{AgentModelInfo, AgentModelList, AgentModelSelector};
  4use agent_client_protocol as acp;
  5use anyhow::Result;
  6use collections::IndexMap;
  7use futures::FutureExt;
  8use fuzzy::{StringMatchCandidate, match_strings};
  9use gpui::{Action, AsyncWindowContext, BackgroundExecutor, DismissEvent, Task, WeakEntity};
 10use ordered_float::OrderedFloat;
 11use picker::{Picker, PickerDelegate};
 12use ui::{
 13    AnyElement, App, Context, IntoElement, ListItem, ListItemSpacing, SharedString, Window,
 14    prelude::*, rems,
 15};
 16use util::ResultExt;
 17
 18pub type AcpModelSelector = Picker<AcpModelPickerDelegate>;
 19
 20pub fn acp_model_selector(
 21    session_id: acp::SessionId,
 22    selector: Rc<dyn AgentModelSelector>,
 23    window: &mut Window,
 24    cx: &mut Context<AcpModelSelector>,
 25) -> AcpModelSelector {
 26    let delegate = AcpModelPickerDelegate::new(session_id, selector, window, cx);
 27    Picker::list(delegate, window, cx)
 28        .show_scrollbar(true)
 29        .width(rems(20.))
 30        .max_height(Some(rems(20.).into()))
 31}
 32
 33enum AcpModelPickerEntry {
 34    Separator(SharedString),
 35    Model(AgentModelInfo),
 36}
 37
 38pub struct AcpModelPickerDelegate {
 39    session_id: acp::SessionId,
 40    selector: Rc<dyn AgentModelSelector>,
 41    filtered_entries: Vec<AcpModelPickerEntry>,
 42    models: Option<AgentModelList>,
 43    selected_index: usize,
 44    selected_model: Option<AgentModelInfo>,
 45    _refresh_models_task: Task<()>,
 46}
 47
 48impl AcpModelPickerDelegate {
 49    fn new(
 50        session_id: acp::SessionId,
 51        selector: Rc<dyn AgentModelSelector>,
 52        window: &mut Window,
 53        cx: &mut Context<AcpModelSelector>,
 54    ) -> Self {
 55        let mut rx = selector.watch(cx);
 56        let refresh_models_task = cx.spawn_in(window, {
 57            let session_id = session_id.clone();
 58            async move |this, cx| {
 59                async fn refresh(
 60                    this: &WeakEntity<Picker<AcpModelPickerDelegate>>,
 61                    session_id: &acp::SessionId,
 62                    cx: &mut AsyncWindowContext,
 63                ) -> Result<()> {
 64                    let (models_task, selected_model_task) = this.update(cx, |this, cx| {
 65                        (
 66                            this.delegate.selector.list_models(cx),
 67                            this.delegate.selector.selected_model(session_id, cx),
 68                        )
 69                    })?;
 70
 71                    let (models, selected_model) = futures::join!(models_task, selected_model_task);
 72
 73                    this.update_in(cx, |this, window, cx| {
 74                        this.delegate.models = models.ok();
 75                        this.delegate.selected_model = selected_model.ok();
 76                        this.refresh(window, cx)
 77                    })
 78                }
 79
 80                refresh(&this, &session_id, cx).await.log_err();
 81                while let Ok(()) = rx.recv().await {
 82                    refresh(&this, &session_id, cx).await.log_err();
 83                }
 84            }
 85        });
 86
 87        Self {
 88            session_id,
 89            selector,
 90            filtered_entries: Vec::new(),
 91            models: None,
 92            selected_model: None,
 93            selected_index: 0,
 94            _refresh_models_task: refresh_models_task,
 95        }
 96    }
 97
 98    pub fn active_model(&self) -> Option<&AgentModelInfo> {
 99        self.selected_model.as_ref()
100    }
101}
102
103impl PickerDelegate for AcpModelPickerDelegate {
104    type ListItem = AnyElement;
105
106    fn match_count(&self) -> usize {
107        self.filtered_entries.len()
108    }
109
110    fn selected_index(&self) -> usize {
111        self.selected_index
112    }
113
114    fn set_selected_index(&mut self, ix: usize, _: &mut Window, cx: &mut Context<Picker<Self>>) {
115        self.selected_index = ix.min(self.filtered_entries.len().saturating_sub(1));
116        cx.notify();
117    }
118
119    fn can_select(
120        &mut self,
121        ix: usize,
122        _window: &mut Window,
123        _cx: &mut Context<Picker<Self>>,
124    ) -> bool {
125        match self.filtered_entries.get(ix) {
126            Some(AcpModelPickerEntry::Model(_)) => true,
127            Some(AcpModelPickerEntry::Separator(_)) | None => false,
128        }
129    }
130
131    fn placeholder_text(&self, _window: &mut Window, _cx: &mut App) -> Arc<str> {
132        "Select a model…".into()
133    }
134
135    fn update_matches(
136        &mut self,
137        query: String,
138        window: &mut Window,
139        cx: &mut Context<Picker<Self>>,
140    ) -> Task<()> {
141        cx.spawn_in(window, async move |this, cx| {
142            let filtered_models = match this
143                .read_with(cx, |this, cx| {
144                    this.delegate.models.clone().map(move |models| {
145                        fuzzy_search(models, query, cx.background_executor().clone())
146                    })
147                })
148                .ok()
149                .flatten()
150            {
151                Some(task) => task.await,
152                None => AgentModelList::Flat(vec![]),
153            };
154
155            this.update_in(cx, |this, window, cx| {
156                this.delegate.filtered_entries =
157                    info_list_to_picker_entries(filtered_models).collect();
158                // Finds the currently selected model in the list
159                let new_index = this
160                    .delegate
161                    .selected_model
162                    .as_ref()
163                    .and_then(|selected| {
164                        this.delegate.filtered_entries.iter().position(|entry| {
165                            if let AcpModelPickerEntry::Model(model_info) = entry {
166                                model_info.id == selected.id
167                            } else {
168                                false
169                            }
170                        })
171                    })
172                    .unwrap_or(0);
173                this.set_selected_index(new_index, Some(picker::Direction::Down), true, window, cx);
174                cx.notify();
175            })
176            .ok();
177        })
178    }
179
180    fn confirm(&mut self, _secondary: bool, window: &mut Window, cx: &mut Context<Picker<Self>>) {
181        if let Some(AcpModelPickerEntry::Model(model_info)) =
182            self.filtered_entries.get(self.selected_index)
183        {
184            self.selector
185                .select_model(self.session_id.clone(), model_info.id.clone(), cx)
186                .detach_and_log_err(cx);
187            self.selected_model = Some(model_info.clone());
188            let current_index = self.selected_index;
189            self.set_selected_index(current_index, window, cx);
190
191            cx.emit(DismissEvent);
192        }
193    }
194
195    fn dismissed(&mut self, window: &mut Window, cx: &mut Context<Picker<Self>>) {
196        cx.defer_in(window, |picker, window, cx| {
197            picker.set_query("", window, cx);
198        });
199    }
200
201    fn render_match(
202        &self,
203        ix: usize,
204        selected: bool,
205        _: &mut Window,
206        cx: &mut Context<Picker<Self>>,
207    ) -> Option<Self::ListItem> {
208        match self.filtered_entries.get(ix)? {
209            AcpModelPickerEntry::Separator(title) => Some(
210                div()
211                    .px_2()
212                    .pb_1()
213                    .when(ix > 1, |this| {
214                        this.mt_1()
215                            .pt_2()
216                            .border_t_1()
217                            .border_color(cx.theme().colors().border_variant)
218                    })
219                    .child(
220                        Label::new(title)
221                            .size(LabelSize::XSmall)
222                            .color(Color::Muted),
223                    )
224                    .into_any_element(),
225            ),
226            AcpModelPickerEntry::Model(model_info) => {
227                let is_selected = Some(model_info) == self.selected_model.as_ref();
228
229                let model_icon_color = if is_selected {
230                    Color::Accent
231                } else {
232                    Color::Muted
233                };
234
235                Some(
236                    ListItem::new(ix)
237                        .inset(true)
238                        .spacing(ListItemSpacing::Sparse)
239                        .toggle_state(selected)
240                        .start_slot::<Icon>(model_info.icon.map(|icon| {
241                            Icon::new(icon)
242                                .color(model_icon_color)
243                                .size(IconSize::Small)
244                        }))
245                        .child(
246                            h_flex()
247                                .w_full()
248                                .pl_0p5()
249                                .gap_1p5()
250                                .w(px(240.))
251                                .child(Label::new(model_info.name.clone()).truncate()),
252                        )
253                        .end_slot(div().pr_3().when(is_selected, |this| {
254                            this.child(
255                                Icon::new(IconName::Check)
256                                    .color(Color::Accent)
257                                    .size(IconSize::Small),
258                            )
259                        }))
260                        .into_any_element(),
261                )
262            }
263        }
264    }
265
266    fn render_footer(
267        &self,
268        _: &mut Window,
269        cx: &mut Context<Picker<Self>>,
270    ) -> Option<gpui::AnyElement> {
271        Some(
272            h_flex()
273                .w_full()
274                .border_t_1()
275                .border_color(cx.theme().colors().border_variant)
276                .p_1()
277                .gap_4()
278                .justify_between()
279                .child(
280                    Button::new("configure", "Configure")
281                        .icon(IconName::Settings)
282                        .icon_size(IconSize::Small)
283                        .icon_color(Color::Muted)
284                        .icon_position(IconPosition::Start)
285                        .on_click(|_, window, cx| {
286                            window.dispatch_action(
287                                zed_actions::agent::OpenSettings.boxed_clone(),
288                                cx,
289                            );
290                        }),
291                )
292                .into_any(),
293        )
294    }
295}
296
297fn info_list_to_picker_entries(
298    model_list: AgentModelList,
299) -> impl Iterator<Item = AcpModelPickerEntry> {
300    match model_list {
301        AgentModelList::Flat(list) => {
302            itertools::Either::Left(list.into_iter().map(AcpModelPickerEntry::Model))
303        }
304        AgentModelList::Grouped(index_map) => {
305            itertools::Either::Right(index_map.into_iter().flat_map(|(group_name, models)| {
306                std::iter::once(AcpModelPickerEntry::Separator(group_name.0))
307                    .chain(models.into_iter().map(AcpModelPickerEntry::Model))
308            }))
309        }
310    }
311}
312
313async fn fuzzy_search(
314    model_list: AgentModelList,
315    query: String,
316    executor: BackgroundExecutor,
317) -> AgentModelList {
318    async fn fuzzy_search_list(
319        model_list: Vec<AgentModelInfo>,
320        query: &str,
321        executor: BackgroundExecutor,
322    ) -> Vec<AgentModelInfo> {
323        let candidates = model_list
324            .iter()
325            .enumerate()
326            .map(|(ix, model)| {
327                StringMatchCandidate::new(ix, &format!("{}/{}", model.id, model.name))
328            })
329            .collect::<Vec<_>>();
330        let mut matches = match_strings(
331            &candidates,
332            query,
333            false,
334            true,
335            100,
336            &Default::default(),
337            executor,
338        )
339        .await;
340
341        matches.sort_unstable_by_key(|mat| {
342            let candidate = &candidates[mat.candidate_id];
343            (Reverse(OrderedFloat(mat.score)), candidate.id)
344        });
345
346        matches
347            .into_iter()
348            .map(|mat| model_list[mat.candidate_id].clone())
349            .collect()
350    }
351
352    match model_list {
353        AgentModelList::Flat(model_list) => {
354            AgentModelList::Flat(fuzzy_search_list(model_list, &query, executor).await)
355        }
356        AgentModelList::Grouped(index_map) => {
357            let groups =
358                futures::future::join_all(index_map.into_iter().map(|(group_name, models)| {
359                    fuzzy_search_list(models, &query, executor.clone())
360                        .map(|results| (group_name, results))
361                }))
362                .await;
363            AgentModelList::Grouped(IndexMap::from_iter(
364                groups
365                    .into_iter()
366                    .filter(|(_, results)| !results.is_empty()),
367            ))
368        }
369    }
370}
371
372#[cfg(test)]
373mod tests {
374    use gpui::TestAppContext;
375
376    use super::*;
377
378    fn create_model_list(grouped_models: Vec<(&str, Vec<&str>)>) -> AgentModelList {
379        AgentModelList::Grouped(IndexMap::from_iter(grouped_models.into_iter().map(
380            |(group, models)| {
381                (
382                    acp_thread::AgentModelGroupName(group.to_string().into()),
383                    models
384                        .into_iter()
385                        .map(|model| acp_thread::AgentModelInfo {
386                            id: acp_thread::AgentModelId(model.to_string().into()),
387                            name: model.to_string().into(),
388                            icon: None,
389                        })
390                        .collect::<Vec<_>>(),
391                )
392            },
393        )))
394    }
395
396    fn assert_models_eq(result: AgentModelList, expected: Vec<(&str, Vec<&str>)>) {
397        let AgentModelList::Grouped(groups) = result else {
398            panic!("Expected LanguageModelInfoList::Grouped, got {:?}", result);
399        };
400
401        assert_eq!(
402            groups.len(),
403            expected.len(),
404            "Number of groups doesn't match"
405        );
406
407        for (i, (expected_group, expected_models)) in expected.iter().enumerate() {
408            let (actual_group, actual_models) = groups.get_index(i).unwrap();
409            assert_eq!(
410                actual_group.0.as_ref(),
411                *expected_group,
412                "Group at position {} doesn't match expected group",
413                i
414            );
415            assert_eq!(
416                actual_models.len(),
417                expected_models.len(),
418                "Number of models in group {} doesn't match",
419                expected_group
420            );
421
422            for (j, expected_model_name) in expected_models.iter().enumerate() {
423                assert_eq!(
424                    actual_models[j].name, *expected_model_name,
425                    "Model at position {} in group {} doesn't match expected model",
426                    j, expected_group
427                );
428            }
429        }
430    }
431
432    #[gpui::test]
433    async fn test_fuzzy_match(cx: &mut TestAppContext) {
434        let models = create_model_list(vec![
435            (
436                "zed",
437                vec![
438                    "Claude 3.7 Sonnet",
439                    "Claude 3.7 Sonnet Thinking",
440                    "gpt-4.1",
441                    "gpt-4.1-nano",
442                ],
443            ),
444            ("openai", vec!["gpt-3.5-turbo", "gpt-4.1", "gpt-4.1-nano"]),
445            ("ollama", vec!["mistral", "deepseek"]),
446        ]);
447
448        // Results should preserve models order whenever possible.
449        // In the case below, `zed/gpt-4.1` and `openai/gpt-4.1` have identical
450        // similarity scores, but `zed/gpt-4.1` was higher in the models list,
451        // so it should appear first in the results.
452        let results = fuzzy_search(models.clone(), "41".into(), cx.executor()).await;
453        assert_models_eq(
454            results,
455            vec![
456                ("zed", vec!["gpt-4.1", "gpt-4.1-nano"]),
457                ("openai", vec!["gpt-4.1", "gpt-4.1-nano"]),
458            ],
459        );
460
461        // Fuzzy search
462        let results = fuzzy_search(models.clone(), "4n".into(), cx.executor()).await;
463        assert_models_eq(
464            results,
465            vec![
466                ("zed", vec!["gpt-4.1-nano"]),
467                ("openai", vec!["gpt-4.1-nano"]),
468            ],
469        );
470    }
471}