Mistral AI 函数调用（已弃用）
本页面描述的是旧版本的 Function Calling API，该版本已被弃用，并计划在下一个版本中移除。当前版本可在 Tool Calling 获取。更多信息请参阅 迁移指南。
你可以使用 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 模式表示），以便让模型知道该函数期望的参数。description 则帮助模型理解何时调用该函数。
作为开发人员，你需要实现一个函数，该函数接收从 AI 模型发送的函数调用参数，并将结果返回给模型。你的函数可以反过来调用其他第三方服务来提供结果。
Spring AI 使得这一过程变得非常简单，只需定义一个返回 java.util.Function 的 @Bean，并在调用 ChatModel 时将 bean 名称作为选项提供即可。
在底层，Spring 用适当的适配器代码包装你的 POJO（函数），使其能够与 AI 模型进行交互，从而避免了编写繁琐的样板代码。底层基础设施的基础是 FunctionCallback.java 接口以及配套的 Builder 工具类，它们简化了 Java 回调函数的实现和注册。
工作原理
假设我们希望 AI 模型能够响应它没有的信息，例如某个给定位置的当前温度。
我们可以为 AI 模型提供关于我们自己函数的元数据，以便在处理你的提示时，它可以利用这些信息来检索相关内容。
例如，在处理一个提示的过程中，如果 AI 模型确定它需要关于某个地点温度的额外信息，它将启动一个服务器端生成的请求/响应交互。AI 模型调用一个客户端函数。AI 模型以 JSON 格式提供方法调用的详细信息，客户端负责执行该函数并返回响应。
Spring AI 极大地简化了支持函数调用所需的代码编写。它为你代理了函数调用的对话。你可以简单地将你的函数定义作为一个 @Bean 提供，然后在你的提示选项中提供该函数的 bean 名称。你也可以在你的提示中引用多个函数 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);
}
}
将函数注册为 Beans
通过 MistralAiChatModel 自动配置，你有多种方式可以在 Spring 上下文中将自定义函数注册为 bean。
我们首先描述最符合 POJO 友好的选项。
纯 Java 函数
在这种方法中，你可以在应用程序上下文中定义一个 @Bean，就像定义其他 Spring 管理的对象一样。
在内部，Spring AI 的 ChatModel 将会创建一个 FunctionCallback 的实例，该实例会添加通过 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 模型确定调用哪个客户端函数的重要属性。
另一个提供函数描述的方法是使用 @JsonClassDescription 注解在 MockWeatherService.Request 上：
@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 模式尽可能具有描述性，从而帮助 AI 模型选择正确的函数进行调用。
PaymentStatusBeanIT.java 演示了这种方法。
Mistral AI 的 PaymentStatusBeanOpenAiIT 使用 OpenAI API 实现了相同的功能。在这方面，Mistral AI 几乎与 OpenAI 相同。
FunctionCallback 包装器
另一种注册函数的方法是创建一个 FunctionCallback，如下所示：
@Configuration
static class Config {
@Bean
public FunctionCallback weatherFunctionInfo() {
return FunctionCallback.builder()
.function("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 函数，并将其注册为 MistralAiChatModel 的 CurrentWeather 函数。同时，它还提供了描述（2）和函数签名（3），以便模型了解该函数所需的参数。
默认情况下，响应转换器会对 Response 对象执行 JSON 序列化。
FunctionCallback 内部基于 MockWeatherService.Request 类解析函数调用签名。
在聊天选项中指定函数
为了让模型知道并调用你的 CurrentWeather 函数，你需要在提示请求中启用它：
MistralAiChatModel chatModel = ...
UserMessage userMessage = new UserMessage("What's the weather like in Paris?");
ChatResponse response = this.chatModel.call(new Prompt(this.userMessage,
MistralAiChatOptions.builder().function("CurrentWeather").build())); // Enable the function
logger.info("Response: {}", response);
上述用户问题将触发对 CurrentWeather 函数的 3 次调用（每个城市一次），最终响应将类似于以下内容：
注册/调用带有提示选项的函数
除了自动配置之外，你还可以在 Prompt 请求中动态注册回调函数：
MistralAiChatModel chatModel = ...
UserMessage userMessage = new UserMessage("What's the weather like in Paris?");
var promptOptions = MistralAiChatOptions.builder()
.functionCallbacks(List.of(FunctionCallback.builder()
.function("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));
在此请求期间，默认启用了提示中注册的函数。
这种方法允许根据用户输入动态选择要调用的不同函数。
PaymentStatusPromptIT.java 集成测试提供了一个完整的示例，展示了如何向 MistralAiChatModel 注册一个函数并在提示请求中使用它。
附录
Mistral AI API 函数调用流程
下图展示了 Mistral AI 低层级 API 的 Function Calling 流程：
PaymentStatusFunctionCallingIT.java 提供了一个完整的示例，展示了如何使用 Mistral AI API 的函数调用功能。该示例基于 Mistral AI 函数调用教程。