Mistral Function Calling

你可以用 MistralAiChatClient 注册自定义的 Java 函数，并且让 Mistral AI 模型智能地选择输出一个 JSON 对象，里面包含调用一个或多个已注册函数的参数。这允许你将 LLM 能力与外部工具和 API 相连接。mistral_small_latest 和 mistral_large_latest 模型经过训练，以检测何时应该调用函数，并用符合函数签名的 JSON 作出响应。 MistralAI API 不直接调用函数；相反，该模型会生成 JSON，你可以用它在你的代码中调用函数，并将结果返回给模型以完成对话。

目前，MistralAI API 与 OpenAI API、Azure OpenAI API 以及 Vertex AI Gemini API 类似，不支持并行函数调用。

Spring AI 提供灵活且用户友好的方式来注册和调用自定义函数。一般来说，自定义函数需要提供一个函数 name、description 和函数调用 signature（作为 JSON 模式），以便让模型知道函数需要什么参数。description 帮助模型理解何时调用函数。作为一个开发者，你需要实现一个函数，它获取从 AI 模型发送的函数调用参数，并用结果返回给模型。你的函数又可以调用其他第三方服务来提供结果。 Spring AI 让这件事变得像定义一个 @Bean 定义一样简单，该定义返回一个 java.util.Function，并在调用 ChatClient 时将 bean 名称作为一个选项提供。底层 Spring 将你的 POJO（函数）与适当的适配器代码打包在一起，使之能够与 AI 模型交互，省去了编写繁琐样板代码的步骤。底层基础架构的基础是 FunctionCallback.java 接口以及配套的 FunctionCallbackWrapper.java 实用程序类，对 Java 回调函数的实现和注册进行了简化。

How it works

假设我们希望 AI 模型用它没有的信息进行响应，例如给定位置的当前温度。

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

例如，如果在处理提示时，AI 模型确定它需要有关给定位置温度的附加信息，它将启动服务端生成的请求/响应交互。AI 模型会调用一个客户端函数。AI 模型将方法调用详细信息作为 JSON 提供，客户端负责执行该函数并返回响应。

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

Quick Start

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

当提示模型的响应需要回答诸如 `"波士顿的天气怎么样？"`此类问题时，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);
	}
}

Registering Functions as Beans

利用 MistralAiChatClient Auto-Configuration，你可以通过多种方式将自定义函数注册为 Spring 上下文中的 Bean。

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

Plain Java Functions

在此方法中，你可以根据你定义任何其他 Spring 托管对象的方式在应用程序上下文中定义 @Beans。

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

@Configuration
static class Config {

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

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

提供函数描述的另一种选择是在 MockWeatherService.Request 上的 @JacksonDescription 注释来提供函数描述：

@Configuration
static class Config {

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

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

最好使用诸如此类的信息注释请求对象，以便该函数生成 JSON 架构尽可能的描述性，以帮助 AI 模型选择要调用的正确函数。

PaymentStatusBeanIT.java 展示了这种方法。

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

FunctionCallback Wrapper

注册函数的另一种方法是创建 FunctionCallbackWrapper 包装器，如下所示：

@Configuration
static class Config {

	@Bean
	public FunctionCallback weatherFunctionInfo() {

		return new FunctionCallbackWrapper<>("CurrentWeather", // (1) function name
				"Get the weather in location", // (2) function description
				(response) -> "" + response.temp() + response.unit(), // (3) Response Converter
				new MockWeatherService()); // function code
	}
	...
}

它封装第三方 MockWeatherService 函数，并将其作为 CurrentWeather 函数注册到 MistralAiChatClient。它还提供了一个描述 (2) 和一个可选的响应转换器 (3)，将响应转换为模型期望的文本。

默认情况下，响应转换器对 Response 对象进行 JSON 序列化。

FunctionCallbackWrapper 内部将函数调用签名解析为基于 MockWeatherService.Request 类的函数调用签名。

Specifying functions in Chat Options

为了让模型知道并调用你的 CurrentWeather 函数，你需要在提示请求中启用它：

MistralAiChatClient chatClient = ...

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

ChatResponse response = chatClient.call(new Prompt(List.of(userMessage),
		MistralAiChatOptions.builder().withFunction("CurrentWeather").build())); // (1) Enable the function

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

以上的用户问题将触发对 CurrentWeather 函数的 3 个调用（每个城市一个），并生成最终响应。

Register/Call Functions with Prompt Options

除了自动配置，你还可以动态地使用你的提示请求注册回调函数：

MistralAiChatClient chatClient = ...

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

var promptOptions = MistralAiChatOptions.builder()
	.withFunctionCallbacks(List.of(new FunctionCallbackWrapper<>(
		"CurrentWeather", // name
		"Get the weather in location", // function description
		new MockWeatherService()))) // function code
	.build();

ChatResponse response = chatClient.call(new Prompt(List.of(userMessage), promptOptions));

命令提示中注册的函数默认在这个请求期间启用。

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

PaymentStatusPromptIT.java 集成测试提供了一个使用 MistralAiChatClient 注册函数并在提示请求中使用该函数的完整示例。