此版本仍在开发中，尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT！spring-doc.cn

Mistral AI 聊天

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

Mistral AI 还提供与 OpenAI API 兼容的终端节点。 查看 OpenAI API 兼容性部分，了解如何使用 Spring AI OpenAI 集成与 Mistral 终端节点通信。

先决条件

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

export SPRING_AI_MISTRALAI_API_KEY=<INSERT KEY HERE>

添加存储库和 BOM

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

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

自动配置

Spring AI 为 Mistral AI Chat 客户端提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 文件中：pom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

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

聊天属性

重试属性

前缀用作属性前缀，允许您为 Mistral AI 聊天模型配置重试机制。spring.ai.retryspring-doc.cn

财产 描述 违约

spring.ai.retry.max 次尝试spring-doc.cn

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

10spring-doc.cn

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

指数回退策略的初始休眠持续时间。spring-doc.cn

2 秒spring-doc.cn

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

Backoff interval 乘数。spring-doc.cn

5spring-doc.cn

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

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

3 分钟spring-doc.cn

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

如果为 false，则引发 NonTransientAiException，并且不要尝试重试客户端错误代码4xxspring-doc.cn

假spring-doc.cn

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

不应触发重试的 HTTP 状态代码列表（例如，引发 NonTransientAiException）。spring-doc.cn

空spring-doc.cn

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

应触发重试的 HTTP 状态代码列表（例如，引发 TransientAiException）。spring-doc.cn

空spring-doc.cn

连接属性

前缀用作允许您连接到 OpenAI 的属性前缀。spring.ai.mistralaispring-doc.cn

财产 描述 违约

spring.ai.mistralai.base-urlspring-doc.cn

要连接到的 URLspring-doc.cn

api.mistral.aispring-doc.cn

spring.ai.mistralai.api-keyspring-doc.cn

API 密钥spring-doc.cn

-spring-doc.cn

配置属性

前缀是属性前缀，允许您为 Mistral AI 配置聊天模型实现。spring.ai.mistralai.chatspring-doc.cn

财产 描述 违约

spring.ai.mistralai.chat.enabledspring-doc.cn

启用 Mistral AI 聊天模型。spring-doc.cn

真spring-doc.cn

spring.ai.mistralai.chat.base-urlspring-doc.cn

属性的可选覆盖以提供特定于聊天的 URL。spring.ai.mistralai.base-urlspring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.api-keyspring-doc.cn

的可选覆盖 以提供特定于聊天的 API 密钥。spring.ai.mistralai.api-keyspring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.modelspring-doc.cn

这是要使用的 Mistral AI Chat 模型spring-doc.cn

open-mistral-7b, , , ,open-mixtral-8x7bopen-mixtral-8x22bmistral-small-latestmistral-large-latestspring-doc.cn

spring.ai.mistralai.chat.options.temperaturespring-doc.cn

要使用的采样温度，用于控制生成的完成项的明显创造性。较高的值将使输出更具随机性，而较低的值将使结果更加集中和确定。不建议修改 and 对于相同的 completions 请求，因为这两个设置的交互很难预测。temperaturetop_pspring-doc.cn

0.8spring-doc.cn

spring.ai.mistralai.chat.options.max代币spring-doc.cn

在聊天完成中生成的最大令牌数。输入标记和生成的标记的总长度受模型的上下文长度限制。spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.safePromptspring-doc.cn

指示是否在所有对话之前注入安全提示。spring-doc.cn

假spring-doc.cn

spring.ai.mistralai.chat.options.randomSeedspring-doc.cn

此功能处于 Beta 阶段。如果指定，我们的系统将尽最大努力确定性地采样，以便具有相同种子和参数的重复请求应返回相同的结果。spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.stopspring-doc.cn

如果检测到此令牌，则停止生成。或者在提供数组时检测到这些标记之一。spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.topPspring-doc.cn

使用温度进行采样的替代方法，称为核抽样，其中模型考虑具有top_p概率质量的标记的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的 token。我们通常建议更改此项或同时更改两者。temperaturespring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.responseFormatspring-doc.cn

一个对象，用于指定模型必须输出的格式。设置为 启用 JSON 模式，这保证模型生成的消息是有效的 JSON。{ "type": "json_object" }spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.toolsspring-doc.cn

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

