deepseek.rs

  1use anyhow::{Context as _, Result, anyhow};
  2use collections::{BTreeMap, HashMap};
  3use credentials_provider::CredentialsProvider;
  4use editor::{Editor, EditorElement, EditorStyle};
  5use futures::Stream;
  6use futures::{FutureExt, StreamExt, future::BoxFuture, stream::BoxStream};
  7use gpui::{
  8    AnyView, AppContext as _, AsyncApp, Entity, FontStyle, Subscription, Task, TextStyle,
  9    WhiteSpace,
 10};
 11use http_client::HttpClient;
 12use language_model::{
 13    AuthenticateError, LanguageModel, LanguageModelCompletionError, LanguageModelCompletionEvent,
 14    LanguageModelId, LanguageModelName, LanguageModelProvider, LanguageModelProviderId,
 15    LanguageModelProviderName, LanguageModelProviderState, LanguageModelRequest,
 16    LanguageModelToolChoice, LanguageModelToolResultContent, LanguageModelToolUse, MessageContent,
 17    RateLimiter, Role, StopReason, TokenUsage,
 18};
 19use schemars::JsonSchema;
 20use serde::{Deserialize, Serialize};
 21use settings::{Settings, SettingsStore};
 22use std::pin::Pin;
 23use std::str::FromStr;
 24use std::sync::Arc;
 25use theme::ThemeSettings;
 26use ui::{Icon, IconName, List, prelude::*};
 27use util::ResultExt;
 28
 29use crate::{AllLanguageModelSettings, ui::InstructionListItem};
 30
 31const PROVIDER_ID: LanguageModelProviderId = LanguageModelProviderId::new("deepseek");
 32const PROVIDER_NAME: LanguageModelProviderName = LanguageModelProviderName::new("DeepSeek");
 33const DEEPSEEK_API_KEY_VAR: &str = "DEEPSEEK_API_KEY";
 34
 35#[derive(Default)]
 36struct RawToolCall {
 37    id: String,
 38    name: String,
 39    arguments: String,
 40}
 41
 42#[derive(Default, Clone, Debug, PartialEq)]
 43pub struct DeepSeekSettings {
 44    pub api_url: String,
 45    pub available_models: Vec<AvailableModel>,
 46}
 47
 48#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema)]
 49pub struct AvailableModel {
 50    pub name: String,
 51    pub display_name: Option<String>,
 52    pub max_tokens: u64,
 53    pub max_output_tokens: Option<u64>,
 54}
 55
 56pub struct DeepSeekLanguageModelProvider {
 57    http_client: Arc<dyn HttpClient>,
 58    state: Entity<State>,
 59}
 60
 61pub struct State {
 62    api_key: Option<String>,
 63    api_key_from_env: bool,
 64    _subscription: Subscription,
 65}
 66
 67impl State {
 68    fn is_authenticated(&self) -> bool {
 69        self.api_key.is_some()
 70    }
 71
 72    fn reset_api_key(&self, cx: &mut Context<Self>) -> Task<Result<()>> {
 73        let credentials_provider = <dyn CredentialsProvider>::global(cx);
 74        let api_url = AllLanguageModelSettings::get_global(cx)
 75            .deepseek
 76            .api_url
 77            .clone();
 78        cx.spawn(async move |this, cx| {
 79            credentials_provider
 80                .delete_credentials(&api_url, &cx)
 81                .await
 82                .log_err();
 83            this.update(cx, |this, cx| {
 84                this.api_key = None;
 85                this.api_key_from_env = false;
 86                cx.notify();
 87            })
 88        })
 89    }
 90
 91    fn set_api_key(&mut self, api_key: String, cx: &mut Context<Self>) -> Task<Result<()>> {
 92        let credentials_provider = <dyn CredentialsProvider>::global(cx);
 93        let api_url = AllLanguageModelSettings::get_global(cx)
 94            .deepseek
 95            .api_url
 96            .clone();
 97        cx.spawn(async move |this, cx| {
 98            credentials_provider
 99                .write_credentials(&api_url, "Bearer", api_key.as_bytes(), &cx)
100                .await?;
101            this.update(cx, |this, cx| {
102                this.api_key = Some(api_key);
103                cx.notify();
104            })
105        })
106    }
107
108    fn authenticate(&self, cx: &mut Context<Self>) -> Task<Result<(), AuthenticateError>> {
109        if self.is_authenticated() {
110            return Task::ready(Ok(()));
111        }
112
113        let credentials_provider = <dyn CredentialsProvider>::global(cx);
114        let api_url = AllLanguageModelSettings::get_global(cx)
115            .deepseek
116            .api_url
117            .clone();
118        cx.spawn(async move |this, cx| {
119            let (api_key, from_env) = if let Ok(api_key) = std::env::var(DEEPSEEK_API_KEY_VAR) {
120                (api_key, true)
121            } else {
122                let (_, api_key) = credentials_provider
123                    .read_credentials(&api_url, &cx)
124                    .await?
125                    .ok_or(AuthenticateError::CredentialsNotFound)?;
126                (
127                    String::from_utf8(api_key).context("invalid {PROVIDER_NAME} API key")?,
128                    false,
129                )
130            };
131
132            this.update(cx, |this, cx| {
133                this.api_key = Some(api_key);
134                this.api_key_from_env = from_env;
135                cx.notify();
136            })?;
137
138            Ok(())
139        })
140    }
141}
142
143impl DeepSeekLanguageModelProvider {
144    pub fn new(http_client: Arc<dyn HttpClient>, cx: &mut App) -> Self {
145        let state = cx.new(|cx| State {
146            api_key: None,
147            api_key_from_env: false,
148            _subscription: cx.observe_global::<SettingsStore>(|_this: &mut State, cx| {
149                cx.notify();
150            }),
151        });
152
153        Self { http_client, state }
154    }
155
156    fn create_language_model(&self, model: deepseek::Model) -> Arc<dyn LanguageModel> {
157        Arc::new(DeepSeekLanguageModel {
158            id: LanguageModelId::from(model.id().to_string()),
159            model,
160            state: self.state.clone(),
161            http_client: self.http_client.clone(),
162            request_limiter: RateLimiter::new(4),
163        }) as Arc<dyn LanguageModel>
164    }
165}
166
167impl LanguageModelProviderState for DeepSeekLanguageModelProvider {
168    type ObservableEntity = State;
169
170    fn observable_entity(&self) -> Option<Entity<Self::ObservableEntity>> {
171        Some(self.state.clone())
172    }
173}
174
175impl LanguageModelProvider for DeepSeekLanguageModelProvider {
176    fn id(&self) -> LanguageModelProviderId {
177        PROVIDER_ID
178    }
179
180    fn name(&self) -> LanguageModelProviderName {
181        PROVIDER_NAME
182    }
183
184    fn icon(&self) -> IconName {
185        IconName::AiDeepSeek
186    }
187
188    fn default_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
189        Some(self.create_language_model(deepseek::Model::default()))
190    }
191
192    fn default_fast_model(&self, _cx: &App) -> Option<Arc<dyn LanguageModel>> {
193        Some(self.create_language_model(deepseek::Model::default_fast()))
194    }
195
196    fn provided_models(&self, cx: &App) -> Vec<Arc<dyn LanguageModel>> {
197        let mut models = BTreeMap::default();
198
199        models.insert("deepseek-chat", deepseek::Model::Chat);
200        models.insert("deepseek-reasoner", deepseek::Model::Reasoner);
201
202        for available_model in AllLanguageModelSettings::get_global(cx)
203            .deepseek
204            .available_models
205            .iter()
206        {
207            models.insert(
208                &available_model.name,
209                deepseek::Model::Custom {
210                    name: available_model.name.clone(),
211                    display_name: available_model.display_name.clone(),
212                    max_tokens: available_model.max_tokens,
213                    max_output_tokens: available_model.max_output_tokens,
214                },
215            );
216        }
217
218        models
219            .into_values()
220            .map(|model| self.create_language_model(model))
221            .collect()
222    }
223
224    fn is_authenticated(&self, cx: &App) -> bool {
225        self.state.read(cx).is_authenticated()
226    }
227
228    fn authenticate(&self, cx: &mut App) -> Task<Result<(), AuthenticateError>> {
229        self.state.update(cx, |state, cx| state.authenticate(cx))
230    }
231
232    fn configuration_view(&self, window: &mut Window, cx: &mut App) -> AnyView {
233        cx.new(|cx| ConfigurationView::new(self.state.clone(), window, cx))
234            .into()
235    }
236
237    fn reset_credentials(&self, cx: &mut App) -> Task<Result<()>> {
238        self.state.update(cx, |state, cx| state.reset_api_key(cx))
239    }
240}
241
242pub struct DeepSeekLanguageModel {
243    id: LanguageModelId,
244    model: deepseek::Model,
245    state: Entity<State>,
246    http_client: Arc<dyn HttpClient>,
247    request_limiter: RateLimiter,
248}
249
250impl DeepSeekLanguageModel {
251    fn stream_completion(
252        &self,
253        request: deepseek::Request,
254        cx: &AsyncApp,
255    ) -> BoxFuture<'static, Result<BoxStream<'static, Result<deepseek::StreamResponse>>>> {
256        let http_client = self.http_client.clone();
257        let Ok((api_key, api_url)) = cx.read_entity(&self.state, |state, cx| {
258            let settings = &AllLanguageModelSettings::get_global(cx).deepseek;
259            (state.api_key.clone(), settings.api_url.clone())
260        }) else {
261            return futures::future::ready(Err(anyhow!("App state dropped"))).boxed();
262        };
263
264        let future = self.request_limiter.stream(async move {
265            let api_key = api_key.context("Missing DeepSeek API Key")?;
266            let request =
267                deepseek::stream_completion(http_client.as_ref(), &api_url, &api_key, request);
268            let response = request.await?;
269            Ok(response)
270        });
271
272        async move { Ok(future.await?.boxed()) }.boxed()
273    }
274}
275
276impl LanguageModel for DeepSeekLanguageModel {
277    fn id(&self) -> LanguageModelId {
278        self.id.clone()
279    }
280
281    fn name(&self) -> LanguageModelName {
282        LanguageModelName::from(self.model.display_name().to_string())
283    }
284
285    fn provider_id(&self) -> LanguageModelProviderId {
286        PROVIDER_ID
287    }
288
289    fn provider_name(&self) -> LanguageModelProviderName {
290        PROVIDER_NAME
291    }
292
293    fn supports_tools(&self) -> bool {
294        true
295    }
296
297    fn supports_tool_choice(&self, _choice: LanguageModelToolChoice) -> bool {
298        true
299    }
300
301    fn supports_images(&self) -> bool {
302        false
303    }
304
305    fn telemetry_id(&self) -> String {
306        format!("deepseek/{}", self.model.id())
307    }
308
309    fn max_token_count(&self) -> u64 {
310        self.model.max_token_count()
311    }
312
313    fn max_output_tokens(&self) -> Option<u64> {
314        self.model.max_output_tokens()
315    }
316
317    fn count_tokens(
318        &self,
319        request: LanguageModelRequest,
320        cx: &App,
321    ) -> BoxFuture<'static, Result<u64>> {
322        cx.background_spawn(async move {
323            let messages = request
324                .messages
325                .into_iter()
326                .map(|message| tiktoken_rs::ChatCompletionRequestMessage {
327                    role: match message.role {
328                        Role::User => "user".into(),
329                        Role::Assistant => "assistant".into(),
330                        Role::System => "system".into(),
331                    },
332                    content: Some(message.string_contents()),
333                    name: None,
334                    function_call: None,
335                })
336                .collect::<Vec<_>>();
337
338            tiktoken_rs::num_tokens_from_messages("gpt-4", &messages).map(|tokens| tokens as u64)
339        })
340        .boxed()
341    }
342
343    fn stream_completion(
344        &self,
345        request: LanguageModelRequest,
346        cx: &AsyncApp,
347    ) -> BoxFuture<
348        'static,
349        Result<
350            BoxStream<'static, Result<LanguageModelCompletionEvent, LanguageModelCompletionError>>,
351            LanguageModelCompletionError,
352        >,
353    > {
354        let request = into_deepseek(request, &self.model, self.max_output_tokens());
355        let stream = self.stream_completion(request, cx);
356
357        async move {
358            let mapper = DeepSeekEventMapper::new();
359            Ok(mapper.map_stream(stream.await?).boxed())
360        }
361        .boxed()
362    }
363}
364
365pub fn into_deepseek(
366    request: LanguageModelRequest,
367    model: &deepseek::Model,
368    max_output_tokens: Option<u64>,
369) -> deepseek::Request {
370    let is_reasoner = *model == deepseek::Model::Reasoner;
371
372    let mut messages = Vec::new();
373    for message in request.messages {
374        for content in message.content {
375            match content {
376                MessageContent::Text(text) => messages.push(match message.role {
377                    Role::User => deepseek::RequestMessage::User { content: text },
378                    Role::Assistant => deepseek::RequestMessage::Assistant {
379                        content: Some(text),
380                        tool_calls: Vec::new(),
381                    },
382                    Role::System => deepseek::RequestMessage::System { content: text },
383                }),
384                MessageContent::Thinking { .. } => {}
385                MessageContent::RedactedThinking(_) => {}
386                MessageContent::Image(_) => {}
387                MessageContent::ToolUse(tool_use) => {
388                    let tool_call = deepseek::ToolCall {
389                        id: tool_use.id.to_string(),
390                        content: deepseek::ToolCallContent::Function {
391                            function: deepseek::FunctionContent {
392                                name: tool_use.name.to_string(),
393                                arguments: serde_json::to_string(&tool_use.input)
394                                    .unwrap_or_default(),
395                            },
396                        },
397                    };
398
399                    if let Some(deepseek::RequestMessage::Assistant { tool_calls, .. }) =
400                        messages.last_mut()
401                    {
402                        tool_calls.push(tool_call);
403                    } else {
404                        messages.push(deepseek::RequestMessage::Assistant {
405                            content: None,
406                            tool_calls: vec![tool_call],
407                        });
408                    }
409                }
410                MessageContent::ToolResult(tool_result) => {
411                    match &tool_result.content {
412                        LanguageModelToolResultContent::Text(text) => {
413                            messages.push(deepseek::RequestMessage::Tool {
414                                content: text.to_string(),
415                                tool_call_id: tool_result.tool_use_id.to_string(),
416                            });
417                        }
418                        LanguageModelToolResultContent::Image(_) => {}
419                    };
420                }
421            }
422        }
423    }
424
425    deepseek::Request {
426        model: model.id().to_string(),
427        messages,
428        stream: true,
429        max_tokens: max_output_tokens,
430        temperature: if is_reasoner {
431            None
432        } else {
433            request.temperature
434        },
435        response_format: None,
436        tools: request
437            .tools
438            .into_iter()
439            .map(|tool| deepseek::ToolDefinition::Function {
440                function: deepseek::FunctionDefinition {
441                    name: tool.name,
442                    description: Some(tool.description),
443                    parameters: Some(tool.input_schema),
444                },
445            })
446            .collect(),
447    }
448}
449
450pub struct DeepSeekEventMapper {
451    tool_calls_by_index: HashMap<usize, RawToolCall>,
452}
453
454impl DeepSeekEventMapper {
455    pub fn new() -> Self {
456        Self {
457            tool_calls_by_index: HashMap::default(),
458        }
459    }
460
461    pub fn map_stream(
462        mut self,
463        events: Pin<Box<dyn Send + Stream<Item = Result<deepseek::StreamResponse>>>>,
464    ) -> impl Stream<Item = Result<LanguageModelCompletionEvent, LanguageModelCompletionError>>
465    {
466        events.flat_map(move |event| {
467            futures::stream::iter(match event {
468                Ok(event) => self.map_event(event),
469                Err(error) => vec![Err(LanguageModelCompletionError::from(error))],
470            })
471        })
472    }
473
474    pub fn map_event(
475        &mut self,
476        event: deepseek::StreamResponse,
477    ) -> Vec<Result<LanguageModelCompletionEvent, LanguageModelCompletionError>> {
478        let Some(choice) = event.choices.first() else {
479            return vec![Err(LanguageModelCompletionError::from(anyhow!(
480                "Response contained no choices"
481            )))];
482        };
483
484        let mut events = Vec::new();
485        if let Some(content) = choice.delta.content.clone() {
486            events.push(Ok(LanguageModelCompletionEvent::Text(content)));
487        }
488
489        if let Some(reasoning_content) = choice.delta.reasoning_content.clone() {
490            events.push(Ok(LanguageModelCompletionEvent::Thinking {
491                text: reasoning_content,
492                signature: None,
493            }));
494        }
495
496        if let Some(tool_calls) = choice.delta.tool_calls.as_ref() {
497            for tool_call in tool_calls {
498                let entry = self.tool_calls_by_index.entry(tool_call.index).or_default();
499
500                if let Some(tool_id) = tool_call.id.clone() {
501                    entry.id = tool_id;
502                }
503
504                if let Some(function) = tool_call.function.as_ref() {
505                    if let Some(name) = function.name.clone() {
506                        entry.name = name;
507                    }
508
509                    if let Some(arguments) = function.arguments.clone() {
510                        entry.arguments.push_str(&arguments);
511                    }
512                }
513            }
514        }
515
516        if let Some(usage) = event.usage {
517            events.push(Ok(LanguageModelCompletionEvent::UsageUpdate(TokenUsage {
518                input_tokens: usage.prompt_tokens,
519                output_tokens: usage.completion_tokens,
520                cache_creation_input_tokens: 0,
521                cache_read_input_tokens: 0,
522            })));
523        }
524
525        match choice.finish_reason.as_deref() {
526            Some("stop") => {
527                events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
528            }
529            Some("tool_calls") => {
530                events.extend(self.tool_calls_by_index.drain().map(|(_, tool_call)| {
531                    match serde_json::Value::from_str(&tool_call.arguments) {
532                        Ok(input) => Ok(LanguageModelCompletionEvent::ToolUse(
533                            LanguageModelToolUse {
534                                id: tool_call.id.clone().into(),
535                                name: tool_call.name.as_str().into(),
536                                is_input_complete: true,
537                                input,
538                                raw_input: tool_call.arguments.clone(),
539                            },
540                        )),
541                        Err(error) => Ok(LanguageModelCompletionEvent::ToolUseJsonParseError {
542                            id: tool_call.id.clone().into(),
543                            tool_name: tool_call.name.as_str().into(),
544                            raw_input: tool_call.arguments.into(),
545                            json_parse_error: error.to_string(),
546                        }),
547                    }
548                }));
549
550                events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::ToolUse)));
551            }
552            Some(stop_reason) => {
553                log::error!("Unexpected DeepSeek stop_reason: {stop_reason:?}",);
554                events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
555            }
556            None => {}
557        }
558
559        events
560    }
561}
562
563struct ConfigurationView {
564    api_key_editor: Entity<Editor>,
565    state: Entity<State>,
566    load_credentials_task: Option<Task<()>>,
567}
568
569impl ConfigurationView {
570    fn new(state: Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
571        let api_key_editor = cx.new(|cx| {
572            let mut editor = Editor::single_line(window, cx);
573            editor.set_placeholder_text("sk-00000000000000000000000000000000", cx);
574            editor
575        });
576
577        cx.observe(&state, |_, _, cx| {
578            cx.notify();
579        })
580        .detach();
581
582        let load_credentials_task = Some(cx.spawn({
583            let state = state.clone();
584            async move |this, cx| {
585                if let Some(task) = state
586                    .update(cx, |state, cx| state.authenticate(cx))
587                    .log_err()
588                {
589                    let _ = task.await;
590                }
591
592                this.update(cx, |this, cx| {
593                    this.load_credentials_task = None;
594                    cx.notify();
595                })
596                .log_err();
597            }
598        }));
599
600        Self {
601            api_key_editor,
602            state,
603            load_credentials_task,
604        }
605    }
606
607    fn save_api_key(&mut self, _: &menu::Confirm, _window: &mut Window, cx: &mut Context<Self>) {
608        let api_key = self.api_key_editor.read(cx).text(cx);
609        if api_key.is_empty() {
610            return;
611        }
612
613        let state = self.state.clone();
614        cx.spawn(async move |_, cx| {
615            state
616                .update(cx, |state, cx| state.set_api_key(api_key, cx))?
617                .await
618        })
619        .detach_and_log_err(cx);
620
621        cx.notify();
622    }
623
624    fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
625        self.api_key_editor
626            .update(cx, |editor, cx| editor.set_text("", window, cx));
627
628        let state = self.state.clone();
629        cx.spawn(async move |_, cx| state.update(cx, |state, cx| state.reset_api_key(cx))?.await)
630            .detach_and_log_err(cx);
631
632        cx.notify();
633    }
634
635    fn render_api_key_editor(&self, cx: &mut Context<Self>) -> impl IntoElement {
636        let settings = ThemeSettings::get_global(cx);
637        let text_style = TextStyle {
638            color: cx.theme().colors().text,
639            font_family: settings.ui_font.family.clone(),
640            font_features: settings.ui_font.features.clone(),
641            font_fallbacks: settings.ui_font.fallbacks.clone(),
642            font_size: rems(0.875).into(),
643            font_weight: settings.ui_font.weight,
644            font_style: FontStyle::Normal,
645            line_height: relative(1.3),
646            background_color: None,
647            underline: None,
648            strikethrough: None,
649            white_space: WhiteSpace::Normal,
650            ..Default::default()
651        };
652        EditorElement::new(
653            &self.api_key_editor,
654            EditorStyle {
655                background: cx.theme().colors().editor_background,
656                local_player: cx.theme().players().local(),
657                text: text_style,
658                ..Default::default()
659            },
660        )
661    }
662
663    fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
664        !self.state.read(cx).is_authenticated()
665    }
666}
667
668impl Render for ConfigurationView {
669    fn render(&mut self, _window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
670        let env_var_set = self.state.read(cx).api_key_from_env;
671
672        if self.load_credentials_task.is_some() {
673            div().child(Label::new("Loading credentials...")).into_any()
674        } else if self.should_render_editor(cx) {
675            v_flex()
676                .size_full()
677                .on_action(cx.listener(Self::save_api_key))
678                .child(Label::new("To use DeepSeek in Zed, you need an API key:"))
679                .child(
680                    List::new()
681                        .child(InstructionListItem::new(
682                            "Get your API key from the",
683                            Some("DeepSeek console"),
684                            Some("https://platform.deepseek.com/api_keys"),
685                        ))
686                        .child(InstructionListItem::text_only(
687                            "Paste your API key below and hit enter to start using the assistant",
688                        )),
689                )
690                .child(
691                    h_flex()
692                        .w_full()
693                        .my_2()
694                        .px_2()
695                        .py_1()
696                        .bg(cx.theme().colors().editor_background)
697                        .border_1()
698                        .border_color(cx.theme().colors().border)
699                        .rounded_sm()
700                        .child(self.render_api_key_editor(cx)),
701                )
702                .child(
703                    Label::new(format!(
704                        "Or set the {} environment variable.",
705                        DEEPSEEK_API_KEY_VAR
706                    ))
707                    .size(LabelSize::Small)
708                    .color(Color::Muted),
709                )
710                .into_any()
711        } else {
712            h_flex()
713                .mt_1()
714                .p_1()
715                .justify_between()
716                .rounded_md()
717                .border_1()
718                .border_color(cx.theme().colors().border)
719                .bg(cx.theme().colors().background)
720                .child(
721                    h_flex()
722                        .gap_1()
723                        .child(Icon::new(IconName::Check).color(Color::Success))
724                        .child(Label::new(if env_var_set {
725                            format!("API key set in {}", DEEPSEEK_API_KEY_VAR)
726                        } else {
727                            "API key configured".to_string()
728                        })),
729                )
730                .child(
731                    Button::new("reset-key", "Reset Key")
732                        .label_size(LabelSize::Small)
733                        .icon(Some(IconName::Trash))
734                        .icon_size(IconSize::Small)
735                        .icon_position(IconPosition::Start)
736                        .disabled(env_var_set)
737                        .on_click(
738                            cx.listener(|this, _, window, cx| this.reset_api_key(window, cx)),
739                        ),
740                )
741                .into_any()
742        }
743    }
744}