函式呼叫教學課程

函式呼叫可讓您更輕鬆地從生成式模型取得結構化資料輸出內容。接著，您可以使用這些輸出內容呼叫其他 API，並將相關回應資料傳回模型。換句話說，函式呼叫可協助您將生成模型連結至外部系統，讓產生的內容包含最新且正確的資訊。

您可以為 Gemini 模型提供函式說明。這些函式是使用應用程式語言編寫的函式 (也就是說，它們不是 Google Cloud Functions)。模型可能會要求您呼叫函式並傳回結果，以便模型處理您的查詢。

如果您還不熟悉，請參閱函式呼叫簡介瞭解詳情。

照明控制 API 範例

假設您有一個基本照明控制系統，其中包含應用程式設計介面 (API)，且您希望允許使用者透過簡單的文字要求控制燈光。您可以使用函式呼叫功能，解讀使用者提出的燈光變更要求，並將這些要求轉譯為 API 呼叫，以便設定燈光值。這個假設的照明控制系統可讓您控制燈光的亮度和色溫，這兩者分別定義為兩個獨立的參數：

參數 類型 必要 說明
brightness 數字 是 光線強度從 0 到 100。0 代表關閉，100 代表全亮度。
colorTemperature 字串 是 燈具的色溫，可以是 daylight、cool 或 warm。

為了簡化說明，這個假想的照明系統只有一盞燈，因此使用者不必指定房間或位置。以下是 JSON 要求範例，您可以將其傳送至照明控制 API，藉此使用日光色溫將光線亮度變更為 50%：

{
  "brightness": "50",
  "colorTemperature": "daylight"
}

本教學課程將說明如何為 Gemini API 設定函式呼叫，以便解讀使用者的照明要求，並將這些要求對應至 API 設定，以便控制燈光的亮度和色溫值。

事前準備：設定專案和 API 金鑰

在呼叫 Gemini API 之前，您需要設定專案並設定 API 金鑰。

定義 API 函式

建立可提出 API 要求的函式。這個函式應定義在應用程式的程式碼中，但可以呼叫應用程式以外的服務或 API。Gemini API 不會直接呼叫這個函式，因此您可以透過應用程式程式碼控制這個函式的執行方式和時機。為了示範，本教學課程會定義模擬 API 函式，只傳回要求的照明值：

suspend fun setLightValues(
    brightness: Int,
    colorTemp: String
): JSONObject {
    // This mock API returns the requested lighting values
    return JSONObject().apply {
        put("brightness", brightness)
        put("colorTemperature", colorTemp)
    }
}

建立函式宣告

建立要傳遞至生成式模型的函式宣告。宣告模型可使用的函式時，請盡可能在函式和參數說明中加入詳細資料。生成式模型會使用這項資訊，判斷要選取哪個函式，以及如何在函式呼叫中提供參數的值。以下程式碼顯示如何宣告照明控制函式：

val lightControlTool = defineFunction(
  name = "setLightValues",
  description = "Set the brightness and color temperature of a room light.",
  Schema.int("brightness", "Light level from 0 to 100. Zero is off and 100" +
    " is full brightness."),
  Schema.str("colorTemperature", "Color temperature of the light fixture" +
    " which can be `daylight`, `cool` or `warm`.")
) { brightness, colorTemp ->
    // Call the function you declared above
    setLightValues(brightness.toInt(), colorTemp)
}

在模型初始化期間宣告函式

如要使用函式呼叫功能，您必須在初始化模型物件時提供函式宣告。您可以設定模型的 tools 參數來宣告函式：

val generativeModel = GenerativeModel(
    modelName = "gemini-1.5-flash",

    // Access your API key as a Build Configuration variable
    apiKey = BuildConfig.apiKey,

    // Specify the function declaration.
    tools = listOf(Tool(listOf(lightControlTool)))
)

產生函式呼叫

使用函式宣告初始化模型後，您可以使用定義的函式提示模型。您應使用聊天提示 (sendMessage()) 進行函式呼叫，因為函式呼叫通常會受益於先前提示和回應的內容。

val chat = generativeModel.startChat()

val prompt = "Dim the lights so the room feels cozy and warm."

// Send the message to the generative model
var response = chat.sendMessage(prompt)

// Check if the model responded with a function call
response.functionCall?.let { functionCall ->
  // Try to retrieve the stored lambda from the model's tools and
  // throw an exception if the returned function was not declared
  val matchedFunction = generativeModel.tools?.flatMap { it.functionDeclarations }
      ?.first { it.name == functionCall.name }
      ?: throw InvalidStateException("Function not found: ${functionCall.name}")

  // Call the lambda retrieved above
  val apiResponse: JSONObject = matchedFunction.execute(functionCall)

  // Send the API response back to the generative model
  // so that it generates a text response that can be displayed to the user
  response = chat.sendMessage(
    content(role = "function") {
        part(FunctionResponsePart(functionCall.name, apiResponse))
    }
  )
}

// Whenever the model responds with text, show it in the UI
response.text?.let { modelResponse ->
    println(modelResponse)
}