此版本仍在开发中,尚不被认为是稳定的。对于最新的快照版本,请使用 Spring AI 1.0.1spring-doc.cadn.net.cn

DeepSeek 聊天

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 Key从 API 密钥页面获取。spring-doc.cadn.net.cn

您可以在application.properties文件:spring-doc.cadn.net.cn

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

为了在处理 API 密钥等敏感信息时增强安全性,您可以使用 Spring Expression Language (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 存储库中。请参阅 Artifact Repositories 部分,将这些存储库添加到您的构建系统中。spring-doc.cadn.net.cn

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

自动配置

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

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

或 Gradlebuild.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次尝试spring-doc.cadn.net.cn

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

10spring-doc.cadn.net.cn

spring.ai.retry.backoff.初始间隔spring-doc.cadn.net.cn

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

2 秒。spring-doc.cadn.net.cn

spring.ai.retry.backoff.乘数spring-doc.cadn.net.cn

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

5spring-doc.cadn.net.cn

spring.ai.retry.backoff.max间隔spring-doc.cadn.net.cn

最大回退持续时间。spring-doc.cadn.net.cn

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

spring.ai.retry.on-client-错误spring-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 状态代码列表(例如,引发 NonTransientAiException)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

spring.ai.retry.on-http-代码spring-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

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.启用spring-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以提供特定于聊天的URLspring-doc.cadn.net.cn

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

/聊天/完成spring-doc.cadn.net.cn

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

测试版功能终结点的前缀路径spring-doc.cadn.net.cn

/试用版spring-doc.cadn.net.cn

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

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

深度搜索聊天spring-doc.cadn.net.cn

spring.ai.deepseek.chat.options.frequency惩罚spring-doc.cadn.net.cn

数字介于 -2.0 和 2.0 之间。正值会根据新标记迄今为止在文本中的现有频率来惩罚它们,从而降低模型逐字重复同一行的可能性。spring-doc.cadn.net.cn

0.0华氏度spring-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.presence惩罚spring-doc.cadn.net.cn

数字介于 -2.0 和 2.0 之间。正值会根据新标记到目前为止是否出现在文本中来惩罚它们,从而增加模型谈论新主题的可能性。spring-doc.cadn.net.cn

0.0华氏度spring-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.0楼spring-doc.cadn.net.cn

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

温度采样的替代方法称为核采样,其中模型考虑具有top_p概率质量的标记的结果。因此,0.1 意味着仅考虑包含前 10% 概率质量的Tokens。我们通常建议更改此温度或温度,但不要同时更改两者。spring-doc.cadn.net.cn

1.0楼spring-doc.cadn.net.cn

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

是否返回输出标记的对数概率。如果为 true,则返回消息内容中返回的每个输出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.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 实例。

Samples控制器(自动配置)

创建一个新的 Spring Boot 项目,并将spring-ai-starter-model-deepseek到你的 pom(或 gradle)依赖项。spring-doc.cadn.net.cn

添加一个application.properties文件src/main/resources目录以启用和配置 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-reasoner)

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

您可以使用DeepSeekAssistantMessage获取由deepseek-reasoner.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(reasoning_content)和最终答案(内容)。在下一轮对话中,前几轮的 CoT 不会串联到上下文中,如下图所示:spring-doc.cadn.net.cn

多模态测试图像

请注意,如果输入消息序列中包含reasoning_content字段,则 API 将返回 400 错误。因此,在发出 API 请求之前,应从 API 响应中删除 reasoning_content 字段,如 API 示例所示。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(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();
}

手动配置

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>

或 Gradlebuild.gradle文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-deepseek'
}
请参阅依赖项管理部分,将 Spring AI BOM 添加到构建文件中。

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

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是一个流畅的期权生成器。spring-doc.cadn.net.cn

低级 DeepSeekApi 客户端

DeepSeekApiDeepSeek API 的轻量级 Java 客户端。spring-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 示例