מדריך: קריאה לפונקציה באמצעות Gemini API

Python Node.js Go Dart (Flutter) Android Swift אינטרנט

בזכות הקריאה של הפונקציות קל יותר לקבל פלט של נתונים מובְנים ממודלים גנרטיביים. לאחר מכן תוכלו להשתמש בפלטים האלה כדי לקרוא לממשקי API אחרים ולהחזיר למודל את נתוני התגובה הרלוונטיים. במילים אחרות, קריאה של פונקציות עוזרת לחבר מודלים גנרטיביים למערכות חיצוניות כדי שהתוכן שנוצר יכלול את המידע העדכני והמדויק ביותר.

אפשר לספק מודלים של Gemini עם תיאורים של פונקציות. אלו פונקציות שכותבים בשפה של האפליקציה (כלומר, לא Google Cloud Functions). יכול להיות שהמודל יבקש מכם לקרוא לפונקציה ולשלוח בחזרה את התוצאה כדי לעזור למודל לטפל בשאילתה.

למידע נוסף, מומלץ לקרוא את המאמר מבוא לקריאה לפונקציות.

הגדרת הפרויקט

לפני שמפעילים את Gemini API, צריך להגדיר את הפרויקט. הפרויקט כולל הגדרה של מפתח ה-API, התקנה של חבילת ה-SDK והפעלה של המודל.

npm install @google/generative-ai

const { GoogleGenerativeAI } = require("@google/generative-ai");

// Access your API key as an environment variable (see "Set up your API key" above)
const genAI = new GoogleGenerativeAI(process.env.API_KEY);

// ...

// Use a model that supports function calling, like Gemini 1.0 Pro.
// See "Supported models" in the "Introduction to function calling" page.
const model = genAI.getGenerativeModel({ model: "MODEL_NAME"});

// ...

הגדרה של בקשה להפעלת פונקציה

במדריך הזה נציג למודל אינטראקציה עם ממשק API של המרת מטבעות היפותטית שתומך בפרמטרים הבאים:

דוגמה לבקשת 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 של המודל:

const { GoogleGenerativeAI } = require("@google/generative-ai");

// Access your API key as an environment variable (see "Set up your API key" above)
const genAI = new GoogleGenerativeAI(process.env.API_KEY);

// ...

const generativeModel = genAI.getGenerativeModel({
  // Use a model that supports function calling, like Gemini 1.0 Pro.
  // See "Supported models" in the "Introduction to function calling" page.
  model: "gemini-1.0-pro",

  // Specify the function declaration.
  tools: {
    functionDeclarations: [getExchangeRateFunctionDeclaration],
  },
});

שלב 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 result2 = await chat.sendMessage([{functionResponse: {
    name: 'getExchangeRate',
    response: apiResponse
  }}]);

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