Spring AI 参考文档

模型

聊天模型

DeepSeek

DeepSeek 聊天

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

先决条件

您需要在 DeepSeek 创建一个 API 密钥才能访问 DeepSeek 语言模型。

在 DeepSeek 注册页面创建账户，并在 API 密钥页面生成令牌。

Spring AI 项目定义了一个名为 spring.ai.deepseek.api-key 的配置属性，您应将其设置为从 API 密钥页面获取的 API 密钥值。

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

spring.ai.deepseek.api-key=<您的-deepseek-api-密钥>

为了在处理 API 密钥等敏感信息时增强安全性，您可以使用 Spring Expression Language (SpEL) 来引用自定义环境变量：

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

# 在您的环境或 .env 文件中
export DEEPSEEK_API_KEY=<您的-deepseek-api-密钥>

您也可以在应用程序代码中以编程方式设置此配置：

// 从安全来源或环境变量中检索 API 密钥
String apiKey = System.getenv("DEEPSEEK_API_KEY");

添加仓库和 BOM

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

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

自动配置

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'
}

请参阅依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。

聊天属性

重试属性

前缀 spring.ai.retry 用作属性前缀，允许您配置 DeepSeek 聊天模型的重试机制。

属性	描述	默认值
spring.ai.retry.max-attempts	最大重试次数。	10
spring.ai.retry.backoff.initial-interval	指数退避策略的初始睡眠持续时间。	2 秒
spring.ai.retry.backoff.multiplier	退避间隔乘数。	5
spring.ai.retry.backoff.max-interval	最大退避持续时间。	3 分钟
spring.ai.retry.on-client-errors	如果为 false，则抛出 NonTransientAiException，并且不会对 4xx 客户端错误代码进行重试。	false
spring.ai.retry.exclude-on-http-codes	不应触发重试的 HTTP 状态码列表（例如，抛出 NonTransientAiException）。	空
spring.ai.retry.on-http-codes	应触发重试的 HTTP 状态码列表（例如，抛出 TransientAiException）。	空

连接属性

前缀 spring.ai.deepseek 用作属性前缀，允许您连接到 DeepSeek。

属性	描述	默认值
spring.ai.deepseek.base-url	连接 URL	https://api.deepseek.com
spring.ai.deepseek.api-key	API 密钥	-

配置属性

聊天自动配置的启用和禁用现在通过前缀为 spring.ai.model.chat 的顶级属性进行配置。

启用时，spring.ai.model.chat=deepseek（默认启用）

禁用时，spring.ai.model.chat=none（或任何与 deepseek 不匹配的值）

此更改是为了允许配置多个模型。

前缀 spring.ai.deepseek.chat 是用于配置 DeepSeek 聊天模型实现的属性前缀。

属性	描述	默认值
spring.ai.deepseek.chat.enabled（已移除，不再有效）	启用 DeepSeek 聊天模型。	true
spring.ai.model.chat	启用 DeepSeek 聊天模型。	deepseek
spring.ai.deepseek.chat.base-url	可选覆盖 spring.ai.deepseek.base-url，以提供聊天特定的 URL。	https://api.deepseek.com/
spring.ai.deepseek.chat.api-key	可选覆盖 spring.ai.deepseek.api-key，以提供聊天特定的 API 密钥。	-
spring.ai.deepseek.chat.completions-path	聊天补全端点路径。	/chat/completions
spring.ai.deepseek.chat.beta-prefix-path	Beta 功能端点的前缀路径。	/beta
spring.ai.deepseek.chat.model	要使用的模型 ID。您可以使用 deepseek-v4-flash、deepseek-v4-pro、deepseek-chat 或 deepseek-reasoner。	deepseek-v4-flash
spring.ai.deepseek.chat.frequency-penalty	-2.0 到 2.0 之间的数字。正值会根据新标记在文本中现有的频率对其进行惩罚，从而降低模型逐字重复同一行的可能性。	0.0f
spring.ai.deepseek.chat.max-tokens	聊天补全中生成的最大标记数。输入标记和生成标记的总长度受模型上下文长度的限制。	-
spring.ai.deepseek.chat.presence-penalty	-2.0 到 2.0 之间的数字。正值会根据新标记是否出现在文本中来惩罚它们，从而增加模型谈论新主题的可能性。	0.0f
spring.ai.deepseek.chat.stop	最多 4 个序列，API 将在此处停止生成更多标记。	-
spring.ai.deepseek.chat.temperature	使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）会使输出更随机，而较低的值（如 0.2）会使输出更集中和确定。我们通常建议更改此参数或 top_p，但不要同时更改两者。	1.0F
spring.ai.deepseek.chat.top-p	用温度采样的替代方法，称为核采样，模型考虑 top_p 概率质量的标记结果。因此，0.1 意味着只考虑前 10% 概率质量的标记。我们通常建议更改此参数或温度，但不要同时更改两者。	1.0F
spring.ai.deepseek.chat.logprobs	是否返回输出标记的日志概率。如果为 true，则返回消息内容中每个输出标记的日志概率。	-
spring.ai.deepseek.chat.top-logprobs	介于 0 和 20 之间的整数，指定在每个标记位置返回的最可能标记的数量，每个标记都有相关的日志概率。如果使用此参数，logprobs 必须设置为 true。	-
spring.ai.deepseek.chat.tool-callbacks	要注册到 ChatModel 的工具回调。	-

