Anthropic 函数调用(已弃用)
本页面描述了旧版本的 Function Calling API,该版本已被弃用,并将在下一个版本中移除。当前版本请参阅 Tool Calling。更多信息请查看 迁移指南。
从 2024 年 7 月 1 日开始,支持流式函数调用和 Tool 使用。
你可以将自定义的 Java 函数注册到 AnthropicChatModel
中,并让 Anthropic 模型智能地选择输出包含调用一个或多个已注册函数参数的 JSON 对象。这使得你可以将 LLM 的能力与外部工具和 API 连接起来。claude-3-5-sonnet-20241022
、claude-3-opus
、claude-3-sonnet
和 claude-3-haiku
模型经过训练,能够检测何时应调用函数,并生成符合函数签名的 JSON 响应。
Anthropic 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);
}
}
将函数注册为 Beans
通过 AnthropicChatModel 自动配置,您有多种方式可以将自定义函数注册为 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();
}
...
}
@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
实例,如下所示:
@Configuration
static class Config {
@Bean
public FunctionCallback weatherFunctionInfo() {
return FunctionCallback.builder()
.description("Get the weather in location") // (2) function description
.function("CurrentWeather", new MockWeatherService()) // (1) function name and instance
.inputType(MockWeatherService.Request.class) // (3) function signature
.build();
}
...
}
它封装了第三方 MockWeatherService
函数,并将其注册为 AnthropicChatModel
的 CurrentWeather
函数。同时,它还提供了描述 (2) 和输入类型 (3),用于生成函数调用的 JSON schema。
默认情况下,响应转换器会对 Response 对象进行 JSON 序列化。
FunctionCallback
内部根据 MockWeatherService.Request
类解析函数调用签名。
在聊天选项中指定函数
为了让模型知道并调用你的 CurrentWeather
函数,你需要在提示请求中启用它:
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().function("CurrentWeather").build())); // (1) Enable the function
logger.info("Response: {}", response);
上述用户问题将触发对 CurrentWeather
函数的三次调用(每个城市一次),并生成最终响应。
注册/调用带有提示选项的函数
除了自动配置之外,你还可以动态地为你的 Prompt 请求注册回调函数:
AnthropicChatModel chatModel = ...
UserMessage userMessage = new UserMessage("What's the weather like in Paris?");
var promptOptions = AnthropicChatOptions.builder()
.functionCallbacks(List.of(FunctionCallback.builder()
.function("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));
在此请求期间,默认启用了提示中注册的函数。
这种方法允许根据用户输入动态选择要调用的不同函数。
FunctionCallWithPromptFunctionIT.java 集成测试提供了一个完整的示例,展示了如何向 AnthropicChatModel
注册一个函数并在提示请求中使用它。