-spring-doc.cn

spring.ai.mistralai.chat.options.toolChoicespring-doc.cn

控制模型调用哪个 （如果有） 函数。 表示模型不会调用函数，而是生成一条消息。 表示模型可以在生成消息或调用函数之间进行选择。指定特定函数 via 会强制模型调用该函数。 是不存在函数时的默认值。 如果存在函数，则为默认值。noneauto{"type: "function", "function": {"name": "my_function"}}noneautospring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.functionsspring-doc.cn

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

-spring-doc.cn

spring.ai.mistralai.chat.options.function回调spring-doc.cn

用于注册 ChatModel 的 Mistral AI 工具函数回调。spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.proxy-tool-callsspring-doc.cn

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

假spring-doc.cn
您可以覆盖 common 和 for the 和 implementations. 如果设置了 and 属性，则优先于公共属性。 如果您想为不同的模型和不同的模型终端节点使用不同的 Mistral AI 账户，这将非常有用。spring.ai.mistralai.base-urlspring.ai.mistralai.api-keyChatModelEmbeddingModelspring.ai.mistralai.chat.base-urlspring.ai.mistralai.chat.api-key
通过向调用添加特定于请求的 Runtime Options，可以在运行时覆盖所有前缀为 的属性。spring.ai.mistralai.chat.optionsPrompt

运行时选项

MistralAiChatOptions.java 提供模型配置，例如要使用的模型、温度、频率损失等。spring-doc.cn

启动时，可以使用 constructor 或 properties 配置默认选项。MistralAiChatModel(api, options)spring.ai.mistralai.chat.options.*spring-doc.cn

在运行时，您可以通过向调用添加新的特定于请求的选项来覆盖默认选项。 例如，要覆盖特定请求的默认型号和温度：Promptspring-doc.cn

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

函数调用

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

OpenAI API 兼容性

Mistral 与 OpenAI API 兼容，您可以使用 Spring AI OpenAI 客户端与 Mistrial 交谈。 为此，您需要将 OpenAI 基本 URL 配置为 Mistral AI 平台：，然后选择一个 Mistral 模型：并设置 Mistral AI API 密钥：。spring.ai.openai.chat.base-url=https://api.mistral.aispring.ai.openai.chat.options.model=mistral-small-latestspring.ai.openai.chat.api-key=<YOUR MISTRAL API KEYspring-doc.cn

查看 MistralWithOpenAiChatModelIT.java 测试，了解在 Spring AI OpenAI 上使用 Mistral 的示例。spring-doc.cn

Samples控制器（自动配置）

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

在目录下添加一个文件，以启用和配置 Mistral AI 聊天模型：application.propertiessrc/main/resourcesspring-doc.cn

spring.ai.mistralai.api-key=YOUR_API_KEY
spring.ai.mistralai.chat.options.model=mistral-small
spring.ai.mistralai.chat.options.temperature=0.7
将 替换为您的 Mistral AI 凭证。api-key

这将创建一个可以注入到类中的实现。 下面是一个使用 chat 模型进行文本生成的简单类的示例。MistralAiChatModel@RestControllerspring-doc.cn

@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 实现 and，并使用低级 MistralAiApi 客户端连接到 Mistral AI 服务。ChatModelStreamingChatModelspring-doc.cn

将依赖项添加到项目的 Maven 文件中：spring-ai-mistral-aipom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

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

接下来，创建一个并将其用于文本生成：MistralAiChatModelspring-doc.cn

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

var chatModel = new MistralAiChatModel(this.mistralAiApi, MistralAiChatOptions.builder()
                .withModel(MistralAiApi.ChatModel.LARGE.getValue())
                .withTemperature(0.4)
                .withMaxTokens(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."));

这提供了聊天请求的配置信息。 这是一个流畅的选项构建器。MistralAiChatOptionsMistralAiChatOptions.Builderspring-doc.cn

低级 MistralAiApi 客户端

MistralAiApi 提供的是 Mistral AI API 的轻量级 Java 客户端。spring-doc.cn

下面是一个简单的代码片段，演示如何以编程方式使用 API：spring-doc.cn

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。spring-doc.cn

MistralAiApi 示例