此版本仍在开发中,尚未被视为稳定版。为了获取最新的快照版本,请使用Spring AI 1.1.3spring-doc.cadn.net.cn

深度搜索聊天

Spring AI 支持来自DeepSeek的多种AI语言模型。您可以与DeepSeek语言模型进行交互,并基于DeepSeek模型创建多语言对话助手。spring-doc.cadn.net.cn

前提条件

您需要在DeepSeek上创建一个API密钥,以便访问DeepSeek的语言模型。spring-doc.cadn.net.cn

DeepSeek注册页面创建一个帐户,并在API密钥页面生成一个Tokens。spring-doc.cadn.net.cn

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

您可以在application.properties文件中设置此配置属性:spring-doc.cadn.net.cn

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

为了在处理API密钥等敏感信息时增强安全性,您可以使用Spring表达式语言(SpEL)引用自定义环境变量:spring-doc.cadn.net.cn

# 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>

您也可以在应用程序代码中以编程方式设置此配置:spring-doc.cadn.net.cn

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

添加仓库和BOM

Spring AI 的构件发布在 Spring Milestone 和 Snapshot 仓库中。 请参阅 构件仓库 部分,将这些仓库添加到您的构建系统中。spring-doc.cadn.net.cn

为了帮助管理依赖关系,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用 Spring AI 的一致版本。请参阅依赖管理部分,将 Spring AI BOM 添加到您的构建系统中。spring-doc.cadn.net.cn

自动配置

Spring AI 为 DeepSeek 聊天模型提供了 Spring Boot 自动配置功能。要启用它,请在项目的 Maven pom.xml 文件中添加以下依赖项:spring-doc.cadn.net.cn

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

或者添加到您的Gradle build.gradle 文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-deepseek'
}
参考以下依赖管理部分,添加Spring AI BOM到你的构建文件中。

聊天属性

重试属性

前缀 spring.ai.retry 用于作为属性前缀,允许您配置DeepSeek聊天模型的重试机制。spring-doc.cadn.net.cn

属性 描述 默认

spring.ai.retry.max-attemptsspring-doc.cadn.net.cn

最大重试次数。spring-doc.cadn.net.cn

10spring-doc.cadn.net.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cadn.net.cn

指数退避策略的初始睡眠时长。spring-doc.cadn.net.cn

2 秒spring-doc.cadn.net.cn

spring.ai.retry.backoff.multiplierspring-doc.cadn.net.cn

退避间隔乘数。spring-doc.cadn.net.cn

5spring-doc.cadn.net.cn

spring.ai.retry.backoff.max-intervalspring-doc.cadn.net.cn

最大退避时长。spring-doc.cadn.net.cn

3 分钟。spring-doc.cadn.net.cn

spring.ai.retry.on-client-errorsspring-doc.cadn.net.cn

如果为false,则抛出NonTransientAiException,且不对4xx客户端错误代码进行重试spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cadn.net.cn

不应触发重试的HTTP状态代码列表(例如,用于抛出非暂时性AI异常)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

spring.ai.retry.on-http-codesspring-doc.cadn.net.cn

应触发重试的HTTP状态码列表(例如,用于抛出TransientAiException)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

连接属性

前缀 spring.ai.deepseek 用于作为属性前缀,以便您连接到DeepSeek。spring-doc.cadn.net.cn

属性 描述 默认

spring.ai.deepseek.base-urlspring-doc.cadn.net.cn

要连接的URLspring-doc.cadn.net.cn

https://api.deepseek.comspring-doc.cadn.net.cn

spring.ai.deepseek.api-keyspring-doc.cadn.net.cn

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

配置属性

前缀 spring.ai.deepseek.chat 是属性前缀,允许您为 DeepSeek 配置聊天模型实现。spring-doc.cadn.net.cn

属性 描述 默认

spring.ai.deepseek.chat.enabledspring-doc.cadn.net.cn

启用DeepSeek聊天模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.deepseek.chat.base-urlspring-doc.cadn.net.cn

可选地,覆盖 `spring.ai.deepseek.base-url` 以提供特定于聊天的URL。spring-doc.cadn.net.cn

https://api.deepseek.com/spring-doc.cadn.net.cn

