DeepSeek

DeepSeek Chat

Spring AI 支持 DeepSeek 的各种 AI 语言模型。您可以与 DeepSeek 语言模型交互，并基于 DeepSeek 模型创建多语言会话助手。

前提条件（Prerequisites）

您需要使用 DeepSeek 创建 API 密钥才能访问 DeepSeek 语言模型。

在 DeepSeek 注册页面创建一个账户，并在 API Keys 页面生成一个令牌。

Spring AI 项目定义了一个名为 spring.ai.deepSeek.api-key 的配置属性，您应该将其设置为从 API Keys 页面获得的 API Key 的值。

您可以在 application.properties 文件中设置此配置属性：

spring.ai.deepseek.api-key=<your-deepseek-api-key>

为了提高处理 API Key 等敏感信息时的安全性，可以使用 Spring 表达式语言 (SpEL) 引用自定义环境变量：

# In application.yml
spring:
  ai:
    deepseek:
      api-key: ${DEEPSEEK_API_KEY}

# In your environment or .env file
export DEEPSEEK_API_KEY=<your-deepseek-api-key>

您还可以在 application 代码中以编程方式设置此配置：

// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("DEEPSEEK_API_KEY");

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅存储库部分将这些存储库添加到您的构建系统中。

为了帮助进行依赖管理，Spring AI 提供了 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖管理部分将 Spring AI BOM 添加到您的构建系统。

自动配置（Auto-configuration）

Spring AI 为 DeepSeek 聊天模型提供 Spring Boot 自动配置。要启用它，请在项目的 Maven pom.xml 文件中添加以下依赖项：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-deepseek</artifactId>
</dependency>

或者，在你的 Gradle 构建文件 build.gradle 中添加：

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-deepseek'
}

聊天属性（Chat Properties）

Retry 属性（Retry Properties）

前缀 spring.ai.retry 用作属性前缀，允许您为 DeepSeek Chat 模型配置 retry 机制。

连接属性（Connection Properties）

前缀是 spring.ai.deepseek 的属性，用于配置 DeepSeek 的 链接。

配置属性（Configuration Properties）

前缀是 spring.ai.deepseek.chat 的属性，用于配置 DeepSeek 的 ChatModel 实现。

运行时选项（Runtime Options ）

DeepseekChatOptions .java 提供模型配置，例如要使用的 temperature、maxToken、topP 等。

启动时，可以使用 DeepSeekChatModel (api，options)构造函数或 spring.ai.deepseek.chat.options.* 属性来配置默认选项。

在运行时，您可以通过在 Prompt 调用中添加新的、特定于请求的选项来覆盖默认选项。例如，要覆盖特定请求的默认模型和温度：

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates. Please provide the JSON response without any code block markers such as ```json```.",
        DeepSeekChatOptions.builder()
            .withModel(DeepSeekApi.ChatModel.DEEPSEEK_CHAT.getValue())
            .withTemperature(0.8f)
        .build()
    ));

示例控制器（Sample Controller）

创建一个新的 Spring Boot 项目，并将spring-ai-starter-model-deepseek 添加到 pom (或 gradle) 依赖项中。

在 src/main/resources 目录下添加 application.properties 文件，以启用和配置 DeepSeek Chat 模型：

spring.ai.deepseek.api-key=YOUR_API_KEY
spring.ai.deepseek.chat.options.model=deepseek-chat
spring.ai.deepseek.chat.options.temperature=0.8

将 api-key 替换为 DeepSeek 凭据。

这将创建一个 DeepSeekChatModel 的实现，你可以将其注入到你的类中。下面是一个简单的 @Controller 类的示例，它使用聊天模型来生成文本。

@RestController
public class ChatController {

    private final DeepSeekChatModel chatModel;

    @Autowired
    public ChatController(DeepSeekChatModel chatModel) {
        this.chatModel = chatModel;
    }

    /**
     * 文本生成
     * @param message 提示词
     * @return 响应结果
     */
    @GetMapping("/ai/generate")
    @Operation(summary = "文本生成")
    public Map<String, Object> generate(@RequestParam(value = "message", defaultValue = "你好！") String message) {
        try {
            String response = chatModel.call(message);
            return Map.of(
                "success", true,
                "generation", response,
                "message", "Generated successfully"
            );
        } catch (Exception e) {
            return Map.of(
                "success", false,
                "error", e.getMessage(),
                "message", "Generation failed"
            );
        }
    }

    @GetMapping("/ai/generateStream")
    public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        Prompt prompt = new Prompt(new UserMessage(message));
        return this.chatModel.stream(prompt);
    }

}

聊天前缀完成（Chat Prefix Completion）

Chat Prefix Completion 遵循 Chat Completion API, 其中用户为模型提供助手的前缀消息，以完成剩余的消息。

使用前缀完成时，用户必须确保消息列表中的最后一条消息是 DeepSeekAssistantMessage。

下面是一个完整的 Java 代码示例，用于完成聊天前缀。在这个示例中，我们将助手的前缀消息设置为 ““pythonn”, 以强制模型输出 Python 代码，并将 stop 参数设置为 [“‘”], 以防止模型进行额外的解释。

@RestController
public class CodeGenerateController {

    private final DeepSeekChatModel chatModel;

    @Autowired
    public CodeGenerateController(DeepSeekChatModel chatModel) {
        this.chatModel = chatModel;
    }

    @GetMapping("/ai/generatePythonCode")
    public String generate(@RequestParam(value = "message", defaultValue = "Please write quick sort code") String message) {
        UserMessage userMessage = new UserMessage(message);
        Message assistantMessage = DeepSeekAssistantMessage.prefixAssistantMessage("```python\\n");
        Prompt prompt = new Prompt(List.of(userMessage, assistantMessage), ChatOptions.builder().stopSequences(List.of("```")).build());
        ChatResponse response = chatModel.call(prompt);
        return response.getResult().getOutput().getText();
    }

}

