אינטראקציות מרובות עם תבניות של הנחיות לשרת


המדריך הזה רלוונטי לכל יכולת שמתבססת על אינטראקציות מרובות, כולל:

סקירה כללית

באינטראקציות מרובות, ערכות ה-SDK מנהלות את מצב השיחה.Firebase AI Logic ההגדרה הזו רלוונטית גם כשמשתמשים בתבניות של הנחיות לשרת.

תהליך העבודה הבסיסי לאינטראקציות מרובות תורות ולתבניות של הנחיות לשרת זהה בעיקרו לזה של בקשות חד-תורתיות, אבל יש כמה הבדלים חשובים:

  1. יוצרים את התבנית באמצעות ממשק המשתמש המודרך במסוף Firebase.

    באינטראקציות מרובות שלבים, צריך להוסיף את התג {{history}} לתוכן של התבנית. התג הזה מציין לתבנית איפה להוסיף את שלבי השיחה שמנוהלים על ידי ה-SDK של הלקוח.

  2. בודקים את התבנית בבקשה אמיתית באמצעות חוויית הבדיקה במסוף Firebase.

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

  3. ניגשים לתבנית מהקוד של האפליקציה באמצעות templateGenerativeModel.

    באינטראקציות מרובות תורות, צריך להשתמש בתגי startChat ו-sendMessage (בדיוק כמו באינטראקציות מרובות תורות כשלא משתמשים בתבניות של הנחיות בצד השרת).

שימו לב שיש עוד כמה הבדלים בקריאות לפונקציות, והם מתוארים בקטע הזה בהמשך הדף.



