函式呼叫

您可以向 MiniMaxChatModel 註冊自訂 Java 函式,並讓 MiniMax 模型智慧地選擇輸出包含引數的 JSON 物件,以呼叫一個或多個已註冊的函式。這可讓您將 LLM 功能與外部工具和 API 連接。MiniMax 模型經過訓練,可以偵測何時應呼叫函式,並以符合函式簽章的 JSON 回應。

MiniMax API 不會直接呼叫函式;相反地,模型會產生 JSON,您可以使用該 JSON 在程式碼中呼叫函式,並將結果傳回模型以完成對話。

Spring AI 提供彈性且使用者友善的方式來註冊和呼叫自訂函式。一般而言,自訂函式需要提供函式名稱描述和函式呼叫簽章 (以 JSON 綱要的形式),以讓模型知道函式預期的引數。描述可協助模型了解何時應呼叫函式。

作為開發人員,您需要實作一個函式,該函式會接收從 AI 模型傳送的函式呼叫引數,並以結果回應模型。您的函式可以進而調用其他第三方服務以提供結果。

Spring AI 使這一切變得非常容易,只需定義一個 @Bean 定義,該定義傳回 java.util.Function,並在調用 ChatModel 時提供 bean 名稱作為選項即可。

在底層,Spring 會使用適當的配接器程式碼包裝您的 POJO (函式),以實現與 AI 模型的互動,從而節省您編寫繁瑣的樣板程式碼。底層基礎架構的基礎是 FunctionCallback.java 介面和配套的 Builder 公用程式類別,以簡化 Java 回呼函式的實作和註冊。

運作方式

假設我們希望 AI 模型回應它沒有的資訊,例如給定位置的目前溫度。

我們可以向 AI 模型提供關於我們自己的函式的中繼資料,模型可以使用這些中繼資料在處理您的提示時檢索該資訊。

例如,如果在處理提示期間,AI 模型判斷它需要關於給定位置溫度的額外資訊,它將啟動伺服器端產生的請求/回應互動。AI 模型會調用用戶端函式。AI 模型以 JSON 形式提供方法調用詳細資訊,用戶端有責任執行該函式並傳回回應。

模型與用戶端互動如 [spring-ai-function-calling-flow] 圖所示。

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);
	}
}

將函式註冊為 Bean

透過 MiniMaxChatModel 自動配置,您有多種方式可以在 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 上使用 @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 綱要盡可能地具有描述性,以協助 AI 模型挑選正確的函式來調用。

FunctionCallback 包裝器

註冊函式的另一種方式是建立 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 函式,並將其註冊為 MiniMaxChatModelCurrentWeather 函式。它還提供描述 (2) 和函式簽章 (3),以讓模型知道函式預期的引數。

預設情況下,回應轉換器會對 Response 物件進行 JSON 序列化。
FunctionCallback 在內部根據 MockWeatherService.Request 類別解析函式呼叫簽章。

在聊天選項中指定函式

為了讓模型知道並呼叫您的 CurrentWeather 函式,您需要在提示請求中啟用它

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().withFunction("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 測試示範了此方法。

使用提示選項註冊/呼叫函式

除了自動配置之外,您還可以透過提示請求動態註冊回呼函式

MiniMaxChatModel chatModel = ...

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

var promptOptions = MiniMaxChatOptions.builder()
	.withFunctionCallbacks(List.of(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())) // function code
	.build();

ChatResponse response = this.chatModel.call(new Prompt(List.of(this.userMessage), this.promptOptions));
預設情況下,在提示中註冊的函式在此請求期間啟用。

此方法允許根據使用者輸入動態選擇要呼叫的不同函式。

FunctionCallbackInPromptIT.java 整合測試提供了一個完整的範例,說明如何向 MiniMaxChatModel 註冊函式並在提示請求中使用它。