spring.ai.deepseek.chat.api-keyspring-doc.cadn.net.cn

可选地,覆盖 `spring.ai.deepseek.api-key` 以提供特定于聊天的 API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.deepseek.chat.completions-pathspring-doc.cadn.net.cn

聊天补全端点的路径spring-doc.cadn.net.cn

/chat/completionsspring-doc.cadn.net.cn

spring.ai.deepseek.chat.beta-prefix-pathspring-doc.cadn.net.cn

Beta 特性端点的前缀路径spring-doc.cadn.net.cn

/betaspring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.modelspring-doc.cadn.net.cn

要使用的模型ID。您可以选择deepseek-reasoner或deepseek-chat。spring-doc.cadn.net.cn

deepseek-chatspring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.frequencyPenaltyspring-doc.cadn.net.cn

介于-2.0和2.0之间的数值。正值会根据新词在文本中已有的出现频率对其进行惩罚,从而降低模型重复相同行文的确切概率。spring-doc.cadn.net.cn

0.0fspring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.maxTokensspring-doc.cadn.net.cn

聊天补全时生成的最大Tokens数量。输入Tokens和生成Tokens的总长度受到模型上下文长度的限制。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.presencePenaltyspring-doc.cadn.net.cn

介于-2.0和2.0之间的数值。正值会根据新词是否已出现在文本中对其进行惩罚,从而增加模型谈论新主题的可能性。spring-doc.cadn.net.cn

0.0fspring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.stopspring-doc.cadn.net.cn

最多4个序列,到达这些序列后API将停止生成更多Tokens。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.temperaturespring-doc.cadn.net.cn

使用的采样温度,范围在0到2之间。较高的值,如0.8,将使输出更加随机,而较低的值,如0.2,则会使输出更加集中和确定性更强。我们通常建议调整这个参数或top_p,但不建议同时调整两者。spring-doc.cadn.net.cn

1.0Fspring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.topPspring-doc.cadn.net.cn

一种替代温度采样的方法称为核采样,模型会考虑具有前p概率质量的Tokens结果。因此,0.1意味着只考虑构成前10%概率质量的Tokens。我们通常建议调整这个参数或温度,但不建议同时调整两者。spring-doc.cadn.net.cn

1.0Fspring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.logprobsspring-doc.cadn.net.cn

是否返回输出Tokens的对数概率。如果为真,将返回消息内容中每个输出Tokens的对数概率。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.topLogprobsspring-doc.cadn.net.cn

指定在每个标记位置返回的最可能标记数量的整数,范围从0到20,每个标记都带有相应的对数概率。如果使用此参数,logprobs必须设置为true。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.tool-namesspring-doc.cadn.net.cn

用于在单个提示请求中启用函数调用的工具列表,这些工具通过它们的名称来识别。具有这些名称的工具必须存在于ToolCallback注册表中。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.tool-callbacksspring-doc.cadn.net.cn

向ChatModel注册的工具回调。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.internal-tool-execution-enabledspring-doc.cadn.net.cn

如果为 false,Spring AI 将不内部处理工具调用,而是将它们代理给客户端。此后,处理工具调用、将其分派给适当函数并返回结果的责任在于客户端。如果为 true(默认值),Spring AI 将内部处理函数调用。此设置仅适用于支持函数调用的聊天模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

您可以覆盖通用的 spring.ai.deepseek.base-urlspring.ai.deepseek.api-key,用于 ChatModel 的实现。 如果设置了 spring.ai.deepseek.chat.base-urlspring.ai.deepseek.chat.api-key 属性,它们将优先于通用属性。 这对于希望为不同的模型及模型端点使用不同的DeepSeek账户非常有用。
所有以spring.ai.deepseek.chat.options为前缀的属性都可以通过向Prompt调用中添加请求特定的运行时选项在运行时覆盖。

运行时选项

DeepSeekChatOptions.java 文件提供了模型配置选项,如使用的模型、温度、频率惩罚等。spring-doc.cadn.net.cn

在启动时,默认选项可以通过 DeepSeekChatModel(api, options) 构造函数或 spring.ai.deepseek.chat.options.* 属性进行配置。spring-doc.cadn.net.cn

