vercel.rs

  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, 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 vercel::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: LanguageModelProviderId = LanguageModelProviderId::new("vercel");
 29const PROVIDER_NAME: LanguageModelProviderName = LanguageModelProviderName::new("Vercel");
 30
 31#[derive(Default, Clone, Debug, PartialEq)]
 32pub struct VercelSettings {
 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 VercelLanguageModelProvider {
 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 VERCEL_API_KEY_VAR: &str = "VERCEL_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).vercel;
 67        let api_url = if settings.api_url.is_empty() {
 68            vercel::VERCEL_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).vercel;
 88        let api_url = if settings.api_url.is_empty() {
 89            vercel::VERCEL_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).vercel;
112        let api_url = if settings.api_url.is_empty() {
113            vercel::VERCEL_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(VERCEL_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 VercelLanguageModelProvider {
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: vercel::Model) -> Arc<dyn LanguageModel> {
155        Arc::new(VercelLanguageModel {
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 VercelLanguageModelProvider {
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 VercelLanguageModelProvider {
174    fn id(&self) -> LanguageModelProviderId {
175        PROVIDER_ID
176    }
177
178    fn name(&self) -> LanguageModelProviderName {
179        PROVIDER_NAME
180    }
181
182    fn icon(&self) -> IconName {
183        IconName::AiVZero
184    }
185
186    fn default_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
187        Some(self.create_language_model(vercel::Model::default()))
188    }
189
190    fn default_fast_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
191        Some(self.create_language_model(vercel::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 vercel::Model::iter() {
198            if !matches!(model, vercel::Model::Custom { .. }) {
199                models.insert(model.id().to_string(), model);
200            }
201        }
202
203        for model in &AllLanguageModelSettings::get_global(cx)
204            .vercel
205            .available_models
206        {
207            models.insert(
208                model.name.clone(),
209                vercel::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(&self, window: &mut Window, cx: &mut App) -> AnyView {
234        cx.new(|cx| ConfigurationView::new(self.state.clone(), window, cx))
235            .into()
236    }
237
238    fn reset_credentials(&self, cx: &mut App) -> Task<Result<()>> {
239        self.state.update(cx, |state, cx| state.reset_api_key(cx))
240    }
241}
242
243pub struct VercelLanguageModel {
244    id: LanguageModelId,
245    model: vercel::Model,
246    state: gpui::Entity<State>,
247    http_client: Arc<dyn HttpClient>,
248    request_limiter: RateLimiter,
249}
250
251impl VercelLanguageModel {
252    fn stream_completion(
253        &self,
254        request: open_ai::Request,
255        cx: &AsyncApp,
256    ) -> BoxFuture<'static, Result<futures::stream::BoxStream<'static, Result<ResponseStreamEvent>>>>
257    {
258        let http_client = self.http_client.clone();
259        let Ok((api_key, api_url)) = cx.read_entity(&self.state, |state, cx| {
260            let settings = &AllLanguageModelSettings::get_global(cx).vercel;
261            let api_url = if settings.api_url.is_empty() {
262                vercel::VERCEL_API_URL.to_string()
263            } else {
264                settings.api_url.clone()
265            };
266            (state.api_key.clone(), api_url)
267        }) else {
268            return futures::future::ready(Err(anyhow!("App state dropped"))).boxed();
269        };
270
271        let future = self.request_limiter.stream(async move {
272            let Some(api_key) = api_key else {
273                return Err(LanguageModelCompletionError::NoApiKey {
274                    provider: PROVIDER_NAME,
275                });
276            };
277            let request =
278                open_ai::stream_completion(http_client.as_ref(), &api_url, &api_key, request);
279            let response = request.await?;
280            Ok(response)
281        });
282
283        async move { Ok(future.await?.boxed()) }.boxed()
284    }
285}
286
287impl LanguageModel for VercelLanguageModel {
288    fn id(&self) -> LanguageModelId {
289        self.id.clone()
290    }
291
292    fn name(&self) -> LanguageModelName {
293        LanguageModelName::from(self.model.display_name().to_string())
294    }
295
296    fn provider_id(&self) -> LanguageModelProviderId {
297        PROVIDER_ID
298    }
299
300    fn provider_name(&self) -> LanguageModelProviderName {
301        PROVIDER_NAME
302    }
303
304    fn supports_tools(&self) -> bool {
305        true
306    }
307
308    fn supports_images(&self) -> bool {
309        true
310    }
311
312    fn supports_tool_choice(&self, choice: LanguageModelToolChoice) -> bool {
313        match choice {
314            LanguageModelToolChoice::Auto
315            | LanguageModelToolChoice::Any
316            | LanguageModelToolChoice::None => true,
317        }
318    }
319
320    fn telemetry_id(&self) -> String {
321        format!("vercel/{}", self.model.id())
322    }
323
324    fn max_token_count(&self) -> u64 {
325        self.model.max_token_count()
326    }
327
328    fn max_output_tokens(&self) -> Option<u64> {
329        self.model.max_output_tokens()
330    }
331
332    fn count_tokens(
333        &self,
334        request: LanguageModelRequest,
335        cx: &App,
336    ) -> BoxFuture<'static, Result<u64>> {
337        count_vercel_tokens(request, self.model.clone(), cx)
338    }
339
340    fn stream_completion(
341        &self,
342        request: LanguageModelRequest,
343        cx: &AsyncApp,
344    ) -> BoxFuture<
345        'static,
346        Result<
347            futures::stream::BoxStream<
348                'static,
349                Result<LanguageModelCompletionEvent, LanguageModelCompletionError>,
350            >,
351            LanguageModelCompletionError,
352        >,
353    > {
354        let request = crate::provider::open_ai::into_open_ai(
355            request,
356            self.model.id(),
357            self.model.supports_parallel_tool_calls(),
358            self.max_output_tokens(),
359            None,
360        );
361        let completions = self.stream_completion(request, cx);
362        async move {
363            let mapper = crate::provider::open_ai::OpenAiEventMapper::new();
364            Ok(mapper.map_stream(completions.await?).boxed())
365        }
366        .boxed()
367    }
368}
369
370pub fn count_vercel_tokens(
371    request: LanguageModelRequest,
372    model: Model,
373    cx: &App,
374) -> BoxFuture<'static, Result<u64>> {
375    cx.background_spawn(async move {
376        let messages = request
377            .messages
378            .into_iter()
379            .map(|message| tiktoken_rs::ChatCompletionRequestMessage {
380                role: match message.role {
381                    Role::User => "user".into(),
382                    Role::Assistant => "assistant".into(),
383                    Role::System => "system".into(),
384                },
385                content: Some(message.string_contents()),
386                name: None,
387                function_call: None,
388            })
389            .collect::<Vec<_>>();
390
391        match model {
392            Model::Custom { max_tokens, .. } => {
393                let model = if max_tokens >= 100_000 {
394                    // If the max tokens is 100k or more, it is likely the o200k_base tokenizer from gpt4o
395                    "gpt-4o"
396                } else {
397                    // Otherwise fallback to gpt-4, since only cl100k_base and o200k_base are
398                    // supported with this tiktoken method
399                    "gpt-4"
400                };
401                tiktoken_rs::num_tokens_from_messages(model, &messages)
402            }
403            // Map Vercel models to appropriate OpenAI models for token counting
404            // since Vercel uses OpenAI-compatible API
405            Model::VZeroOnePointFiveMedium => {
406                // Vercel v0 is similar to GPT-4o, so use gpt-4o for token counting
407                tiktoken_rs::num_tokens_from_messages("gpt-4o", &messages)
408            }
409        }
410        .map(|tokens| tokens as u64)
411    })
412    .boxed()
413}
414
415struct ConfigurationView {
416    api_key_editor: Entity<SingleLineInput>,
417    state: gpui::Entity<State>,
418    load_credentials_task: Option<Task<()>>,
419}
420
421impl ConfigurationView {
422    fn new(state: gpui::Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
423        let api_key_editor = cx.new(|cx| {
424            SingleLineInput::new(
425                window,
426                cx,
427                "v1:0000000000000000000000000000000000000000000000000",
428            )
429            .label("API key")
430        });
431
432        cx.observe(&state, |_, _, cx| {
433            cx.notify();
434        })
435        .detach();
436
437        let load_credentials_task = Some(cx.spawn_in(window, {
438            let state = state.clone();
439            async move |this, cx| {
440                if let Some(task) = state
441                    .update(cx, |state, cx| state.authenticate(cx))
442                    .log_err()
443                {
444                    // We don't log an error, because "not signed in" is also an error.
445                    let _ = task.await;
446                }
447                this.update(cx, |this, cx| {
448                    this.load_credentials_task = None;
449                    cx.notify();
450                })
451                .log_err();
452            }
453        }));
454
455        Self {
456            api_key_editor,
457            state,
458            load_credentials_task,
459        }
460    }
461
462    fn save_api_key(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
463        let api_key = self
464            .api_key_editor
465            .read(cx)
466            .editor()
467            .read(cx)
468            .text(cx)
469            .trim()
470            .to_string();
471
472        // Don't proceed if no API key is provided and we're not authenticated
473        if api_key.is_empty() && !self.state.read(cx).is_authenticated() {
474            return;
475        }
476
477        let state = self.state.clone();
478        cx.spawn_in(window, async move |_, cx| {
479            state
480                .update(cx, |state, cx| state.set_api_key(api_key, cx))?
481                .await
482        })
483        .detach_and_log_err(cx);
484
485        cx.notify();
486    }
487
488    fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
489        self.api_key_editor.update(cx, |input, cx| {
490            input.editor.update(cx, |editor, cx| {
491                editor.set_text("", window, cx);
492            });
493        });
494
495        let state = self.state.clone();
496        cx.spawn_in(window, async move |_, cx| {
497            state.update(cx, |state, cx| state.reset_api_key(cx))?.await
498        })
499        .detach_and_log_err(cx);
500
501        cx.notify();
502    }
503
504    fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
505        !self.state.read(cx).is_authenticated()
506    }
507}
508
509impl Render for ConfigurationView {
510    fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
511        let env_var_set = self.state.read(cx).api_key_from_env;
512
513        let api_key_section = if self.should_render_editor(cx) {
514            v_flex()
515                .on_action(cx.listener(Self::save_api_key))
516                .child(Label::new("To use Zed's agent with Vercel v0, you need to add an API key. Follow these steps:"))
517                .child(
518                    List::new()
519                        .child(InstructionListItem::new(
520                            "Create one by visiting",
521                            Some("Vercel v0's console"),
522                            Some("https://v0.dev/chat/settings/keys"),
523                        ))
524                        .child(InstructionListItem::text_only(
525                            "Paste your API key below and hit enter to start using the agent",
526                        )),
527                )
528                .child(self.api_key_editor.clone())
529                .child(
530                    Label::new(format!(
531                        "You can also assign the {VERCEL_API_KEY_VAR} environment variable and restart Zed."
532                    ))
533                    .size(LabelSize::Small)
534                    .color(Color::Muted),
535                )
536                .child(
537                    Label::new("Note that Vercel v0 is a custom OpenAI-compatible provider.")
538                        .size(LabelSize::Small)
539                        .color(Color::Muted),
540                )
541                .into_any()
542        } else {
543            h_flex()
544                .mt_1()
545                .p_1()
546                .justify_between()
547                .rounded_md()
548                .border_1()
549                .border_color(cx.theme().colors().border)
550                .bg(cx.theme().colors().background)
551                .child(
552                    h_flex()
553                        .gap_1()
554                        .child(Icon::new(IconName::Check).color(Color::Success))
555                        .child(Label::new(if env_var_set {
556                            format!("API key set in {VERCEL_API_KEY_VAR} environment variable.")
557                        } else {
558                            "API key configured.".to_string()
559                        })),
560                )
561                .child(
562                    Button::new("reset-api-key", "Reset API Key")
563                        .label_size(LabelSize::Small)
564                        .icon(IconName::Undo)
565                        .icon_size(IconSize::Small)
566                        .icon_position(IconPosition::Start)
567                        .layer(ElevationIndex::ModalSurface)
568                        .when(env_var_set, |this| {
569                            this.tooltip(Tooltip::text(format!("To reset your API key, unset the {VERCEL_API_KEY_VAR} environment variable.")))
570                        })
571                        .on_click(cx.listener(|this, _, window, cx| this.reset_api_key(window, cx))),
572                )
573                .into_any()
574        };
575
576        if self.load_credentials_task.is_some() {
577            div().child(Label::new("Loading credentials…")).into_any()
578        } else {
579            v_flex().size_full().child(api_key_section).into_any()
580        }
581    }
582}