Mistral AI 聊天

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

先决条件

您需要在 MistralAI 创建一个 API 来访问 Mistral AI 语言模型。在 MistralAI 注册页面 创建一个帐户，并在 API 密钥页面 生成令牌。Spring AI 项目定义了一个名为 spring.ai.mistralai.api-key 的配置属性，您应该将其设置为从 console.mistral.ai 获取的 API 密钥 的值。导出环境变量是设置该配置属性的一种方法。

export SPRING_AI_MISTRALAI_API_KEY=<INSERT KEY HERE>

添加存储库和 BOM

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

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

自动配置

Spring AI 为 MistralAI 聊天客户端提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到您项目的 Maven pom.xml 文件中

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-mistral-ai-spring-boot-starter</artifactId>
</dependency>

或您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-mistral-ai-spring-boot-starter'
}
请参阅 依赖管理 部分，将 Spring AI BOM 添加到您的构建文件中。

聊天属性

重试属性

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

属性 描述 默认值

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.mistralai` 用作属性前缀，允许您连接到 OpenAI。

属性 描述 默认值

spring.ai.mistralai.base-url

要连接的 URL

api.mistral.ai

spring.ai.mistralai.api-key

API 密钥

-

配置属性

前缀 `spring.ai.mistralai.chat` 是属性前缀，允许您配置 MistralAI 的聊天模型实现。

属性 描述 默认值

spring.ai.mistralai.chat.enabled

启用 MistralAI 聊天模型。

true

spring.ai.mistralai.chat.base-url

可选地覆盖 spring.ai.mistralai.base-url 以提供特定于聊天的 URL

-

spring.ai.mistralai.chat.api-key

可选地覆盖 spring.ai.mistralai.api-key 以提供特定于聊天的 API 密钥

-

spring.ai.mistralai.chat.options.model

这是要使用的 MistralAI 聊天模型

open-mistral-7b, open-mixtral-8x7b, mistral-small-latest, mistral-medium-latest, mistral-large-latest

spring.ai.mistralai.chat.options.temperature

要使用的采样温度，它控制生成的完成的明显创造力。较高的值将使输出更加随机，而较低的值将使结果更加集中和确定性。不建议对相同的完成请求修改温度和 top_p，因为这两个设置的交互作用难以预测。

0.8

spring.ai.mistralai.chat.options.maxTokens

在聊天完成中生成的令牌的最大数量。输入令牌和生成令牌的总长度受模型上下文长度的限制。

-

spring.ai.mistralai.chat.options.safePrompt

指示是否在所有对话之前注入安全提示。

false

spring.ai.mistralai.chat.options.randomSeed

此功能处于 Beta 阶段。如果指定，我们的系统将尽力确定性地进行采样，这样使用相同种子和参数的重复请求应该返回相同的结果。

-

spring.ai.mistralai.chat.options.stop

最多 4 个序列，API 将停止生成更多令牌。

-

spring.ai.mistralai.chat.options.topP

一种替代温度采样的方法，称为核采样，模型会考虑具有最高概率质量的标记的结果。因此，0.1 表示仅考虑包含前 10% 概率质量的标记。我们通常建议更改此值或温度，但不要同时更改两者。

-

spring.ai.mistralai.chat.options.responseFormat

一个对象，指定模型必须输出的格式。设置为 { "type": "json_object" } 将启用 JSON 模式，这将保证模型生成的 message 是有效的 JSON。

-

spring.ai.mistralai.chat.options.tools

模型可以调用的工具列表。目前，仅函数作为工具受支持。使用此选项提供模型可以为其生成 JSON 输入的函数列表。

-

spring.ai.mistralai.chat.options.toolChoice

控制模型调用哪个（如果有）函数。none 表示模型不会调用函数，而是生成 message。auto 表示模型可以在生成 message 或调用函数之间进行选择。通过指定特定函数 {"type: "function", "function": {"name": "my_function"}} 强制模型调用该函数。如果不存在函数，则默认值为 none。如果存在函数，则默认值为 auto。

-

spring.ai.mistralai.chat.options.functions

函数列表，由其名称标识，以在单个提示请求中启用函数调用。具有这些名称的函数必须存在于 functionCallbacks 注册表中。

-

spring.ai.mistralai.chat.options.functionCallbacks

MistralAI 工具函数回调，用于向 ChatModel 注册。

-
您可以覆盖 ChatModel 和 EmbeddingModel 实现的通用 spring.ai.mistralai.base-url 和 spring.ai.mistralai.api-key。如果设置了 spring.ai.mistralai.chat.base-url 和 spring.ai.mistralai.chat.api-key 属性，则优先于通用属性。如果您想对不同的模型和不同的模型端点使用不同的 MistralAI 帐户，这将非常有用。
所有以 spring.ai.mistralai.chat.options 为前缀的属性都可以在运行时通过向 Prompt 调用添加特定于请求的 运行时选项 来覆盖。

运行时选项

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

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

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

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        MistralAiChatOptions.builder()
            .withModel(MistralAiApi.ChatModel.LARGE.getValue())
            .withTemperature(0.5f)
        .build()
    ));
除了特定于模型的 MistralAiChatOptions 之外，您还可以使用可移植的 ChatOptions 实例，该实例使用 ChatOptionsBuilder#builder() 创建。

函数调用

您可以将自定义 Java 函数注册到 MistralAiChatModel，并让 Mistral AI 模型智能地选择输出包含要调用一个或多个已注册函数的参数的 JSON 对象。这是一种将 LLM 功能与外部工具和 API 连接起来的有力技术。阅读更多关于 Mistral AI 函数调用 的信息。

示例控制器（自动配置）

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

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

spring.ai.mistralai.api-key=YOUR_API_KEY
spring.ai.mistralai.chat.options.model=mistral-medium
spring.ai.mistralai.chat.options.temperature=0.7
将 api-key 替换为您的 OpenAI 凭据。

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

@RestController
public class ChatController {

    private final MistralAiChatModel chatModel;

    @Autowired
    public ChatController(MistralAiChatModel 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);
    }
}

手动配置

MistralAiChatModel 实现 ChatModel 和 StreamingChatModel，并使用 低级 MistralAiApi 客户端 连接到 MistralAI 服务。

将 spring-ai-mistral-ai 依赖项添加到您的项目的 Maven pom.xml 文件中

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

或您的 Gradle build.gradle 构建文件中。

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

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

var mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));

var chatModel = new MistralAiChatModel(mistralAiApi, MistralAiChatOptions.builder()
                .withModel(MistralAiApi.ChatModel.LARGE.getValue())
                .withTemperature(0.4f)
                .withMaxToken(200)
                .build());

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

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

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

低级 MistralAiApi 客户端

MistralAiApi 提供的是 Mistral AI API 的轻量级 Java 客户端。

以下是如何以编程方式使用 api 的简单代码片段

MistralAiApi mistralAiApi =
    new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));

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

// Sync request
ResponseEntity<ChatCompletion> response = mistralAiApi.chatCompletionEntity(
    new ChatCompletionRequest(List.of(chatCompletionMessage), MistralAiApi.ChatModel.LARGE.getValue(), 0.8f, false));

// Streaming request
Flux<ChatCompletionChunk> streamResponse = mistralAiApi.chatCompletionStream(
        new ChatCompletionRequest(List.of(chatCompletionMessage), MistralAiApi.ChatModel.LARGE.getValue(), 0.8f, true));

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

MistralAiApi 示例