Mistral AI 函数调用（已弃用）

本页描述了函数调用 API 的旧版本，该版本已弃用，并标记为在下一版本中移除。当前版本可在 工具调用 查看。更多信息请参见 迁移指南。

您可以使用 MistralAiChatModel 注册自定义 Java 函数，并让 Mistral AI 模型智能地选择输出一个 JSON 对象，其中包含调用一个或多个已注册函数的参数。这使得您可以将 LLM 能力与外部工具和 API 连接起来。open-mixtral-8x22b、mistral-small-latest 和 mistral-large-latest 模型经过训练，可以检测何时应该调用函数并响应符合函数签名的 JSON。

Mistral AI API 不会直接调用函数；相反，模型会生成 JSON，您可以使用该 JSON 在您的代码中调用函数，并将结果返回给模型以完成对话。

Spring AI 提供了灵活且用户友好的方式来注册和调用自定义函数。通常，自定义函数需要提供函数 name、description 和函数调用 signature（以 JSON Schema 格式）来让模型知道函数期望哪些参数。description 有助于模型理解何时调用函数。

作为开发者，您需要实现一个函数，该函数接收 AI 模型发送的函数调用参数，并将结果返回给模型。您的函数可以进而调用其他第三方服务来提供结果。

Spring AI 使这变得像定义一个返回 java.util.Function 的 @Bean 定义一样简单，并在调用 ChatModel 时将 bean 名称作为选项提供。

在底层，Spring 使用适当的适配器代码包装您的 POJO（即函数），以实现与 AI 模型的交互，从而节省了您编写繁琐的样板代码。底层基础设施的基础是 ToolCallback.java 接口和配套的 Builder 工具类，以简化 Java 回调函数的实现和注册。

工作原理

假设我们希望 AI 模型能够回复它不具备的信息，例如给定位置的当前温度。

我们可以向 AI 模型提供关于我们自己函数的元数据，模型可以在处理您的 prompt 时使用这些函数来检索该信息。

例如，如果在处理 prompt 的过程中，AI 模型确定它需要给定位置温度的额外信息，它将启动一个服务器端生成的请求/响应交互。AI 模型调用客户端函数。AI 模型以 JSON 形式提供方法调用详情，客户端负责执行该函数并返回响应。

Spring AI 极大地简化了您需要编写的支持函数调用的代码。它为您代理了函数调用对话。您可以简单地将您的函数定义作为 @Bean 提供，然后在您的 prompt 选项中提供该函数的 bean 名称。您还可以在 prompt 中引用多个函数 bean 名称。

快速入门

让我们创建一个聊天机器人，它通过调用我们自己的函数来回答问题。为了支持聊天机器人的响应，我们将注册我们自己的函数，该函数接受一个位置并返回该位置的当前天气。

当模型需要回答诸如 "波士顿天气如何？" 的问题时，AI 模型将调用客户端，提供位置值作为要传递给函数的参数。这种类似 RPC 的数据以 JSON 形式传递。

我们的函数会调用一些基于 SaaS 的天气服务 API，并将天气响应返回给模型以完成对话。在本例中，我们将使用一个简单的实现，名为 MockWeatherService，它硬编码了不同位置的温度。

以下 MockWeatherService.java 代表天气服务 API

public class MockWeatherService implements Function<Request, Response> {

	public enum Unit { C, F }
	public record Request(String location, Unit unit) {}
	public record Response(double temp, Unit unit) {}

	public Response apply(Request request) {
		return new Response(30.0, Unit.C);
	}
}

将函数注册为 Bean

使用 MistralAiChatModel 自动配置，您可以通过多种方式将自定义函数注册为 Spring 上下文中的 bean。

我们从描述对 POJO 最友好的选项开始。

普通 Java 函数

在这种方法中，您像定义任何其他 Spring 管理对象一样，在您的应用程序上下文中定义一个 @Bean。

在内部，Spring AI ChatModel 将创建一个 ToolCallback 实例，该实例添加了通过 AI 模型调用的逻辑。@Bean 的名称作为 ChatOption 传递。