您可以覆盖常见的 spring.ai.deepseek.base-url 和 spring.ai.deepseek.api-key 用于 ChatModel 实现。如果设置了 spring.ai.deepseek.chat.base-url 和 spring.ai.deepseek.chat.api-key 属性，则优先于公共属性。如果您想为不同的模型和不同的模型端点使用不同的 DeepSeek 账户，这将非常有用。

所有前缀为 spring.ai.deepseek.chat 的属性都可以在运行时通过向 Prompt 调用添加请求特定的运行时选项来覆盖。

运行时选项

DeepSeekChatOptions.java 提供了模型配置，例如要使用的模型、温度、频率惩罚等。

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

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

ChatResponse response = chatModel.call(
    new Prompt(
        "生成 5 位著名海盗的名字。请提供 JSON 响应，不要包含任何代码块标记，如 ```json```。",
        DeepSeekChatOptions.builder()
            .withModel(DeepSeekApi.ChatModel.DEEPSEEK_V4_PRO.getValue())
            .withTemperature(0.8f)
        .build()
    ));

除了模型特定的 DeepSeekChatOptions 之外，您还可以使用通过 ChatOptions#builder() 创建的可移植 ChatOptions 实例。

示例控制器（自动配置）

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

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

spring.ai.deepseek.api-key=您的_API_密钥
spring.ai.deepseek.chat.model=deepseek-v4-pro
spring.ai.deepseek.chat.temperature=0.8

将 api-key 替换为您的 DeepSeek 凭证。

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

@RestController
public class ChatController {

    private final DeepSeekChatModel chatModel;

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

    @GetMapping("/ai/generate")
    public Map generate(@RequestParam(value = "message", defaultValue = "讲个笑话给我听") String message) {
        return Map.of("generation", chatModel.call(message));
    }

    @GetMapping("/ai/generateStream")
    public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "讲个笑话给我听") String message) {
        var prompt = new Prompt(new UserMessage(message));
        return chatModel.stream(prompt);
    }
}

工具调用

您可以向 DeepSeekChatModel 注册自定义 Java 函数，并让 DeepSeek 模型智能地选择输出一个包含参数的 JSON 对象，以调用一个或多个已注册的函数。这是一种将 LLM 功能与外部工具和 API 连接起来的强大技术。了解更多关于工具调用的信息。

DeepSeekChatModel 不在内部执行工具调用。工具执行必须使用以下两种受支持的方法之一在外部处理：

• 带有 ToolCallingAdvisor 的 ChatClient — 这是大多数用例推荐的方法。当存在工具时，ToolCallingAdvisor 会自动注册，并透明地管理工具调用循环。
• 用户控制的工具执行 — 当您需要对循环进行完全控制时（例如，在将工具调用与直接 ChatModel 访问结合时），直接使用 DefaultToolCallingManager。

通过 ChatClient 进行工具调用（推荐）

使用 ChatClient 进行同步和流式工具执行。当存在工具时，ToolCallingAdvisor 会自动注册，因此无需显式配置顾问。

ToolCallback weatherCallback = FunctionToolCallback.builder("getCurrentWeather", new WeatherService())
    .description("获取某个地点的天气")
    .inputType(WeatherService.Request.class)
    .build();

// 同步
String response = ChatClient.create(chatModel)
    .prompt()
    .user("巴黎、东京和纽约的天气怎么样？")
    .tools(weatherCallback)
    .call()
    .content();

// 流式
Flux<String> stream = ChatClient.create(chatModel)
    .prompt()
    .user("巴黎、东京和纽约的天气怎么样？")
    .tools(weatherCallback)
    .stream()
    .content();

用户控制的工具执行

当您需要直接访问 ChatModel API 并希望对工具调用循环进行完全控制时，请使用此模式。直接调用 ChatModel，不使用 ToolCallingAdvisor；自行检查工具调用并使用 ToolCallingManager 驱动循环。

ToolCallingManager toolCallingManager = ToolCallingManager.builder().build();