שיחה עם זיכרון (צ'אט)

אם עוד לא עשיתם את זה, כדאי לעיין במדריך הכללי ליצירת שיחות מרובות תורות (צ'אט) כשלא משתמשים בתבניות של הנחיות לשרת.

פורמט בסיסי של תבנית הנחיה לשרת

ב-Firebase AI Logic, מסוף Firebase מספק ממשק משתמש מודרך שבו אפשר לציין את המטא נתונים ואת התוכן של התבנית.

תבניות של הנחיות לשרת משתמשות בתחביר ובפורמט שמבוססים על Dotprompt. פרטים נוספים זמינים במאמר בנושא הפורמט, התחביר והדוגמאות של תבניות.

בדוגמה של התבנית שבהמשך מוצגים הרכיבים החשובים ביותר של תבנית כשמפתחים שיחה מרובת תפניות (צ'אט). שימו לב לתווית {{history}} שנוספה לתוכן של התבנית, שמציינת לתבנית איפה להוסיף את תורות השיחה שמנוהלות על ידי ה-SDK של הלקוח.

---
model: 'gemini-3-flash-preview'
---

{{role "system"}}
You help customers with their invoices, including answering questions or providing their invoices to them.
If an invoice is requested, it must be a clearly structured invoice document that uses a tabular or clearly delineated list format for line items.

{{history}}

שימוש בתבנית בקוד

לוחצים על הספק Gemini API כדי לראות את התוכן והקוד הספציפיים לספק בדף הזה.

בדוגמה הבאה של קוד לקוח אפשר לראות איך משתמשים בתבנית בקוד. שימו לב לשימוש ב-templateGenerativeModel יחד עם startChat ו-sendMessage כשיוצרים אינטראקציות מרובות שלבים.

Swift

For Swift, using server prompt templates with multi-turn interactions is not yet supported. Check back soon!

Kotlin


// ...

// Initialize the Gemini Developer API backend service
// Create a `TemplateGenerativeModel` instance.
val model = Firebase.ai(backend = GenerativeBackend.googleAI())
                        .templateGenerativeModel()

// Start a chat session with a template.
val chatSession = model.startChat(
  // Specify your template ID
  templateId= "my-chat-template-v1-0-0",
  inputs = emptyMap()
)

// Send messages.
// The template's system instructions and model config apply to every turn automatically.
// The SDK automatically manages the state of the conversation.
val response = chatSession.sendMessage(
  content("user") { text("I need a copy of my invoice.") }
)

val text = response.text
println(text)

Java

For Java, using server prompt templates with multi-turn interactions is not yet supported. Check back soon!

Web


// ...

// Initialize the Gemini Developer API backend service.
const ai = getAI(app, { backend: new GoogleAIBackend() });

// Create a `TemplateGenerativeModel` instance.
const model = getTemplateGenerativeModel(ai);

// Start a chat session with a template.
const chatSession = model.startChat({
  // Specify your template ID.
  templateId: 'my-chat-template-v1-0-0',
});

// Send messages.
// The template's system instructions and model config apply to every turn automatically.
// The SDK automatically manages the state of the conversation.
const result = await chatSession.sendMessage("I need a copy of my invoice.");

const text = result.response.text();
console.log(text);

Dart


// ...

// Initialize the Gemini Developer API backend service.
// Create a `TemplateGenerativeModel` instance.
final model = FirebaseAI.googleAI().templateGenerativeModel();

// Start a chat session with a template.
final chatSession = model.startChat(
  // Specify your template ID.
  templateId: 'my-chat-template-v1-0-0',
);

// Send messages.
// The template's system instructions and model config apply to every turn automatically.
// The SDK automatically manages the state of the conversation.
final response = await chatSession.sendMessage(
  Content.text('I need a copy of my invoice.'),
);

final text = response.text;
print(text);

Unity


// ...

// Initialize the Gemini Developer API backend service.
var firebaseAI = FirebaseAI.GetInstance(FirebaseAI.Backend.GoogleAI());

// Create a `TemplateGenerativeModel` instance.
var model = firebaseAI.GetTemplateGenerativeModel();

// Start a chat session with a template.
var chatSession = model.StartChat(
    // Specify your template ID.
    "my-chat-template-v1-0-0"
);

// Send messages.
// The template's system instructions and model config apply to every turn automatically.
// The SDK automatically manages the state of the conversation.
try
{
   var response = await chatSession.SendMessageAsync(ModelContent.Text("I need a copy of my invoice."));
   Debug.Log($"Response Text: {response.Text}");
}
catch (Exception e) {
  Debug.LogError($"An error occurred: {e.Message}");
}



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

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

פורמט בסיסי של תבנית הנחיה לשרת

ב-Firebase AI Logic, מסוף Firebase מספק ממשק משתמש מודרך שבו אפשר לציין את המידע שמופיע לפני התוכן ואת התוכן של התבנית.

תבניות הנחיות לשרת משתמשות בתחביר ובפורמט שמבוססים על Dotprompt. פרטים נוספים זמינים במאמר בנושא הפורמט, התחביר והדוגמאות של תבניות.

בתבנית לדוגמה שבהמשך מוצגים הרכיבים החשובים ביותר בתבנית כשמשתמשים בקריאה לפונקציה. שימו לב לנקודות הבאות:

  • ב-frontmatter של התבנית, מפרטים את הפונקציות שלמודל יש גישה אליהן על ידי ציון הצהרות על פונקציות באובייקט tools.

    • מגדירים את name (חובה) ואת description (אופציונלי) לכל פונקציה שהמודל מקבל אליה גישה.

    • מגדירים את הסכימה לכל פונקציה שלמודל יש גישה אליה.

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

  • בתוכן של התבנית, מוסיפים את התג {{history}}, שמציין לתבנית איפה להוסיף את תורות השיחה שמנוהלות על ידי ה-SDK של הלקוח.

תבנית לדוגמה עם סכימת פונקציות שמוגדרת בתבנית

---
model: gemini-3-flash-preview
tools:
  - name: fetchWeather
    description: Get the weather conditions for a specific city on a specific date.
    input:
      schema:
        location(object, The name of the city and its state for which to get the weather. Only cities in the USA are supported.):
          city: string, The city of the location.
          state: string, The state of the location.
        date: string, The date for which to get the weather. Date must be in the format YYYY-MM-DD.

---

What was the weather like in Boston, Massachusetts on 10/17 in year 2024?

{{history}}

שימוש בתבנית בקוד

לוחצים על הספק Gemini API כדי לראות את התוכן והקוד הספציפיים לספק בדף הזה.

בדוגמה הבאה של קוד לקוח אפשר לראות איך משתמשים בתבנית בקוד. שימו לב לנקודות הבאות:

  • אפשר להשתמש ב-templateGenerativeModel יחד עם startChat ו-sendMessage כשמשתמשים באינטראקציות מרובות שלבים.

  • במהלך האתחול של המודל בקוד הלקוח, אל תציינו את הפונקציות שהמודל יכול לגשת אליהן. במקום זאת, צריך לפרט את הפונקציות באובייקט tools של המידע המקדים בתבנית (כפי שמוסבר למעלה).

  • בדוגמה הבאה של קוד לקוח מניחים שאתם מגדירים סכימות של פונקציות בתבנית. אם במקום זאת תחליטו להגדיר סכימה בקוד הלקוח, היא תבטל את הסכימה שהוגדרה בתבנית. בהמשך הדף הזה מופיעה תבנית לדוגמה וקוד לקוח להגדרת סכימה בקוד לקוח.

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

דוגמה לקוד לקוח עם סכימת פונקציות שמוגדרת בתבנית

Swift

For Swift, using server prompt templates with multi-turn interactions is not yet supported. Check back soon!

Kotlin


// ...

// Initialize the Gemini Developer API backend service.
// Create a `TemplateGenerativeModel` instance.
val model = Firebase.ai(backend = GenerativeBackend.googleAI())
    .templateGenerativeModel()

// Start a chat session with a template that has functions listed as tools.
val chatSession = model.startChat(
    // Specify your template ID
    templateId = "my-function-calling-template-v1-0-0",
    inputs = emptyMap()
)

// Send a message that might trigger a function call.
val response = chatSession.sendMessage(
    content("user") { text(userMessage) }
)

// When the model responds with one or more function calls, invoke the function(s).
// Note that this is the same as when *not* using server prompt templates.
val functionCalls = response.functionCalls
val fetchWeatherCall = functionCalls.find { it.name == "fetchWeather" }

// Forward the structured input data from the model to the hypothetical external API.
val functionResponse = fetchWeatherCall?.let {
  // Alternatively, if your `Location` class is marked as @Serializable, you can use
  // val location = Json.decodeFromJsonElement(it.args["location"]!!)
  val location = Location(
      it.args["location"]!!.jsonObject["city"]!!.jsonPrimitive.content,
      it.args["location"]!!.jsonObject["state"]!!.jsonPrimitive.content
  )
  val date = it.args["date"]!!.jsonPrimitive.content
  fetchWeather(location, date)
}

Java

For Java, using server prompt templates with multi-turn interactions is not yet supported. Check back soon!

Web


// ...

// Initialize the Gemini Developer API backend service.
const ai = getAI(app, { backend: new GoogleAIBackend() });

// Create a `TemplateGenerativeModel` instance.
const model = getTemplateGenerativeModel(ai);

// Start a chat session with a template that has functions listed as tools.
const chatSession = model.startChat({
  // Specify your template ID
  templateId: 'my-function-calling-template-v1-0-0',
});

// Send a message that might trigger a function call.
const result = await chatSession.sendMessage(userMessage);

// When the model responds with one or more function calls, invoke the function(s).
// Note that this is the same as when *not* using server prompt templates.
const functionCalls = result.response.functionCalls();
let functionCall;
let functionResult;

if (functionCalls.length > 0) {
  for (const call of functionCalls) {
    if (call.name === "fetchWeather") {
      // Forward the structured input data prepared by the model
      // to the hypothetical external API.
      functionResult = await fetchWeather(call.args);
      functionCall = call;
    }
  }
}

Dart


// ...

// Initialize the Gemini Developer API backend service.
// Create a `TemplateGenerativeModel` instance.
final model = FirebaseAI.googleAI().templateGenerativeModel()

// Start a chat session with a template that has functions listed as tools.
var chatSession = model.startChat(
    // Specify your template ID
    'my-function-calling-template-v1-0-0',
);

// Send a message that might trigger a function call.
var response = await chatSession.sendMessage(
    Content.text(userMessage),
);

// Check if the model wants to call a function.
// Note that this is the same as when *not* using server prompt templates.
final functionCalls = response?.functionCalls.toList();
// When the model responds with one or more function calls, invoke the function(s).
if (functionCalls != null && functionCalls.isNotEmpty) {
  for (final functionCall in functionCalls) {
    if (functionCall.name == 'fetchWeather') {
      Map<String, dynamic> location =
          functionCall.args['location']! as Map<String, dynamic>;
      var date = functionCall.args['date']! as String;
      var city = location['city'] as String;
      var state = location['state'] as String;
      final functionResult =
          await fetchWeather(Location(city, state), date);
      // Send the response to the model so that it can use the result to
      // generate text for the user.
      response = await chatSession.sendMessage(
        Content.functionResponse(functionCall.name, functionResult),
      );
    }
  }
}

Unity


// ...

// Initialize the Gemini Developer API backend service.
var firebaseAI = FirebaseAI.GetInstance(FirebaseAI.Backend.GoogleAI());

// Create a `TemplateGenerativeModel` instance.
var model = firebaseAI.GetTemplateGenerativeModel();

// Start a chat session with a template that has functions listed as tools.
var chatSession = model.StartChat(
    // Specify your template ID
    "my-function-calling-template-v1-0-0"
);

try
{
   // Send a message that might trigger a function call.
   var response = await chatSession.SendMessageAsync(ModelContent.Text(userMessage));
   var functionResponses = new List();

  // When the model responds with one or more function calls, invoke the function(s).
  // Note that this is the same as when *not* using server prompt templates.
  foreach (var functionCall in response.FunctionCalls) {
    if (functionCall.Name == "fetchWeather") {
      // TODO(developer): Handle invalid arguments.
      var location = functionCall.Args["location"] as Dictionary<string, object>;
      var city = location["city"] as string;
      var state = location["state"] as string;
      var date = functionCall.Args["date"] as string;

      functionResponses.Add(ModelContent.FunctionResponse(
        name: functionCall.Name,
        // Forward the structured input data prepared by the model
        // to the hypothetical external API.
        response: FetchWeather(city: city, state: state, date: date)
      ));
    }
    // TODO(developer): Handle other potential function calls, if any.
  }

  // Send the function responses back to the model.
  var functionResponseResult = await chatSession.SendMessageAsync(functionResponses);
}
catch (Exception e) {
  Debug.LogError($"An error occurred: {e.Message}");
}


בקשה להפעלת פונקציה – הגדרת סכימה בקוד הלקוח

חשוב לעיין בקטעים שלמעלה שמסבירים איך קריאה לפונקציה עובדת עם תבניות של הנחיות בשרת (במיוחד השימוש בתג {{history}} בתוכן של התבנית). בקטע הזה מופיעה תבנית לדוגמה וקוד לקוח אם רוצים להגדיר את סכימת הפונקציה בקוד לקוח (במקום בתבנית).

חשוב לזכור את הנקודות הבאות לגבי הגדרת סכימת פונקציה בקוד הלקוח:

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

  • כדי להגדיר את סכימת הפונקציה בקוד הלקוח, כותבים את הצהרת הפונקציה ואז מספקים את ההצהרה ב-startChat, לא במהלך אתחול המודל (כמו שקורה כשלא משתמשים בתבניות של הנחיות לשרת).

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

דוגמה לתבנית עם סכימת פונקציות שמוגדרת בקוד הלקוח

---
model: gemini-3-flash-preview
tools:
  - name: fetchWeather
    description: Get the weather conditions for a specific city on a specific date.
---

What was the weather like in Boston, Massachusetts on 10/17 in year 2024, formatted in CELSIUS?

{{history}}

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

Swift

For Swift, using server prompt templates with multi-turn interactions is not yet supported. Check back soon!

Kotlin

// ...

// Initialize your desired Gemini API backend service.
// Create a `TemplateGenerativeModel` instance.
...

// Define the schema for any functions listed in your template.
val fetchWeatherTool = functionDeclarations(
    functionDeclarations = listOf(
        FunctionDeclaration(
            name = "fetchWeather",
            description = "Returns the weather for a given location at a given time",
            parameters = mapOf(
                "location" to Schema.obj(
                    description = "The name of the city and its state for which to get the weather. Only cities in the USA are supported.",
                    properties = mapOf(
                        "city" to Schema.string(
                            description = "The city of the location."
                        ),
                        "state" to Schema.string(
                            description = "The state of the location."
                        ),
                        "zipCode" to Schema.string(
                            description = "Optional zip code of the location.",
                            nullable = true
                        )
                    ),
                    optionalProperties = listOf("zipCode")
                ),
                "date" to Schema.string(
                    description = "The date for which to get the weather. Date must be in the format: YYYY-MM-DD."
                ),
                "unit" to Schema.enumeration(
                    description = "The temperature unit.",
                    values = listOf("CELSIUS", "FAHRENHEIT"),
                    nullable = true
                )

            ),
            optionalParameters = listOf("unit"),
        )
    )
)

// Start a chat session with a template that has functions listed as tools.
var chatSessionWithSchemaOverride = model.startChat(
    // Specify your template ID.
    templateId = "my-function-calling-template-with-no-function-schema-v1-0-0",
    // In `startChat`, provide the schema for any functions listed in your template.
    // This client-side schema will override any schema defined in the template.
    tools = listOf(fetchWeatherTool)
)

// Send a message that might trigger a function call.
...

// When the model responds with one or more function calls, invoke the function(s).
// Note that this is the same as when *not* using server prompt templates.
...

// Forward the structured input data from the model to the hypothetical external API.
...

Java

For Java, using server prompt templates with multi-turn interactions is not yet supported. Check back soon!

Web

// ...

// Initialize your desired Gemini API backend service.
...

// Create a `TemplateGenerativeModel` instance.
...

// Start a chat session with a template that has functions listed as tools.
const chatSessionWithSchemaOverride = model.startChat({
  // Specify your template ID.
  templateId: 'my-function-calling-template-with-no-function-schema-v1-0-0',
  // In `startChat`, provide the schema for any functions listed in your template.
  // This client-side schema will override any schema defined in the template.
  tools: [
    {
      functionDeclarations: [
        {
          name: "fetchWeather",
          parameters: {
            type: Type.OBJECT,
            properties: {
              location: {
                type: Type.OBJECT,
                description: "The name of the city and its state for which to get the weather. Only cities in the USA are supported.",
                properties: {
                  city: {
                    type: Type.STRING,
                    description: "The city of the location."
                  },
                  state: {
                    type: Type.STRING,
                    description: "The state of the location."
                  },
                  zipCode: {
                    type: Type.INTEGER,
                    description: "Optional zip code of the location.",
                    nullable: true
                  },
                },
                required: ["city", "state"],
              },
              date: {
                type: Type.STRING,
                description: "The date for which to get the weather. Date must be in the format: YYYY-MM-DD.",
              },
              unit: {
                type: Type.STRING,
                description: "The temperature unit.",
                enum: ["CELSIUS", "FAHRENHEIT"],
                nullable: true,
              },
            },
            required: ["location", "date"],
          },
        },
      ],
    }
  ],
});

// Send a message that might trigger a function call.
...

// When the model responds with one or more function calls, invoke the function(s).
// Note that this is the same as when *not* using server prompt templates.
...

Dart

// ...

// Initialize your desired Gemini API backend service.
// Create a `TemplateGenerativeModel` instance.
...

// Start a chat session with a template that has functions listed as tools.
final chatSessionWithSchemaOverride = model?.startChat(
      // Specify your template ID.
      'my-function-calling-template-with-no-function-schema-v1-0-0',
      inputs: {},
      // In `startChat`, provide the schema for any functions listed in your template.
      // This client-side schema will override any schema defined in the template.
      tools: [
        TemplateTool.functionDeclarations(
          [
            TemplateFunctionDeclaration(
              'fetchWeather',
              parameters: {
                'location': JSONSchema.object(
                  description:
                      'The name of the city and its state for which to get '
                      'the weather. Only cities in the USA are supported.',
                  properties: {
                    'city': JSONSchema.string(
                      description: 'The city of the location.',
                    ),
                    'state': JSONSchema.string(
                      description: 'The state of the location.',
                    ),
                    'zipCode': JSONSchema.integer(
                      description: 'Optional zip code of the location.',
                      nullable: true,
                    ),
                  },
                  optionalProperties: ['zipCode'],
                ),
                'date': JSONSchema.string(
                  description: 'The date for which to get the weather. '
                      'Date must be in the format: YYYY-MM-DD.',
                ),
                'unit': JSONSchema.enumString(
                  enumValues: ['CELSIUS', 'FAHRENHEIT'],
                  description: 'The temperature unit.',
                  nullable: true,
                ),
              },
              optionalParameters: ['unit'],
            ),
          ],
        ),
      ],
    );

// Send a message that might trigger a function call.
...

// Check if the model wants to call a function.
// Note that this is the same as when *not* using server prompt templates.
...

Unity

// ...

// Initialize your desired Gemini API backend service.
...

// Create a `TemplateGenerativeModel` instance.
...

// Define the schema for any functions listed in your template.
var fetchWeatherTool = new TemplateTool.FunctionDeclaration(
    name: "fetchWeather",
    parameters: new Dictionary<string, JsonSchema>() {
        { "location", JsonSchema.Object(
            description: "The name of the city and its state for which to get the weather. Only cities in the USA are supported.",
            properties: new Dictionary<string, JsonSchema>() {
                { "city", JsonSchema.String(description: "The city of the location.") },
                { "state", JsonSchema.String(description: "The state of the location.") },
                { "zipCode", JsonSchema.Int(description: "Optional zip code of the location.", nullable: true) }
            },
            optionalProperties: new[] { "zipCode" })
        },
        { "date", JsonSchema.String(description: "The date for which to get the weather. Date must be in the format: YYYY-MM-DD.")},
        { "unit", JsonSchema.Enum(
            values: new[] { "CELSIUS", "FAHRENHEIT" },
            description: "The temperature unit.",
            nullable: true)
        }
    },
    optionalParameters: new[] { "unit" }
);

// Start a chat session with a template that has functions listed as tools.
var chatSessionWithSchemaOverride = model.StartChat(
    // Specify your template ID.
    templateId: "my-function-calling-template-with-no-function-schema-v1-0-0",
    // In `startChat`, provide the schema for any functions listed in your template.
    // This client-side schema will override any schema defined in the template.
    tools: new[] { fetchWeatherTool }
);

try
{
   // Send a message that might trigger a function call.
   ...

  // When the model responds with one or more function calls, invoke the function(s).
  // Note that this is the same as when *not* using server prompt templates.
  ...
}

// ...



מה השלב הבא?