Azure OpenAI 函数调用

函数调用允许开发人员在代码中创建函数的描述，然后在请求中将该描述传递给语言模型。模型的响应包括与描述匹配的函数名称以及用于调用它的参数。

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

并行函数调用仅支持 gpt-35-turbo (1106) 和 gpt-4 (1106-preview)，也称为 GPT-4 Turbo 预览。

Azure OpenAI 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 极大地简化了您需要编写的代码以支持函数调用。它为您代理函数调用对话。您只需将函数定义提供为 @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

使用 AzureOpenAiChatModelAuto-Configuration，您可以通过多种方式在 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 上使用 @JsonClassDescription 注解来提供函数描述

@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 模型选择正确的函数来调用。

FunctionCallWithFunctionBeanIT.java 演示了这种方法。

FunctionCallback 包装器

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

@Configuration
static class Config {

	@Bean
	public FunctionCallback weatherFunctionInfo() {

		return FunctionCallbackWrapper.builder(new MockWeatherService())
			.withName("CurrentWeather") // (1) function name
			.withDescription("Get the current weather in a given location") // (2) function description
			.build();
	}
	...
}

它包装了第三方 MockWeatherService 函数，并将其注册为 AzureAiChatModel 的 CurrentWeather 函数，并提供了一个描述 (2)。

默认的响应转换器对 Response 对象进行 JSON 序列化。

FunctionCallbackWrapper 在内部根据 MockWeatherService.Request 类解析函数调用签名，并在内部为函数调用生成 JSON 模式。

在 Chat 选项中指定函数

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

AzureOpenAiChatModel 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),
		AzureOpenAiChatOptions.builder().withFunction("CurrentWeather").build())); // (1) Enable the function

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

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

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

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

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

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

AzureOpenAiChatModel chatModel = ...

UserMessage userMessage = new UserMessage("What's the weather like in San Francisco, Tokyo, and Paris?  Use Multi-turn function calling.");

var promptOptions = AzureOpenAiChatOptions.builder()
	.withFunctionCallbacks(List.of(FunctionCallbackWrapper.builder(new MockWeatherService())
		.withName("CurrentWeather")
		.withDescription("Get the weather in location")
		.build()))
	.build();

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

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

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

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