Mistral AI 聊天

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

Mistral AI 也提供一个兼容 OpenAI API 的端点。 请查看 _openai_api_compatibility 部分，了解如何使用 Spring AI OpenAI 集成来与 Mistral 端点对话。

先决条件

你需要使用 Mistral AI 创建一个 API 才能访问 Mistral AI 语言模型。

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

Spring AI 项目定义了一个名为 spring.ai.mistralai.api-key 的配置属性，你应该将其设置为从 console.mistral.ai 获取的 API Key 值。

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

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

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

# In application.yml
spring:
  ai:
    mistralai:
      api-key: ${MISTRALAI_API_KEY}
# In your environment or .env file
export MISTRALAI_API_KEY=<your-mistralai-api-key>

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

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

添加仓库和 BOM

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

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

自动配置

Spring AI 自动配置、启动器模块的工件名称发生了重大变化。 有关更多信息，请参阅 升级说明。

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

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

或添加到你的 Gradle build.gradle 构建文件中。

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

请参阅 依赖管理 部分，将 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

不应触发重试（例如抛出 NonTransientAiException）的 HTTP 状态代码列表。

空

spring.ai.retry.on-http-codes

应触发重试（例如抛出 TransientAiException）的 HTTP 状态代码列表。

空

连接属性

前缀 spring.ai.mistralai 用作属性前缀，允许你连接到 OpenAI。

属性 描述 默认值

spring.ai.mistralai.base-url

要连接的 URL

[role="bare"][role="bare"]https://api.mistral.ai

spring.ai.mistralai.api-key

API 密钥

-

配置属性

聊天自动配置的启用和禁用现在通过前缀为 spring.ai.model.chat 的顶级属性进行配置。 要启用，spring.ai.model.chat=mistral（默认启用） 要禁用，spring.ai.model.chat=none（或任何与 mistral 不匹配的值） 此更改是为了允许配置多个模型。

前缀 spring.ai.mistralai.chat 是属性前缀，允许你配置 Mistral AI 的聊天模型实现。

属性 描述 默认值

spring.ai.mistralai.chat.enabled (已移除且不再有效)

启用 Mistral AI 聊天模型。

true

spring.ai.model.chat

启用 Mistral AI 聊天模型。

mistral

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

这是要使用的 Mistral AI 聊天模型

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

spring.ai.mistralai.chat.options.temperature

用于控制生成完成的表观创造性的采样温度。较高的值会使输出更随机，而较低的值会使结果更集中和确定。不建议为相同的完成请求修改 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

如果检测到此令牌，则停止生成。或者，如果提供数组时检测到其中一个令牌。

-

spring.ai.mistralai.chat.options.topP

采样温度的替代方案，称为核采样，模型考虑具有 top_p 概率质量的令牌结果。因此 0.1 表示只考虑构成前 10% 概率质量的令牌。我们通常建议更改此项或 temperature，但不要同时更改两者。

-

spring.ai.mistralai.chat.options.responseFormat

指定模型必须输出的格式的对象。设置为 { "type": "json_object" } 可启用 JSON 模式，该模式保证模型生成的消息是有效的 JSON。

-

spring.ai.mistralai.chat.options.tools

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

-

spring.ai.mistralai.chat.options.toolChoice

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

-

spring.ai.mistralai.chat.options.functions

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

-

spring.ai.mistralai.chat.options.functionCallbacks

要注册到 ChatModel 的 Mistral AI 工具函数回调。

-

spring.ai.mistralai.chat.options.proxy-tool-calls

如果为 true，则 Spring AI 将不会在内部处理函数调用，而是将它们代理到客户端。然后由客户端负责处理函数调用，将它们分派到适当的函数，并返回结果。如果为 false（默认值），Spring AI 将在内部处理函数调用。仅适用于支持函数调用的聊天模型

false

你可以覆盖 ChatModel 和 EmbeddingModel 实现的通用 spring.ai.mistralai.base-url 和 spring.ai.mistralai.api-key。 如果设置了 spring.ai.mistralai.chat.base-url 和 spring.ai.mistralai.chat.api-key 属性，它们将优先于通用属性。 如果你想为不同的模型和不同的模型端点使用不同的 Mistral AI 账户，这会很有用。

所有以 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()
            .model(MistralAiApi.ChatModel.LARGE.getValue())
            .temperature(0.5)
        .build()
    ));

