跳到主要内容

Azure OpenAI 函数调用（已弃用）

DeepSeek V3 中英对照 Azure OpenAI Function Calling Azure OpenAI Function Calling (Deprecated)

注意

本页面描述了旧版本的 Function Calling API，该版本已被弃用，并计划在下一个版本中移除。当前版本可在 Tool Calling 查看。更多信息请参阅 迁移指南。

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

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

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

Spring AI 提供了灵活且用户友好的方式来注册和调用自定义函数。通常，自定义函数需要提供一个函数 name、description 以及函数调用 signature（作为 JSON schema），以便让模型知道函数期望的参数是什么。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);
	}
}
java

将函数注册为 Beans​

通过 AzureOpenAiChatModelAuto-Configuration，您有多种方式将自定义函数注册为 Spring 上下文中的 bean。

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

纯 Java 函数​

在这种方法中，你可以在应用程序上下文中定义 @Beans，就像定义其他 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> weatherFunction1() {
		return new MockWeatherService();
	}
	...
}
java

@Description 注解是可选的，它提供了一个函数描述（2），帮助模型理解何时调用该函数。设置此属性非常重要，有助于 AI 模型确定要调用的客户端函数。

另一个提供函数描述的方法是使用 @JsonClassDescription 注解在 MockWeatherService.Request 上，以提供函数描述：

@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) {}
java

最佳实践是在请求对象上添加信息注释，使得该函数生成的 JSON 模式尽可能具有描述性，以帮助 AI 模型选择正确的函数进行调用。

FunctionCallWithFunctionBeanIT.java 演示了这种方法。

FunctionCallback 包装器​

另一种注册函数的方法是创建一个 FunctionCallback 实例，如下所示：

@Configuration
static class Config {

	@Bean
	public FunctionCallback weatherFunctionInfo() {

		return FunctionCallback.builder()
			.function("CurrentWeather", new MockWeatherService()) // (1) function name
			.description("Get the current weather in a given location") // (2) function description
			.inputType(MockWeatherService.Request.class) // (3) function input type
			.build();
	}
	...
}
java

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

备注

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

备注

FunctionCallback 内部根据 MockWeatherService.Request 类解析函数调用签名，并内部生成一个用于函数调用的 JSON schema。

在聊天选项中指定函数​

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

AzureOpenAiChatModel chatModel = ...

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

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

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

上述用户问题将触发 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

FunctionCallWithFunctionWrapperIT.java 测试示例展示了这种方法。

注册/调用带有提示选项的函数​

除了自动配置之外，你还可以动态地为你的 Prompt 请求注册回调函数：

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()
	.functionCallbacks(List.of(FunctionCallback.builder()
			.function("CurrentWeather", new MockWeatherService()) // (1) function name and instance
			.description("Get the current weather in a given location") // (2) function description
			.inputType(MockWeatherService.Request.class) // (3) function input type
			.build()))
	.build();

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

在此请求期间，默认启用了提示内注册的函数。

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

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