DeepSeekChatOptions options = DeepSeekChatOptions.builder()
    .toolCallbacks(ToolCallbacks.from(new WeatherService()))
    .build();

Prompt prompt = new Prompt("巴黎、东京和纽约的天气怎么样？", options);
ChatResponse response = chatModel.call(prompt);

while (response.hasToolCalls()) {
    ToolExecutionResult result = toolCallingManager.executeToolCalls(prompt, response);
    prompt = new Prompt(result.conversationHistory(), options);
    response = chatModel.call(prompt);
}

对于流式，使用 MessageAggregator 聚合每个流式响应，以检测跨数据块的工具调用：

AtomicReference<ChatResponse> aggregatedRef = new AtomicReference<>();
new MessageAggregator()
    .aggregate(chatModel.stream(prompt), aggregatedRef::set)
    .collectList().block();

while (aggregatedRef.get().hasToolCalls()) {
    ToolExecutionResult result = toolCallingManager.executeToolCalls(prompt, aggregatedRef.get());
    prompt = new Prompt(result.conversationHistory(), options);
    aggregatedRef.set(null);
    new MessageAggregator()
        .aggregate(chatModel.stream(prompt), aggregatedRef::set)
        .collectList().block();
}

String content = aggregatedRef.get().getResult().getOutput().getText();

聊天前缀补全

聊天前缀补全遵循聊天补全 API，用户提供助手的消息前缀，让模型完成消息的其余部分。

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

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

@RestController
public class CodeGenerateController {

    private final DeepSeekChatModel chatModel;

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

    @GetMapping("/ai/generatePythonCode")
    public String generate(@RequestParam(value = "message", defaultValue = "请写一个快速排序代码") String message) {
        UserMessage userMessage = new UserMessage(message);
        Message assistantMessage = DeepSeekAssistantMessage.builder().content("```python\\n").prefix(true).build();
        Prompt prompt = new Prompt(List.of(userMessage, assistantMessage), ChatOptions.builder().stopSequences(List.of("```")).build());
        ChatResponse response = chatModel.call(prompt);
        return response.getResult().getOutput().getText();
    }
}

推理支持

您可以使用 DeepSeekAssistantMessage 获取支持此功能的模型生成的 CoT 内容。

public void deepSeekReasoningExample() {
    DeepSeekChatOptions promptOptions = DeepSeekChatOptions.builder()
            .build();
    Prompt prompt = new Prompt("9.11 和 9.8，哪个更大？", promptOptions);
    ChatResponse response = chatModel.call(prompt);

    // 获取模型生成的 CoT 内容
    DeepSeekAssistantMessage deepSeekAssistantMessage = (DeepSeekAssistantMessage) response.getResult().getOutput();
    String reasoningContent = deepSeekAssistantMessage.getReasoningContent();
    String text = deepSeekAssistantMessage.getText();
}

推理模型多轮对话

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

（此处应有图例：多模态测试图像）

手动配置

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'
}

请参阅依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。

接下来，创建一个 DeepSeekChatModel 并将其用于文本生成：

DeepSeekApi deepSeekApi = DeepSeekApi.builder()
        .apiKey(System.getenv("DEEPSEEK_API_KEY"))
        .build();
DeepSeekChatOptions options = DeepSeekChatOptions.builder()
        .model(DeepSeekApi.ChatModel.DEEPSEEK_V4_PRO.getValue())
        .temperature(0.4)
        .maxTokens(200)
        .build();
DeepSeekChatModel chatModel = DeepSeekChatModel.builder()
        .deepSeekApi(deepSeekApi)
        .options(options)
        .build();
ChatResponse response = chatModel.call(
    new Prompt("生成 5 位著名海盗的名字。"));

// 或者使用流式响应
Flux<ChatResponse> streamResponse = chatModel.stream(
    new Prompt("生成 5 位著名海盗的名字。"));

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);

// 同步请求
ResponseEntity<ChatCompletion> response = deepSeekApi.chatCompletionEntity(
    new ChatCompletionRequest(List.of(chatCompletionMessage), DeepSeekApi.ChatModel.DEEPSEEK_V4_FLASH.getValue(), 0.7, false));

// 流式请求
Flux<ChatCompletionChunk> streamResponse = deepSeekApi.chatCompletionStream(
    new ChatCompletionRequest(List.of(chatCompletionMessage), DeepSeekApi.ChatModel.DEEPSEEK_V4_FLASH.getValue(), 0.7, true));

有关更多信息，请遵循 DeepSeekApi.java 的 JavaDoc。

DeepSeekApi 示例

DeepSeekApiIT.java 测试提供了关于如何使用这个轻量级库的一些常规示例。