@Configuration
static class Config {

	@Bean
	@Description("Get the weather in location") // function description
	public Function<MockWeatherService.Request, MockWeatherService.Response> currentWeather() {
		return new MockWeatherService();
	}

}

@Description 注解是可选的，它提供了函数描述，有助于模型理解何时调用函数。这是一个重要的属性，用于帮助 AI 模型确定要调用哪个客户端函数。

提供函数描述的另一种选择是在 MockWeatherService.Request 上使用 @JsonClassDescription 注解

@Configuration
static class Config {

	@Bean
	public Function<Request, Response> currentWeather() { // bean name as function name
		return new MockWeatherService();
	}

}

@JsonClassDescription("Get the weather in location") // // function description
public record Request(String location, Unit unit) {}

最佳实践是使用信息注解请求对象，以便该函数生成的 JSON Schema 尽可能具有描述性，从而帮助 AI 模型选择正确的函数进行调用。

PaymentStatusBeanIT.java 演示了这种方法。

Mistral AI 的 PaymentStatusBeanOpenAiIT 使用 OpenAI API 实现了相同的功能。在这方面，Mistral AI 与 OpenAI 几乎相同。

ToolCallback 包装器

注册函数的另一种方法是创建一个 FunctionToolCallback，如下所示

@Configuration
static class Config {

	@Bean
	public FunctionToolCallback weatherFunctionInfo() {

    return FunctionToolCallback.builder("CurrentWeather", new MockWeatherService()) // (1) function name and instance
        .description("Get the weather in location") // (2) function description
		.inputType(MockWeatherService.Request.class) // (3) function signature
        .build();
	}

}

它包装了第三方 MockWeatherService 函数，并将其作为 CurrentWeather 函数注册到 MistralAiChatModel。它还提供了描述 (2) 和函数签名 (3)，以告知模型函数期望哪些参数。

默认情况下，响应转换器会执行 Response 对象的 JSON 序列化。
FunctionToolCallback 内部根据 MockWeatherService.Request 类解析函数调用签名。

在 Chat 选项中指定函数

为了让模型知道并调用您的 CurrentWeather 函数，您需要在您的 prompt 请求中启用它

MistralAiChatModel chatModel = ...

UserMessage userMessage = new UserMessage("What's the weather like in Paris?");

ChatResponse response = this.chatModel.call(new Prompt(this.userMessage,
		MistralAiChatOptions.builder().tools("CurrentWeather").build())); // Enable the function

logger.info("Response: {}", response);

上述用户问题将触发对 CurrentWeather 函数的 3 次调用（每个城市一次），最终的响应将是这样的

使用 Prompt 选项注册/调用函数

除了自动配置，您还可以动态地使用您的 Prompt 请求注册回调函数

MistralAiChatModel chatModel = ...

UserMessage userMessage = new UserMessage("What's the weather like in Paris?");

var promptOptions = MistralAiChatOptions.builder()
	.toolCallbacks(List.of(FunctionToolCallback.builder("CurrentWeather", new MockWeatherService()) // (1) function name and instance
        .description("Get the weather in location") // (2) function description
		.inputType(MockWeatherService.Request.class) // (3) function signature
        .build())) // function code
	.build();

ChatResponse response = this.chatModel.call(new Prompt(this.userMessage, this.promptOptions));
对于此请求的持续时间，prompt 中注册的函数默认是启用的。

这种方法允许根据用户输入动态选择要调用的不同函数。

PaymentStatusPromptIT.java 集成测试提供了一个完整的示例，演示了如何使用 MistralAiChatModel 注册函数并在 prompt 请求中使用它。

附录

（博客）使用最新的 Mistral AI API 在 Java 和 Spring AI 中进行函数调用

Mistral AI API 函数调用流程

下图说明了 Mistral AI 低级 API 的 函数调用 流程

mistral ai function calling flow

PaymentStatusFunctionCallingIT.java 提供了如何使用 Mistral AI API 函数调用的完整示例。它基于 Mistral AI 函数调用教程。