在运行时,您可以通过向Prompt调用中添加新的、请求特定的选项来覆盖默认选项。 例如,要为特定请求覆盖默认模型和温度:spring-doc.cadn.net.cn

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()
    ));
除模型特定的DeepSeekChatOptions外,您还可以使用通过ChatOptions#builder()创建的便携式ChatOptions实例。

示例控制器(自动配置)

创建一个新的Spring Boot项目,并将spring-boot-starter-web添加到您的pom(或gradle)依赖中。spring-doc.cadn.net.cn

src/main/resources目录下添加一个application.properties文件,以启用并配置DeepSeek聊天模型:spring-doc.cadn.net.cn

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类的例子。spring-doc.cadn.net.cn

@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 = "Tell me a joke") String message) {
        return Map.of("generation", chatModel.call(message));
    }

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

聊天前缀补全

聊天前缀补全功能遵循聊天补全API的规则,用户需提供助手的起始消息内容,以便模型完成剩余消息的生成。spring-doc.cadn.net.cn

在使用前缀补全时,用户必须确保消息列表中的最后一项是DeepSeekAssistantMessage。spring-doc.cadn.net.cn

以下是一个用于聊天前缀补全的完整Java代码示例。在此示例中,我们将助手的前缀消息设置为 "```python\n" 以强制模型输出Python代码,并将stop参数设置为['`']以阻止模型提供额外的解释内容。spring-doc.cadn.net.cn

@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 = "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-推理器)

数字deepseek-reasoner是DeepSeek开发的推理模型。在给出最终答案之前,该模型会先生成一条思维链(Chain of Thought, CoT),以提升回答的准确性。我们的API允许用户访问由deepseek-reasoner生成的CoT内容,使他们能够查看、展示和提炼这一内容。spring-doc.cadn.net.cn

您可以使用DeepSeekAssistantMessage来获取由deepseek-reasoner生成的CoT内容。spring-doc.cadn.net.cn

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

推理模型多轮对话

在对话的每一轮中,模型输出CoT(推理内容)和最终答案(内容)。在下一轮对话中,前几轮的CoT不会被拼接到上下文中,如下图所示:spring-doc.cadn.net.cn

Multimodal Test Image

请注意,如果在输入消息序列中包含了 reasoning_content 字段,API 将返回 400 错误。因此,在发起 API 请求之前,您应如 API 示例所示,从 API 响应中移除 reasoning_content 字段。spring-doc.cadn.net.cn

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(AssistantMessage.builder().content(Objects.requireNonNull(text)).build());
    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();
}

手动配置

DeepSeekChatModel 实现了 ChatModelStreamingChatModel,并使用了 低级DeepSeekApi客户端 连接到DeepSeek服务。spring-doc.cadn.net.cn

spring-ai-deepseek 依赖添加到您项目的 Maven pom.xml 文件中:spring-doc.cadn.net.cn

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

或者添加到您的Gradle build.gradle 文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-deepseek'
}
参考以下依赖管理部分,添加Spring AI BOM到你的构建文件中。

接下来,创建一个DeepSeekChatModel并用它来生成文本:spring-doc.cadn.net.cn

DeepSeekApi deepSeekApi = DeepSeekApi.builder()
        .apiKey(System.getenv("DEEPSEEK_API_KEY"))
        .build();
DeepSeekChatOptions options = DeepSeekChatOptions.builder()
        .model(DeepSeekApi.ChatModel.DEEPSEEK_CHAT.getValue())
        .temperature(0.4)
        .maxTokens(200)
        .build();
DeepSeekChatModel chatModel = DeepSeekChatModel.builder()
        .deepSeekApi(deepSeekApi)
        .defaultOptions(options)
        .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是一个流畅的选项构建器。spring-doc.cadn.net.cn

低级 DeepSeekApi 客户端

DeepSeekApi 是一个轻量级的 Java 客户端,用于DeepSeek APIspring-doc.cadn.net.cn

以下是一个简单示例,展示了如何以编程方式使用API:spring-doc.cadn.net.cn

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

有关更多信息,请参考DeepSeekApi.java的JavaDoc注释。spring-doc.cadn.net.cn

DeepSeekApi 示例