推理模型（deepseek-reasoner）

deepseek-reasoner是 DeepSeek 开发的一种推理模型。在给出最终答案之前，该模型首先生成一个思维链 (CoT), 以提高其响应的准确性。我们的 API 为用户提供了对 deepseek-reasoner 生成的 CoT 内容的访问权限，使他们能够查看、显示和提取这些内容。

您可以使用 DeepSeekAssistantMessage 来获取 deepseek-reasoner 生成的 CoT 内容。

public void deepSeekReasonerExample() {
    DeepSeekChatOptions promptOptions = DeepSeekChatOptions.builder()
            .model(DeepSeekApi.ChatModel.DEEPSEEK_REASONER.getValue())
            .build();
    Prompt prompt = new Prompt("9.11 and 9.8, which is greater?", promptOptions);
    ChatResponse response = chatModel.call(prompt);

    // Get the CoT content generated by deepseek-reasoner, only available when using deepseek-reasoner model
    DeepSeekAssistantMessage deepSeekAssistantMessage = (DeepSeekAssistantMessage) response.getResult().getOutput();
    String reasoningContent = deepSeekAssistantMessage.getReasoningContent();
    String text = deepSeekAssistantMessage.getText();
}

多回合对话推理模型（Reasoning Model Multi-round Conversation）

在每轮对话中，模型都会输出 CoT (reasoning_content) 和最终答案 (content)。在下一轮对话中，前几轮的 CoT 不会被连接到上下文中，如下图所示：

请注意，如果 reasonment_content 字段包含在输入消息序列中，API 将返回 400 错误。因此，应在发出 API 请求之前从 API 响应中删除 reasonment_content 字段，如 API 示例所示。

public String deepSeekReasonerMultiRoundExample() {
    List<Message> messages = new ArrayList<>();
    messages.add(new UserMessage("9.11 and 9.8, which is greater?"));
    DeepSeekChatOptions promptOptions = DeepSeekChatOptions.builder()
            .model(DeepSeekApi.ChatModel.DEEPSEEK_REASONER.getValue())
            .build();

    Prompt prompt = new Prompt(messages, promptOptions);
    ChatResponse response = chatModel.call(prompt);

    DeepSeekAssistantMessage deepSeekAssistantMessage = (DeepSeekAssistantMessage) response.getResult().getOutput();
    String reasoningContent = deepSeekAssistantMessage.getReasoningContent();
    String text = deepSeekAssistantMessage.getText();

    messages.add(new AssistantMessage(Objects.requireNonNull(text)));
    messages.add(new UserMessage("How many Rs are there in the word 'strawberry'?"));
    Prompt prompt2 = new Prompt(messages, promptOptions);
    ChatResponse response2 = chatModel.call(prompt2);

    DeepSeekAssistantMessage deepSeekAssistantMessage2 = (DeepSeekAssistantMessage) response2.getResult().getOutput();
    String reasoningContent2 = deepSeekAssistantMessage2.getReasoningContent();
    return deepSeekAssistantMessage2.getText();
}

手动配置（Manual Configuration）

DeepSeekChatModel 实现了 ChatModel 和 StreamingChatModel, 并使用低级 DeepSeekApi 客户端连接到 DeepSeek 服务。

要启用它，添加 spring-ai-deepseek 依赖到你的项目 Maven pom.xml 文件:

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-deepseek</artifactId>
</dependency>

或者，在你的 Gradle 构建文件 build.gradle 中添加：

dependencies {
    implementation 'org.springframework.ai:spring-ai-deepseek'
}

接下来，创建一个 DeepSeekChatModel 实例，并使用它生成文本响应：

var deepSeekApi = new DeepSeekApi(System.getenv("DEEPSEEK_API_KEY"));

var chatModel = new DeepSeekChatModel(deepSeekApi, DeepSeekChatOptions.builder()
                .withModel(DeepSeekApi.ChatModel.DEEPSEEK_CHAT.getValue())
                .withTemperature(0.4f)
                .withMaxTokens(200)
                .build());

ChatResponse response = chatModel.call(
    new Prompt("Generate the names of 5 famous pirates."));

// Or with streaming responses
Flux<ChatResponse> streamResponse = chatModel.stream(
    new Prompt("Generate the names of 5 famous pirates."));

DeepSeekChatOptions 提供聊天请求的配置信息。DeepSeekChatOptions.Builder 是一个流畅的选项构建器。

轻量级 DeepSeekApi 客户端

DeepSeekApi 是一个适用于 DeepSeek API 的轻量级 Java 客户端。

以下是一个简单的代码片段，展示了如何以编程方式使用 API:

DeepSeekApi deepSeekApi =
    new DeepSeekApi(System.getenv("DEEPSEEK_API_KEY"));

ChatCompletionMessage chatCompletionMessage =
    new ChatCompletionMessage("Hello world", Role.USER);

// Sync request
ResponseEntity<ChatCompletion> response = deepSeekApi.chatCompletionEntity(
    new ChatCompletionRequest(List.of(chatCompletionMessage), DeepSeekApi.ChatModel.DEEPSEEK_CHAT.getValue(), 0.7, false));

// Streaming request
Flux<ChatCompletionChunk> streamResponse = deepSeekApi.chatCompletionStream(
    new ChatCompletionRequest(List.of(chatCompletionMessage), DeepSeekApi.ChatModel.DEEPSEEK_CHAT.getValue(), 0.7, true));