教程：使用 Gemini API 进行函数调用


借助函数调用，您可以更轻松地从生成模型中获取结构化数据输出。然后，您可以使用这些输出调用其他 API，并将相关响应数据返回给模型。换言之，函数调用可帮助您将生成模型连接到外部系统，以使生成的内容包含最新且准确的信息。

您可以为 Gemini 模型提供函数说明。这些函数是使用应用的语言编写的（即，它们不是 Google Cloud Functions）。模型可能会要求您调用一个函数并发回结果，以帮助模型处理您的查询。

请参阅函数调用简介了解详情（如果您尚未这样做）。

设置项目

在调用 Gemini API 之前，您需要设置项目，包括获取 API 密钥、导入 SDK 和初始化模型。展开即可下各个部分即可查看详细说明。

设置函数调用

在本教程中，您将让模型与支持以下参数的假设货币交易所 API 进行交互：

参数 类型 必需 说明
currencyFrom string 是 要换算的币种
currencyTo string 是 要换算成的币种

API 请求示例

{
  "currencyFrom": "USD",
  "currencyTo": "SEK"
}

API 响应示例

{
  "base": "USD",
  "rates": {"SEK": 0.091}
}

第 1 步：创建用于发出 API 请求的函数

如果尚未创建用于发出 API 请求的函数，请先创建。

在本教程中出于演示目的，您不会发送实际 API 请求，而是以与实际 API 返回的格式相同的格式返回硬编码值。

async function makeApiRequest(currencyFrom, currencyTo) {
  // This hypothetical API returns a JSON such as:
  // {"base":"USD","rates":{"SEK": 0.091}}
  return {
    base: currencyFrom,
    rates: { [currencyTo]: 0.091 },
  };
}

第 2 步：创建函数声明

创建要传递给生成模型的函数声明（本教程的下一步）。

在函数和参数说明中添加尽可能多的详细信息。 生成模型使用这些信息来确定选择哪个函数，以及如何为函数调用中的形参提供值。

// Function declaration, to pass to the model.
const getExchangeRateFunctionDeclaration = {
  name: "getExchangeRate",
  parameters: {
    type: "OBJECT",
    description: "Get the exchange rate for currencies between countries",
    properties: {
      currencyFrom: {
        type: "STRING",
        description: "The currency to convert from.",
      },
      currencyTo: {
        type: "STRING",
        description: "The currency to convert to.",
      },
    },
    required: ["currencyTo", "currencyFrom"],
  },
};

// Executable function code. Put it in a map keyed by the function name
// so that you can call it once you get the name string from the model.
const functions = {
  getExchangeRate: ({ currencyFrom, currencyTo }) => {
    return makeApiRequest( currencyFrom, currencyTo)
  }
};

第 3 步：在模型初始化期间指定函数声明

在初始化生成模型时，通过将函数声明传递到模型的 tools 参数来指定函数声明：

<html>
  <body>
    <!-- ... Your HTML and CSS -->

    <script type="importmap">
      {
        "imports": {
          "@google/generative-ai": "https://esm.run/@google/generative-ai"
        }
      }
    </script>
    <script type="module">
      import { GoogleGenerativeAI } from "@google/generative-ai";

      // Fetch your API_KEY
      const API_KEY = "...";

      // Access your API key (see "Set up your API key" above)
      const genAI = new GoogleGenerativeAI(API_KEY);

      // ...

      const generativeModel = genAI.getGenerativeModel({
        // Use a model that supports function calling, like a Gemini 1.5 model
        model: "gemini-1.5-flash",

        // Specify the function declaration.
        tools: {
          functionDeclarations: [getExchangeRateFunctionDeclaration],
        },
      });
    </script>
  </body>
</html>

第 4 步：生成函数调用

现在，您可以使用定义的函数向模型发出提示。

建议使用聊天界面使用函数调用，因为函数调用非常适合聊天的多轮结构。

const chat = generativeModel.startChat();
const prompt = "How much is 50 US dollars worth in Swedish krona?";

// Send the message to the model.
const result = await chat.sendMessage(prompt);

// For simplicity, this uses the first function call found.
const call = result.response.functionCalls()[0];

if (call) {
  // Call the executable function named in the function call
  // with the arguments specified in the function call and
  // let it call the hypothetical API.
  const apiResponse = await functions[call.name](call.args);

  // Send the API response back to the model so it can generate
  // a text response that can be displayed to the user.
  const result = await chat.sendMessage([{functionResponse: {
    name: 'getExchangeRate',
    response: apiResponse
  }}]);

  // Log the text response.
  console.log(result.response.text());
}