函式呼叫
您可以在 MiniMaxChatModel
中註冊自定義 Java 函式,讓 MiniMax 模型智慧地選擇輸出一個 JSON 物件,其中包含呼叫一個或多個註冊函式的引數。這使得您可以將 LLM 能力與外部工具和 API 連線起來。MiniMax 模型經過訓練,可以檢測何時應呼叫函式,並以符合函式簽名的 JSON 格式響應。
MiniMax API 不直接呼叫函式;相反,模型會生成 JSON,您可以使用它在程式碼中呼叫函式,並將結果返回給模型以完成對話。
Spring AI 提供了靈活且使用者友好的方式來註冊和呼叫自定義函式。通常,自定義函式需要提供函式名、描述以及函式呼叫簽名(作為 JSON Schema),以便模型知道函式需要哪些引數。描述有助於模型理解何時呼叫該函式。
作為開發者,您需要實現一個函式,該函式接收從 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-function-calling-flow] 圖中進行了說明。
Spring AI 極大地簡化了您需要編寫的程式碼,以支援函式呼叫。它為您處理函式呼叫對話。您只需將函式定義作為 @Bean
提供,然後在 Prompt 選項中提供函式的 bean 名稱即可。您還可以在 Prompt 中引用多個函式 bean 名稱。
快速開始
讓我們建立一個聊天機器人,它透過呼叫我們自己的函式來回答問題。為了支援聊天機器人的響應,我們將註冊一個接受位置引數並返回該位置當前天氣的函式。
當模型響應 Prompt 需要回答諸如 "What’s the weather like in Boston?"
之類的問題時,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
藉助 MiniMaxChatModel 自動配置,您可以透過多種方式將自定義函式註冊為 Spring Context 中的 Bean。
我們從描述最 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
上使用 @JacksonDescription
註解來提供函式描述。
@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 模型選擇正確的函式進行呼叫。
ToolCallback 包裝器
註冊函式的另一種方法是像這樣建立一個 ToolCallback
例項
@Configuration
static class Config {
@Bean
public FunctionToolCallback weatherFunctionInfo() {
return FunctionToolCallback.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();
}
...
}
它包裝了第三方 MockWeatherService
函式,並將其註冊為 MiniMaxChatModel 的 CurrentWeather
函式。它還提供了描述(2)和函式簽名(3),以便模型知道函式需要哪些引數。
預設情況下,響應轉換器會對 Response 物件進行 JSON 序列化。 |
FunctionToolCallback 在內部根據 MockWeatherService.Request 類解析函式呼叫簽名。 |
在 Chat 選項中指定函式
要讓模型知道並呼叫您的 CurrentWeather
函式,您需要在 Prompt 請求中啟用它
MiniMaxChatModel 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),
MiniMaxChatOptions.builder().function("CurrentWeather").build())); // (1) Enable the function
logger.info("Response: {}", response);
上述使用者問題將觸發 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
MiniMaxFunctionCallbackIT.java
測試演示了這種方法。
使用 Prompt 選項註冊/呼叫函式
除了自動配置之外,您還可以透過 Prompt 請求動態註冊回撥函式
MiniMaxChatModel chatModel = ...
UserMessage userMessage = new UserMessage("What's the weather like in San Francisco, Tokyo, and Paris?");
var promptOptions = MiniMaxChatOptions.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 中註冊的函式在此請求的整個生命週期內預設啟用。 |
這種方法允許根據使用者輸入動態選擇不同的函式進行呼叫。
FunctionCallbackInPromptIT.java
整合測試提供了一個完整的示例,演示瞭如何使用 MiniMaxChatModel
註冊函式並在 Prompt 請求中使用它。