函数调用

您可以使用 ZhiPuAiChatModel 注册自定义 Java 函数，并让 ZhiPuAI 模型智能地选择输出包含调用一个或多个已注册函数的参数的 JSON 对象。这使您可以将 LLM 功能与外部工具和 API 连接起来。ZhiPuAI 模型经过训练，可以检测何时应该调用函数，并以符合函数签名的 JSON 形式进行响应。

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

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

作为开发人员，您需要实现一个函数，该函数接收来自 AI 模型的函数调用参数，并向模型返回结果。您的函数可以反过来调用其他第三方服务以提供结果。

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

在幕后，Spring 将您的 POJO（函数）与适当的适配器代码包装在一起，使之能够与 AI 模型进行交互，从而使您免于编写冗长的样板代码。底层基础设施的基础是 FunctionCallback.java 接口和配套的 FunctionCallbackWrapper.java 实用程序类，用于简化 Java 回调函数的实现和注册。

工作原理

假设我们希望 AI 模型能够响应它没有的信息，例如某个位置的当前温度。

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

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

模型-客户端交互在 [spring-ai-function-calling-flow] 图表中进行了说明。

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);
	}
}

将函数注册为 Bean

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

我们首先描述最友好的 POJO 选项。

纯 Java 函数

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

在内部，Spring AI ChatModel 将创建一个 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 模型选择正确的函数进行调用。

该 FunctionCallbackWithPlainFunctionBeanIT.java 演示了这种方法。

FunctionCallback 包装器

另一种注册函数的方法是创建 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 函数，并将其注册为 ZhiPuAiChatModel 中的 CurrentWeather 函数。它还提供了一个描述 (2) 和一个可选的响应转换器 (3) 来将响应转换为模型期望的文本。

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

FunctionCallbackWrapper 在内部根据 MockWeatherService.Request 类解析函数调用签名。

在聊天选项中指定函数

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

ZhiPuAiChatModel chatModel = ...

UserMessage userMessage = new UserMessage("What's the weather like in San Francisco, Tokyo, and Paris?");

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

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

上面的用户问题将触发 3 次对 CurrentWeather 函数的调用（每个城市一次），最终的响应将类似于以下内容

Here is the current weather for the requested cities:
- San Francisco, CA: 30.0°C
- Tokyo, Japan: 10.0°C
- Paris, France: 15.0°C

该 FunctionCallbackWrapperIT.java 测试演示了这种方法。

使用提示选项注册/调用函数

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

ZhiPuAiChatModel chatModel = ...

UserMessage userMessage = new UserMessage("What's the weather like in San Francisco, Tokyo, and Paris?");

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

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

在提示中注册的函数在该请求期间默认启用。

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

该 FunctionCallbackInPromptIT.java 集成测试提供了一个完整的示例，说明如何使用 ZhiPuAiChatModel 注册函数并在提示请求中使用它。