除了模型特定的 MistralAiChatOptions 之外，你还可以使用可移植的 ChatOptions 实例，该实例使用 ChatOptions#builder() 创建。

函数调用

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

多模态

多模态是指模型同时理解和处理来自各种来源（包括文本、图像、音频和其他数据格式）信息的能力。 Mistral AI 支持文本和视觉模态。

视觉

提供视觉多模态支持的 Mistral AI 模型包括 pixtral-large-latest。 有关更多信息，请参阅 视觉 指南。

Mistral AI 的 用户消息 API 可以将 base64 编码的图像列表或图像 URL 与消息一起包含在内。 Spring AI 的 Message 接口通过引入 Media 类型来促进多模态 AI 模型。 此类型包含消息中媒体附件的数据和详细信息，利用 Spring 的 org.springframework.util.MimeType 和 org.springframework.core.io.Resource 用于原始媒体数据。

下面是摘自 MistralAiChatModelIT.java 的代码示例，展示了用户文本与图像的融合。

var imageResource = new ClassPathResource("/multimodal.test.png");

var userMessage = new UserMessage("Explain what do you see on this picture?",
        new Media(MimeTypeUtils.IMAGE_PNG, this.imageResource));

ChatResponse response = chatModel.call(new Prompt(this.userMessage,
        ChatOptions.builder().model(MistralAiApi.ChatModel.PIXTRAL_LARGE.getValue()).build()));

或等效的图像 URL：

var userMessage = new UserMessage("Explain what do you see on this picture?",
        new Media(MimeTypeUtils.IMAGE_PNG,
                URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png")));

ChatResponse response = chatModel.call(new Prompt(this.userMessage,
        ChatOptions.builder().model(MistralAiApi.ChatModel.PIXTRAL_LARGE.getValue()).build()));

你也可以传递多张图像。

该示例展示了一个模型将 multimodal.test.png 图像作为输入：

multimodal.test

以及文本消息“解释你在这张图片上看到了什么？”，并生成如下响应：

This is an image of a fruit bowl with a simple design. The bowl is made of metal with curved wire edges that
create an open structure, allowing the fruit to be visible from all angles. Inside the bowl, there are two
yellow bananas resting on top of what appears to be a red apple. The bananas are slightly overripe, as
indicated by the brown spots on their peels. The bowl has a metal ring at the top, likely to serve as a handle
for carrying. The bowl is placed on a flat surface with a neutral-colored background that provides a clear
view of the fruit inside.

OpenAI API 兼容性

Mistral 与 OpenAI API 兼容，你可以使用 Spring AI OpenAI 客户端与 Mistral 对话。 为此，你需要将 OpenAI 基本 URL 配置为 Mistral AI 平台：spring.ai.openai.chat.base-url=https://api.mistral.ai，并选择一个 Mistral 模型：spring.ai.openai.chat.options.model=mistral-small-latest，并设置 Mistral AI API 密钥：spring.ai.openai.chat.api-key=<YOUR MISTRAL API KEY。

请查看 MistralWithOpenAiChatModelIT.java 测试，了解通过 Spring AI OpenAI 使用 Mistral 的示例。

示例控制器（自动配置）

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

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

spring.ai.mistralai.api-key=YOUR_API_KEY
spring.ai.mistralai.chat.options.model=mistral-small
spring.ai.mistralai.chat.options.temperature=0.7

将 api-key 替换为你的 Mistral AI 凭据。

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

@RestController
public class ChatController {

    private final MistralAiChatModel chatModel;

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

    @GetMapping("/ai/generate")
    public Map<String,String> generate(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        return Map.of("generation", this.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 this.chatModel.stream(prompt);
    }
}

手动配置

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

将 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(this.mistralAiApi, MistralAiChatOptions.builder()
                .model(MistralAiApi.ChatModel.LARGE.getValue())
                .temperature(0.4)
                .maxTokens(200)
                .build());

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

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

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

低级 MistralAiApi 客户端

MistralAiApi 提供了一个轻量级 Java 客户端，用于 Mistral AI API。

这是一个显示如何以编程方式使用 API 的简单代码片段：

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

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

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

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

请遵循 MistralAiApi.java 的 JavaDoc 以获取更多信息。

MistralAiApi 示例