Anthropic 函数调用（已弃用）

此页面描述了 Function Calling API 的旧版本，该版本已弃用，并将在下个版本中移除。当前版本可在工具调用页面找到。更多信息请参见迁移指南。

自 2024 年 7 月 1 日起，支持流式函数调用和工具使用。

您可以向 AnthropicChatModel 注册自定义 Java 函数，让 Anthropic 模型智能地选择输出一个 JSON 对象，其中包含调用一个或多个已注册函数的参数。这使得您可以将 LLM 能力与外部工具和 API 连接起来。claude-3-5-sonnet-20241022、claude-3-opus、claude-3-sonnet 和 claude-3-haiku 模型经过训练，能够检测何时应该调用函数，并响应符合函数签名的 JSON。

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

Spring AI 提供了灵活且用户友好的方式来注册和调用自定义函数。一般来说，自定义函数需要提供一个函数 name、description 和函数调用 signature（以 JSON schema 形式），以便让模型知道该函数需要哪些参数。description 有助于模型理解何时调用该函数。

作为开发者，您需要实现一个函数，该函数接收 AI 模型发送的函数调用参数，并将结果返回给模型。您的函数可以进一步调用其他第三方服务来提供结果。

Spring AI 使这变得非常简单，只需定义一个返回 java.util.Function 的 @Bean 定义，并在调用 ChatModel 时将 bean 名称作为选项提供即可。

在底层，Spring 使用适当的适配器代码包装您的 POJO（函数），使其能够与 AI 模型交互，从而避免您编写繁琐的样板代码。底层基础设施的基础是 ToolCallback.java 接口以及配套的 Builder 工具类，用于简化 Java 回调函数的实现和注册。

工作原理

假设我们希望 AI 模型回复它不具备的信息，例如给定位置的当前温度。

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

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

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

快速入门

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

当模型需要回复诸如 "波士顿的天气怎么样？" 的 prompt 时，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

通过 AnthropicChatModel 自动配置，您有多种方法将自定义函数作为 bean 注册到 Spring 上下文中。

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

普通 Java 函数

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

在内部，Spring AI ChatModel 将创建一个 ToolCallback 实例，该实例添加了通过 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 schema 尽可能具有描述性，以帮助 AI 模型选择正确的函数进行调用。

FunctionCallWithFunctionBeanIT.java 演示了这种方法。

ToolCallback

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

@Configuration
static class Config {

	@Bean
	public FunctionToolCallback weatherFunctionInfo() {

    return FunctionToolCallback.builder("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 函数，并将其注册为 AnthropicChatModel 的 CurrentWeather 函数。它还提供用于生成函数调用 JSON schema 的描述 (2) 和输入类型 (3)。

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

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

在聊天选项中指定函数

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

AnthropicChatModel chatModel = ...

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

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

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

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

使用 Prompt 选项注册/调用函数

除了自动配置外，您还可以通过 Prompt 请求动态注册回调函数

AnthropicChatModel chatModel = ...

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

var promptOptions = AnthropicChatOptions.builder()
	.toolCallbacks(List.of(FunctionToolCallback.builder("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(List.of(this.userMessage), this.promptOptions));

默认情况下，在此请求的整个过程中，prompt 内注册的函数是启用的。

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

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