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