Anthropic 函式呼叫(已棄用)

此頁面描述了 Function Calling API 的舊版本,該版本已棄用,並將在下個版本中移除。當前版本可在 工具呼叫 頁面找到。更多資訊請參見 遷移指南
自 2024 年 7 月 1 日起,支援流式函式呼叫和工具使用。

您可以向 AnthropicChatModel 註冊自定義 Java 函式,讓 Anthropic 模型智慧地選擇輸出一個 JSON 物件,其中包含呼叫一個或多個已註冊函式的引數。這使得您可以將 LLM 能力與外部工具和 API 連線起來。claude-3-5-sonnet-20241022claude-3-opusclaude-3-sonnetclaude-3-haiku 模型經過訓練,能夠檢測何時應該呼叫函式,並響應符合函式簽名的 JSON。

Anthropic API 不會直接呼叫函式;相反,模型會生成您可以用來在程式碼中呼叫函式並將結果返回給模型以完成對話的 JSON。

Spring AI 提供了靈活且使用者友好的方式來註冊和呼叫自定義函式。一般來說,自定義函式需要提供一個函式 namedescription 和函式呼叫 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 函式,並將其註冊為 AnthropicChatModelCurrentWeather 函式。它還提供用於生成函式呼叫 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 請求中使用它。