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(
233        &self,
234        _target_agent: language_model::ConfigurationViewTargetAgent,
235        window: &mut Window,
236        cx: &mut App,
237    ) -> AnyView {
238        cx.new(|cx| ConfigurationView::new(self.state.clone(), window, cx))
239            .into()
240    }
241
242    fn reset_credentials(&self, cx: &mut App) -> Task<Result<()>> {
243        self.state.update(cx, |state, cx| state.reset_api_key(cx))
244    }
245}
246
247pub struct DeepSeekLanguageModel {
248    id: LanguageModelId,
249    model: deepseek::Model,
250    state: Entity<State>,
251    http_client: Arc<dyn HttpClient>,
252    request_limiter: RateLimiter,
253}
254
255impl DeepSeekLanguageModel {
256    fn stream_completion(
257        &self,
258        request: deepseek::Request,
259        cx: &AsyncApp,
260    ) -> BoxFuture<'static, Result<BoxStream<'static, Result<deepseek::StreamResponse>>>> {
261        let http_client = self.http_client.clone();
262        let Ok((api_key, api_url)) = cx.read_entity(&self.state, |state, cx| {
263            let settings = &AllLanguageModelSettings::get_global(cx).deepseek;
264            (state.api_key.clone(), settings.api_url.clone())
265        }) else {
266            return futures::future::ready(Err(anyhow!("App state dropped"))).boxed();
267        };
268
269        let future = self.request_limiter.stream(async move {
270            let api_key = api_key.context("Missing DeepSeek API Key")?;
271            let request =
272                deepseek::stream_completion(http_client.as_ref(), &api_url, &api_key, request);
273            let response = request.await?;
274            Ok(response)
275        });
276
277        async move { Ok(future.await?.boxed()) }.boxed()
278    }
279}
280
281impl LanguageModel for DeepSeekLanguageModel {
282    fn id(&self) -> LanguageModelId {
283        self.id.clone()
284    }
285
286    fn name(&self) -> LanguageModelName {
287        LanguageModelName::from(self.model.display_name().to_string())
288    }
289
290    fn provider_id(&self) -> LanguageModelProviderId {
291        PROVIDER_ID
292    }
293
294    fn provider_name(&self) -> LanguageModelProviderName {
295        PROVIDER_NAME
296    }
297
298    fn supports_tools(&self) -> bool {
299        true
300    }
301
302    fn supports_tool_choice(&self, _choice: LanguageModelToolChoice) -> bool {
303        true
304    }
305
306    fn supports_images(&self) -> bool {
307        false
308    }
309
310    fn telemetry_id(&self) -> String {
311        format!("deepseek/{}", self.model.id())
312    }
313
314    fn max_token_count(&self) -> u64 {
315        self.model.max_token_count()
316    }
317
318    fn max_output_tokens(&self) -> Option<u64> {
319        self.model.max_output_tokens()
320    }
321
322    fn count_tokens(
323        &self,
324        request: LanguageModelRequest,
325        cx: &App,
326    ) -> BoxFuture<'static, Result<u64>> {
327        cx.background_spawn(async move {
328            let messages = request
329                .messages
330                .into_iter()
331                .map(|message| tiktoken_rs::ChatCompletionRequestMessage {
332                    role: match message.role {
333                        Role::User => "user".into(),
334                        Role::Assistant => "assistant".into(),
335                        Role::System => "system".into(),
336                    },
337                    content: Some(message.string_contents()),
338                    name: None,
339                    function_call: None,
340                })
341                .collect::<Vec<_>>();
342
343            tiktoken_rs::num_tokens_from_messages("gpt-4", &messages).map(|tokens| tokens as u64)
344        })
345        .boxed()
346    }
347
348    fn stream_completion(
349        &self,
350        request: LanguageModelRequest,
351        cx: &AsyncApp,
352    ) -> BoxFuture<
353        'static,
354        Result<
355            BoxStream<'static, Result<LanguageModelCompletionEvent, LanguageModelCompletionError>>,
356            LanguageModelCompletionError,
357        >,
358    > {
359        let request = into_deepseek(request, &self.model, self.max_output_tokens());
360        let stream = self.stream_completion(request, cx);
361
362        async move {
363            let mapper = DeepSeekEventMapper::new();
364            Ok(mapper.map_stream(stream.await?).boxed())
365        }
366        .boxed()
367    }
368}
369
370pub fn into_deepseek(
371    request: LanguageModelRequest,
372    model: &deepseek::Model,
373    max_output_tokens: Option<u64>,
374) -> deepseek::Request {
375    let is_reasoner = *model == deepseek::Model::Reasoner;
376
377    let mut messages = Vec::new();
378    for message in request.messages {
379        for content in message.content {
380            match content {
381                MessageContent::Text(text) => messages.push(match message.role {
382                    Role::User => deepseek::RequestMessage::User { content: text },
383                    Role::Assistant => deepseek::RequestMessage::Assistant {
384                        content: Some(text),
385                        tool_calls: Vec::new(),
386                    },
387                    Role::System => deepseek::RequestMessage::System { content: text },
388                }),
389                MessageContent::Thinking { .. } => {}
390                MessageContent::RedactedThinking(_) => {}
391                MessageContent::Image(_) => {}
392                MessageContent::ToolUse(tool_use) => {
393                    let tool_call = deepseek::ToolCall {
394                        id: tool_use.id.to_string(),
395                        content: deepseek::ToolCallContent::Function {
396                            function: deepseek::FunctionContent {
397                                name: tool_use.name.to_string(),
398                                arguments: serde_json::to_string(&tool_use.input)
399                                    .unwrap_or_default(),
400                            },
401                        },
402                    };
403
404                    if let Some(deepseek::RequestMessage::Assistant { tool_calls, .. }) =
405                        messages.last_mut()
406                    {
407                        tool_calls.push(tool_call);
408                    } else {
409                        messages.push(deepseek::RequestMessage::Assistant {
410                            content: None,
411                            tool_calls: vec![tool_call],
412                        });
413                    }
414                }
415                MessageContent::ToolResult(tool_result) => {
416                    match &tool_result.content {
417                        LanguageModelToolResultContent::Text(text) => {
418                            messages.push(deepseek::RequestMessage::Tool {
419                                content: text.to_string(),
420                                tool_call_id: tool_result.tool_use_id.to_string(),
421                            });
422                        }
423                        LanguageModelToolResultContent::Image(_) => {}
424                    };
425                }
426            }
427        }
428    }
429
430    deepseek::Request {
431        model: model.id().to_string(),
432        messages,
433        stream: true,
434        max_tokens: max_output_tokens,
435        temperature: if is_reasoner {
436            None
437        } else {
438            request.temperature
439        },
440        response_format: None,
441        tools: request
442            .tools
443            .into_iter()
444            .map(|tool| deepseek::ToolDefinition::Function {
445                function: deepseek::FunctionDefinition {
446                    name: tool.name,
447                    description: Some(tool.description),
448                    parameters: Some(tool.input_schema),
449                },
450            })
451            .collect(),
452    }
453}
454
455pub struct DeepSeekEventMapper {
456    tool_calls_by_index: HashMap<usize, RawToolCall>,
457}
458
459impl DeepSeekEventMapper {
460    pub fn new() -> Self {
461        Self {
462            tool_calls_by_index: HashMap::default(),
463        }
464    }
465
466    pub fn map_stream(
467        mut self,
468        events: Pin<Box<dyn Send + Stream<Item = Result<deepseek::StreamResponse>>>>,
469    ) -> impl Stream<Item = Result<LanguageModelCompletionEvent, LanguageModelCompletionError>>
470    {
471        events.flat_map(move |event| {
472            futures::stream::iter(match event {
473                Ok(event) => self.map_event(event),
474                Err(error) => vec![Err(LanguageModelCompletionError::from(error))],
475            })
476        })
477    }
478
479    pub fn map_event(
480        &mut self,
481        event: deepseek::StreamResponse,
482    ) -> Vec<Result<LanguageModelCompletionEvent, LanguageModelCompletionError>> {
483        let Some(choice) = event.choices.first() else {
484            return vec![Err(LanguageModelCompletionError::from(anyhow!(
485                "Response contained no choices"
486            )))];
487        };
488
489        let mut events = Vec::new();
490        if let Some(content) = choice.delta.content.clone() {
491            events.push(Ok(LanguageModelCompletionEvent::Text(content)));
492        }
493
494        if let Some(reasoning_content) = choice.delta.reasoning_content.clone() {
495            events.push(Ok(LanguageModelCompletionEvent::Thinking {
496                text: reasoning_content,
497                signature: None,
498            }));
499        }
500
501        if let Some(tool_calls) = choice.delta.tool_calls.as_ref() {
502            for tool_call in tool_calls {
503                let entry = self.tool_calls_by_index.entry(tool_call.index).or_default();
504
505                if let Some(tool_id) = tool_call.id.clone() {
506                    entry.id = tool_id;
507                }
508
509                if let Some(function) = tool_call.function.as_ref() {
510                    if let Some(name) = function.name.clone() {
511                        entry.name = name;
512                    }
513
514                    if let Some(arguments) = function.arguments.clone() {
515                        entry.arguments.push_str(&arguments);
516                    }
517                }
518            }
519        }
520
521        if let Some(usage) = event.usage {
522            events.push(Ok(LanguageModelCompletionEvent::UsageUpdate(TokenUsage {
523                input_tokens: usage.prompt_tokens,
524                output_tokens: usage.completion_tokens,
525                cache_creation_input_tokens: 0,
526                cache_read_input_tokens: 0,
527            })));
528        }
529
530        match choice.finish_reason.as_deref() {
531            Some("stop") => {
532                events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
533            }
534            Some("tool_calls") => {
535                events.extend(self.tool_calls_by_index.drain().map(|(_, tool_call)| {
536                    match serde_json::Value::from_str(&tool_call.arguments) {
537                        Ok(input) => Ok(LanguageModelCompletionEvent::ToolUse(
538                            LanguageModelToolUse {
539                                id: tool_call.id.clone().into(),
540                                name: tool_call.name.as_str().into(),
541                                is_input_complete: true,
542                                input,
543                                raw_input: tool_call.arguments.clone(),
544                            },
545                        )),
546                        Err(error) => Ok(LanguageModelCompletionEvent::ToolUseJsonParseError {
547                            id: tool_call.id.clone().into(),
548                            tool_name: tool_call.name.as_str().into(),
549                            raw_input: tool_call.arguments.into(),
550                            json_parse_error: error.to_string(),
551                        }),
552                    }
553                }));
554
555                events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::ToolUse)));
556            }
557            Some(stop_reason) => {
558                log::error!("Unexpected DeepSeek stop_reason: {stop_reason:?}",);
559                events.push(Ok(LanguageModelCompletionEvent::Stop(StopReason::EndTurn)));
560            }
561            None => {}
562        }
563
564        events
565    }
566}
567
568struct ConfigurationView {
569    api_key_editor: Entity<Editor>,
570    state: Entity<State>,
571    load_credentials_task: Option<Task<()>>,
572}
573
574impl ConfigurationView {
575    fn new(state: Entity<State>, window: &mut Window, cx: &mut Context<Self>) -> Self {
576        let api_key_editor = cx.new(|cx| {
577            let mut editor = Editor::single_line(window, cx);
578            editor.set_placeholder_text("sk-00000000000000000000000000000000", window, cx);
579            editor
580        });
581
582        cx.observe(&state, |_, _, cx| {
583            cx.notify();
584        })
585        .detach();
586
587        let load_credentials_task = Some(cx.spawn({
588            let state = state.clone();
589            async move |this, cx| {
590                if let Some(task) = state
591                    .update(cx, |state, cx| state.authenticate(cx))
592                    .log_err()
593                {
594                    let _ = task.await;
595                }
596
597                this.update(cx, |this, cx| {
598                    this.load_credentials_task = None;
599                    cx.notify();
600                })
601                .log_err();
602            }
603        }));
604
605        Self {
606            api_key_editor,
607            state,
608            load_credentials_task,
609        }
610    }
611
612    fn save_api_key(&mut self, _: &menu::Confirm, _window: &mut Window, cx: &mut Context<Self>) {
613        let api_key = self.api_key_editor.read(cx).text(cx);
614        if api_key.is_empty() {
615            return;
616        }
617
618        let state = self.state.clone();
619        cx.spawn(async move |_, cx| {
620            state
621                .update(cx, |state, cx| state.set_api_key(api_key, cx))?
622                .await
623        })
624        .detach_and_log_err(cx);
625
626        cx.notify();
627    }
628
629    fn reset_api_key(&mut self, window: &mut Window, cx: &mut Context<Self>) {
630        self.api_key_editor
631            .update(cx, |editor, cx| editor.set_text("", window, cx));
632
633        let state = self.state.clone();
634        cx.spawn(async move |_, cx| state.update(cx, |state, cx| state.reset_api_key(cx))?.await)
635            .detach_and_log_err(cx);
636
637        cx.notify();
638    }
639
640    fn render_api_key_editor(&self, cx: &mut Context<Self>) -> impl IntoElement {
641        let settings = ThemeSettings::get_global(cx);
642        let text_style = TextStyle {
643            color: cx.theme().colors().text,
644            font_family: settings.ui_font.family.clone(),
645            font_features: settings.ui_font.features.clone(),
646            font_fallbacks: settings.ui_font.fallbacks.clone(),
647            font_size: rems(0.875).into(),
648            font_weight: settings.ui_font.weight,
649            font_style: FontStyle::Normal,
650            line_height: relative(1.3),
651            background_color: None,
652            underline: None,
653            strikethrough: None,
654            white_space: WhiteSpace::Normal,
655            ..Default::default()
656        };
657        EditorElement::new(
658            &self.api_key_editor,
659            EditorStyle {
660                background: cx.theme().colors().editor_background,
661                local_player: cx.theme().players().local(),
662                text: text_style,
663                ..Default::default()
664            },
665        )
666    }
667
668    fn should_render_editor(&self, cx: &mut Context<Self>) -> bool {
669        !self.state.read(cx).is_authenticated()
670    }
671}
672
673impl Render for ConfigurationView {
674    fn render(&mut self, _window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
675        let env_var_set = self.state.read(cx).api_key_from_env;
676
677        if self.load_credentials_task.is_some() {
678            div().child(Label::new("Loading credentials...")).into_any()
679        } else if self.should_render_editor(cx) {
680            v_flex()
681                .size_full()
682                .on_action(cx.listener(Self::save_api_key))
683                .child(Label::new("To use DeepSeek in Zed, you need an API key:"))
684                .child(
685                    List::new()
686                        .child(InstructionListItem::new(
687                            "Get your API key from the",
688                            Some("DeepSeek console"),
689                            Some("https://platform.deepseek.com/api_keys"),
690                        ))
691                        .child(InstructionListItem::text_only(
692                            "Paste your API key below and hit enter to start using the assistant",
693                        )),
694                )
695                .child(
696                    h_flex()
697                        .w_full()
698                        .my_2()
699                        .px_2()
700                        .py_1()
701                        .bg(cx.theme().colors().editor_background)
702                        .border_1()
703                        .border_color(cx.theme().colors().border)
704                        .rounded_sm()
705                        .child(self.render_api_key_editor(cx)),
706                )
707                .child(
708                    Label::new(format!(
709                        "Or set the {} environment variable.",
710                        DEEPSEEK_API_KEY_VAR
711                    ))
712                    .size(LabelSize::Small)
713                    .color(Color::Muted),
714                )
715                .into_any()
716        } else {
717            h_flex()
718                .mt_1()
719                .p_1()
720                .justify_between()
721                .rounded_md()
722                .border_1()
723                .border_color(cx.theme().colors().border)
724                .bg(cx.theme().colors().background)
725                .child(
726                    h_flex()
727                        .gap_1()
728                        .child(Icon::new(IconName::Check).color(Color::Success))
729                        .child(Label::new(if env_var_set {
730                            format!("API key set in {}", DEEPSEEK_API_KEY_VAR)
731                        } else {
732                            "API key configured".to_string()
733                        })),
734                )
735                .child(
736                    Button::new("reset-key", "Reset Key")
737                        .label_size(LabelSize::Small)
738                        .icon(Some(IconName::Trash))
739                        .icon_size(IconSize::Small)
740                        .icon_position(IconPosition::Start)
741                        .disabled(env_var_set)
742                        .on_click(
743                            cx.listener(|this, _, window, cx| this.reset_api_key(window, cx)),
744                        ),
745                )
746                .into_any()
747        }
748    }
749}