Gemini API

‫Gemini Interactions API הוא API ניסיוני שמאפשר למפתחים לבנות אפליקציות מבוססות-AI גנרטיבי באמצעות מודלים של Gemini. ‫Gemini הוא המודל הכי מתקדם שלנו, והוא נבנה מאפס כדי להיות מולטימודאלי. הוא יכול להכליל ולהבין בצורה חלקה סוגים שונים של מידע, כולל שפה, תמונות, אודיו, וידאו וקוד, לפעול על פיהם ולשלב ביניהם. אפשר להשתמש ב-Gemini API לתרחישי שימוש כמו חשיבה רציונלית על פני טקסט ותמונות, יצירת תוכן, סוכני דיאלוג, מערכות סיכום וסיווג ועוד.

פתיחת הדף כ-Markdown פתיחת המפרט של OpenAPI

CreateWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks

יצירת Webhook חדש.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

uri מחרוזת  (חובה)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-webhook.

‫subscribed_events array (object or string)  (required)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

uri מחרוזת  (אופציונלי)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-webhook.

subscribed_events array (object or string)  (optional)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

create_time string  (optional)

פלט בלבד. חותמת הזמן שבה נוצר ה-webhook.

update_time string  (optional)

פלט בלבד. חותמת הזמן שבה ה-webhook עודכן לאחרונה.

signing_secrets SigningSecret  (אופציונלי)

פלט בלבד. הסודות של החתימה שמשויכים ל-webhook הזה.

מייצג סוד חתימה שמשמש לאימות של מטען ייעודי (payload) של webhook.

שדות

truncated_secret string  (optional)

פלט בלבד. הגרסה הקטומה של הסוד לחתימה.

expire_time string  (optional)

פלט בלבד. תאריך התפוגה של סוד החתימה.

state enum (string)  (optional)

פלט בלבד. המצב של ה-webhook.

ערכים אפשריים:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
new_signing_secret string  (optional)

פלט בלבד. הסוד החדש לחתימה על ה-webhook. השדה הזה מאוכלס רק בזמן היצירה.

id string  (optional)

פלט בלבד. המזהה של ה-webhook.

דוגמה

דוגמה לתשובה

{
  "name": "string",
  "uri": "string",
  "subscribed_events": [
    "string"
  ],
  "create_time": "string",
  "update_time": "string",
  "signing_secrets": [
    {
      "truncated_secret": "string",
      "expire_time": "string"
    }
  ],
  "state": "enabled",
  "new_signing_secret": "string",
  "id": "string"
}

ListWebhooks

get https://generativelanguage.googleapis.com/v1beta/webhooks

מציגה רשימה של כל ה-Webhooks.

פרמטרים של נתיב או שאילתה

page_size integer  (optional)

אופציונלי. המספר המקסימלי של וווב-הוקים שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 50 ווּבְּהוּקים. הערך המקסימלי הוא 1,000.

page_token string  (optional)

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListWebhooks. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

webhooks array (Webhook)  (אופציונלי)

ה-webhooks.

next_page_token string  (optional)

טוקן שאפשר לשלוח כ-`page_token` כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

דוגמה

דוגמה לתשובה

{
  "webhooks": [
    {
      "name": "string",
      "uri": "string",
      "subscribed_events": [
        "string"
      ],
      "create_time": "string",
      "update_time": "string",
      "signing_secrets": [
        {
          "truncated_secret": "string",
          "expire_time": "string"
        }
      ],
      "state": "enabled",
      "new_signing_secret": "string",
      "id": "string"
    }
  ],
  "next_page_token": "string"
}

GetWebhook

get https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

מקבלים Webhook ספציפי.

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שרוצים לאחזר.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

uri מחרוזת  (אופציונלי)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-webhook.

subscribed_events array (object or string)  (optional)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

create_time string  (optional)

פלט בלבד. חותמת הזמן שבה נוצר ה-webhook.

update_time string  (optional)

פלט בלבד. חותמת הזמן שבה ה-webhook עודכן לאחרונה.

signing_secrets SigningSecret  (אופציונלי)

פלט בלבד. הסודות של החתימה שמשויכים ל-webhook הזה.

מייצג סוד חתימה שמשמש לאימות של מטען ייעודי (payload) של webhook.

שדות

truncated_secret string  (optional)

פלט בלבד. הגרסה הקטומה של הסוד לחתימה.

expire_time string  (optional)

פלט בלבד. תאריך התפוגה של סוד החתימה.

state enum (string)  (optional)

פלט בלבד. המצב של ה-webhook.

ערכים אפשריים:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
new_signing_secret string  (optional)

פלט בלבד. הסוד החדש לחתימה על ה-webhook. השדה הזה מאוכלס רק בזמן היצירה.

id string  (optional)

פלט בלבד. המזהה של ה-webhook.

דוגמה

דוגמה לתשובה

{
  "name": "string",
  "uri": "string",
  "subscribed_events": [
    "string"
  ],
  "create_time": "string",
  "update_time": "string",
  "signing_secrets": [
    {
      "truncated_secret": "string",
      "expire_time": "string"
    }
  ],
  "state": "enabled",
  "new_signing_secret": "string",
  "id": "string"
}

UpdateWebhook

patch https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

עדכון של Webhook קיים.

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שרוצים לעדכן.

update_mask string  (optional)

אופציונלי. רשימת השדות לעדכון.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

uri מחרוזת  (אופציונלי)

אופציונלי. כתובת ה-URI שאליה יישלחו אירועי ה-webhook.

subscribed_events array (object or string)  (optional)

אופציונלי. האירועים שה-webhook רשום אליהם. אירועים זמינים: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

state enum (string)  (optional)

אופציונלי. המצב של ה-webhook.

ערכים אפשריים:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

uri מחרוזת  (אופציונלי)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-webhook.

subscribed_events array (object or string)  (optional)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

create_time string  (optional)

פלט בלבד. חותמת הזמן שבה נוצר ה-webhook.

update_time string  (optional)

פלט בלבד. חותמת הזמן שבה ה-webhook עודכן לאחרונה.

signing_secrets SigningSecret  (אופציונלי)

פלט בלבד. הסודות של החתימה שמשויכים ל-webhook הזה.

מייצג סוד חתימה שמשמש לאימות של מטען ייעודי (payload) של webhook.

שדות

truncated_secret string  (optional)

פלט בלבד. הגרסה הקטומה של הסוד לחתימה.

expire_time string  (optional)

פלט בלבד. תאריך התפוגה של סוד החתימה.

state enum (string)  (optional)

פלט בלבד. המצב של ה-webhook.

ערכים אפשריים:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
new_signing_secret string  (optional)

פלט בלבד. הסוד החדש לחתימה על ה-webhook. השדה הזה מאוכלס רק בזמן היצירה.

id string  (optional)

פלט בלבד. המזהה של ה-webhook.

דוגמה

דוגמה לתשובה

{
  "name": "string",
  "uri": "string",
  "subscribed_events": [
    "string"
  ],
  "create_time": "string",
  "update_time": "string",
  "signing_secrets": [
    {
      "truncated_secret": "string",
      "expire_time": "string"
    }
  ],
  "state": "enabled",
  "new_signing_secret": "string",
  "id": "string"
}

DeleteWebhook

delete https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

מחיקת webhook.

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שרוצים למחוק. פורמט: `{webhook_id}`

תשובה

אם הפעולה בוצעה ללא שגיאות, התגובה תהיה ריקה.

דוגמה

RotateSigningSecret

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret

יוצר סוד חתימה חדש ל-Webhook.

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שעבורו רוצים ליצור סוד לחתימה. פורמט: `{webhook_id}`

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

revocation_behavior enum (string)  (optional)

אופציונלי. ההתנהגות של ביטול סודות חתימה קודמים.

ערכים אפשריים:

  • revoke_previous_secrets_after_h24
  • revoke_previous_secrets_immediately

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

secret string  (אופציונלי)

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

דוגמה

דוגמה לתשובה

{
  "secret": "string"
}

PingWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:ping

שולח אירוע פינג ל-Webhook.

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שצריך לשלוח לו פינג. פורמט: `{webhook_id}`

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

תשובה

אם הפעולה בוצעה ללא שגיאות, התגובה תהיה ריקה.

דוגמה

משאבים

Webhook

משאב Webhook.

שדות

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

uri מחרוזת  (אופציונלי)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-webhook.

subscribed_events array (object or string)  (optional)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

create_time string  (optional)

פלט בלבד. חותמת הזמן שבה נוצר ה-webhook.

update_time string  (optional)

פלט בלבד. חותמת הזמן שבה ה-webhook עודכן לאחרונה.

signing_secrets SigningSecret  (אופציונלי)

פלט בלבד. הסודות של החתימה שמשויכים ל-webhook הזה.

מייצג סוד חתימה שמשמש לאימות של מטען ייעודי (payload) של webhook.

שדות

truncated_secret string  (optional)

פלט בלבד. הגרסה הקטומה של הסוד לחתימה.

expire_time string  (optional)

פלט בלבד. תאריך התפוגה של סוד החתימה.

state enum (string)  (optional)

פלט בלבד. המצב של ה-webhook.

ערכים אפשריים:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
new_signing_secret string  (optional)

פלט בלבד. הסוד החדש לחתימה על ה-webhook. השדה הזה מאוכלס רק בזמן היצירה.

id string  (optional)

פלט בלבד. המזהה של ה-webhook.

מודלים של נתונים

InteractionSseEvent

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: event_type

InteractionCreatedEvent

event_type object  (required)

לא סופק תיאור.

הערך תמיד יהיה "interaction.created".

interaction Interaction  (חובה)

לא סופק תיאור.

משאב האינטראקציה.

שדות

model ModelOption  (אופציונלי)

השם של ה-`Model` שמשמש ליצירת האינטראקציה.

ערכים אפשריים:

  • gemini-2.5-computer-use-preview-10-2025

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

  • gemini-2.5-flash

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

  • gemini-2.5-flash-image

    מודל מקורי ליצירת תמונות, שעבר אופטימיזציה למהירות, לגמישות ולהבנה הקשרית. התמחור של קלט ופלט של טקסט זהה לזה של 2.5 Flash.

  • gemini-2.5-flash-lite

    המודל הכי קטן ומשתלם שלנו, שנועד לשימוש בהיקף גדול.

  • gemini-2.5-flash-lite-preview-09-2025

    המודל העדכני שמבוסס על Gemini 2.5 Flash lite ועבר אופטימיזציה ליעילות בעלויות, לתפוקה גבוהה ולאיכות גבוהה.

  • gemini-2.5-flash-native-audio-preview-12-2025

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

  • gemini-2.5-flash-preview-09-2025

    המודל הכי חדש שמבוסס על מודל ‎2.5 Flash. ‫2.5 Flash Preview הוא המודל הכי טוב לעיבוד בקנה מידה גדול, למשימות עם זמן טעינה נמוך ונפח גבוה שדורשות העמקה ולתרחישי שימוש סוכניים.

  • gemini-2.5-flash-preview-tts

    מודל ה-TTS שלנו, ‏‎2.5 Flash, מותאם ליצירת דיבור חזק עם זמן אחזור נמוך שאפשר לשלוט בו.

  • gemini-2.5-pro

    מודל רב-תכליתי מתקדם ביותר, שמצטיין בכתיבת קוד ובמשימות מורכבות של חשיבה רציונלית.

  • gemini-2.5-pro-preview-tts

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

  • gemini-3-flash-preview

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

  • gemini-3-pro-image-preview

    מודל חדשני ומתקדם ליצירה ועריכה של תמונות.

  • gemini-3-pro-preview

    המודל הכי חכם שלנו עם יכולות הסקת מסקנות מתקדמות והבנה מולטי-מודאלית, ויכולות עוצמתיות של סוכנים ושל תכנות בשיטת Vibe coding.

  • gemini-3.1-pro-preview

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

  • gemini-3.1-flash-image-preview

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

  • gemini-3.1-flash-lite-preview

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

  • gemini-3.1-flash-tts-preview

    ‫Gemini 3.1 Flash TTS: יצירת דיבור חזקה עם זמן אחזור נמוך. תוכלו ליהנות מתוצאות טבעיות, מהנחיות שניתנות להכוונה ומתגי אודיו חדשים שמאפשרים שליטה מדויקת בקריינות.

  • lyria-3-clip-preview

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

  • lyria-3-pro-preview

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

המודל שישלים את ההנחיה.\n\nפרטים נוספים זמינים במאמר בנושא [מודלים](https://ai.google.dev/gemini-api/docs/models).

agent AgentOption  (אופציונלי)

השם של ה-Agent ששימש ליצירת האינטראקציה.

ערכים אפשריים:

  • deep-research-pro-preview-12-2025

    סוכן Gemini Deep Research

  • deep-research-preview-04-2026

    סוכן Gemini Deep Research

  • deep-research-max-preview-04-2026

    סוכן Gemini Deep Research Max

הסוכן שאיתו רוצים ליצור אינטראקציה.

id string  (optional)

חובה. פלט בלבד. מזהה ייחודי של השלמת האינטראקציה.

status enum (string)  (optional)

חובה. פלט בלבד. הסטטוס של האינטראקציה.

ערכים אפשריים:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
created string  (אופציונלי)

חובה. פלט בלבד. השעה שבה התשובה נוצרה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

updated string  (אופציונלי)

חובה. פלט בלבד. השעה שבה התשובה עודכנה לאחרונה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

‫role string  (אופציונלי)

פלט בלבד. התפקיד של האינטראקציה.

system_instruction string  (optional)

הוראה למערכת לגבי האינטראקציה.

tools Tool  (אופציונלי)

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

כלי שהמודל יכול להשתמש בו.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

תפקיד

כלי שהמודל יכול להשתמש בו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "function".

name string  (אופציונלי)

שם הפונקציה.

description string  (אופציונלי)

תיאור של הפונקציה.

parameters object  (אופציונלי)

סכימת ה-JSON של הפרמטרים של הפונקציה.

CodeExecution

כלי שהמודל יכול להשתמש בו כדי להריץ קוד.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "code_execution".

UrlContext

כלי שהמודל יכול להשתמש בו כדי לאחזר הקשר של כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_context".

ComputerUse

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

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "computer_use".

environment enum (string)  (optional)

הסביבה שבה מתבצעת הפעולה.

ערכים אפשריים:

  • browser
excluded_predefined_functions array (string)  (optional)

רשימת הפונקציות המוגדרות מראש שמוחרגות מהקריאה למודל.

McpServer

שרת MCPServer הוא שרת שהמודל יכול להפעיל כדי לבצע פעולות.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "mcp_server".

name string  (אופציונלי)

השם של MCPServer.

‫url string  (optional)

כתובת ה-URL המלאה של נקודת הקצה של שרת ה-MCP. דוגמה: "https://api.example.com/mcp"

headers object  (אופציונלי)

אופציונלי: שדות לכותרות אימות, פסק זמן וכו', אם צריך.

allowed_tools AllowedTools  (אופציונלי)

הכלים המותרים.

ההגדרה של הכלים המותרים.

שדות

mode ToolChoiceType  (optional)

המצב של בחירת הכלי.

ערכים אפשריים:

  • auto
  • any
  • none
  • validated

tools מערך (מחרוזת)  (אופציונלי)

השמות של הכלים המותרים.

GoogleSearch

כלי שהמודל יכול להשתמש בו כדי לחפש ב-Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_search".

search_types array (enum (string))  (optional)

סוגי ההארקה של החיפוש שרוצים להפעיל.

ערכים אפשריים:

  • web_search
  • image_search
  • enterprise_web_search
FileSearch

כלי שהמודל יכול להשתמש בו כדי לחפש קבצים.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_search".

file_search_store_names array (string)  (optional)

הקובץ מכיל את שמות החנויות שרוצים לחפש.

top_k integer  (optional)

מספר החלקים של אחזור סמנטי שיש לאחזר.

‫metadata_filter string  (אופציונלי)

מסנן מטא-נתונים להחלה על המסמכים ועל חלקי הטקסט שחולצו באמצעות אחזור סמנטי.

GoogleMaps

כלי שהמודל יכול להשתמש בו כדי להתקשר למפות Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_maps".

enable_widget boolean  (optional)

האם להחזיר אסימון הקשר של הווידג'ט בתוצאה של קריאת הכלי בתגובה.

‫latitude number  (optional)

קו הרוחב של המיקום של המשתמש.

longitude number  (optional)

קו האורך של המיקום של המשתמש.

שליפה

כלי שהמודל יכול להשתמש בו כדי לאחזר קבצים.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "retrieval".

retrieval_types array (enum (string))  (optional)

סוגי אחזור הקבצים שרוצים להפעיל.

ערכים אפשריים:

  • vertex_ai_search
vertex_ai_search_config VertexAISearchConfig  (optional)

משמשת לציון הגדרות ל-VertexAISearch.

משמשת לציון הגדרות ל-VertexAISearch.

שדות

engine string  (אופציונלי)

אופציונלי. משמש לציון חיפוש מבוסס-Vertex AI.

datastores array (string)  (optional)

אופציונלי. משמש לציון מאגרי נתונים של חיפוש מבוסס-Vertex AI.

usage Usage  (אופציונלי)

פלט בלבד. נתונים סטטיסטיים על השימוש בטוקן של בקשת האינטראקציה.

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

שדות

total_input_tokens integer  (optional)

מספר הטוקנים בהנחיה (בהקשר).

input_tokens_by_modality ModalityTokens  (optional)

פירוט של השימוש בטוקנים של קלט לפי אופן השימוש.

מספר הטוקנים של אופן תגובה יחיד.

שדות

modality ResponseModality  (אופציונלי)

האופן שבו האסימונים נספרים.

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

‫tokens integer  (אופציונלי)

מספר הטוקנים של האופן.

total_cached_tokens integer  (optional)

מספר הטוקנים בחלק המאוחסן במטמון של ההנחיה (התוכן המאוחסן במטמון).

cached_tokens_by_modality ModalityTokens  (optional)

פירוט של השימוש בטוקנים במטמון לפי אופן השימוש.

מספר הטוקנים של אופן תגובה יחיד.

שדות

modality ResponseModality  (אופציונלי)

האופן שבו האסימונים נספרים.

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

‫tokens integer  (אופציונלי)

מספר הטוקנים של האופן.

total_output_tokens integer  (optional)

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

output_tokens_by_modality ModalityTokens  (optional)

פירוט של השימוש באסימוני פלט לפי אופן השימוש.

מספר הטוקנים של אופן תגובה יחיד.

שדות

modality ResponseModality  (אופציונלי)

האופן שבו האסימונים נספרים.

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

‫tokens integer  (אופציונלי)

מספר הטוקנים של האופן.

total_tool_use_tokens integer  (optional)

מספר הטוקנים שמופיעים בהנחיות לשימוש בכלים.

tool_use_tokens_by_modality ModalityTokens  (optional)

פירוט של השימוש בטוקנים של כלי לפי אופן השימוש.

מספר הטוקנים של אופן תגובה יחיד.

שדות

modality ResponseModality  (אופציונלי)

האופן שבו האסימונים נספרים.

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

‫tokens integer  (אופציונלי)

מספר הטוקנים של האופן.

total_thought_tokens integer  (optional)

מספר הטוקנים של מחשבות למודלים חושבים.

total_tokens integer  (optional)

המספר הכולל של הטוקנים בבקשת האינטראקציה (הנחיה + תגובות + טוקנים פנימיים אחרים).

grounding_tool_count GroundingToolCount  (optional)

מספר כלי העיגון.

מספר כלי ההארקה.

שדות

type enum (string)  (optional)

סוג כלי ההארקה שמשויך לספירה.

ערכים אפשריים:

  • google_search
  • google_maps
  • retrieval
count integer  (אופציונלי)

מספר כלי ההארקה.

response_modalities ResponseModality  (optional)

האופנים המבוקשים של התשובה (טקסט, תמונה, אודיו).

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

response_mime_type string  (optional)

סוג ה-MIME של התשובה. השדה הזה נדרש אם מוגדר response_format.

previous_interaction_id string  (optional)

המזהה של האינטראקציה הקודמת, אם יש כזו.

service_tier ServiceTier  (optional)

רמת השירות של האינטראקציה.

ערכים אפשריים:

  • flex
  • standard
  • priority

webhook_config WebhookConfig  (optional)

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

הודעה להגדרת אירועים של תגובה לפעולה מאתר אחר (webhook) לבקשה.

שדות

uris מערך (מחרוזת)  (אופציונלי)

אופציונלי. אם הגדרתם כתובות URI של webhook, הן ישמשו לאירועי webhook במקום כתובות ה-webhook הרשומות.

user_metadata object  (optional)

אופציונלי. מטא-נתוני המשתמש שיוחזרו בכל שליחת אירוע ל-webhook.

steps Step  (אופציונלי)

פלט בלבד. השלבים שמרכיבים את האינטראקציה.

שלב באינטראקציה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UserInputStep

קלט שסופק על ידי המשתמש.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "user_input".

content Content  (אופציונלי)

לא סופק תיאור.

תוכן התשובה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

AudioContent

בלוק של תוכן אודיו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "audio".

data string  (אופציונלי)

תוכן האודיו.

uri מחרוזת  (אופציונלי)

ה-URI של האודיו.

mime_type enum (string)  (optional)

סוג ה-MIME של האודיו.

ערכים אפשריים:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (אופציונלי)

מספר ערוצי האודיו.

sample_rate integer  (optional)

קצב הדגימה של האודיו.

DocumentContent

אבן בניין של תוכן במסמך.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "document".

data string  (אופציונלי)

תוכן המסמך.

uri מחרוזת  (אופציונלי)

ה-URI של המסמך.

mime_type enum (string)  (optional)

סוג ה-MIME של המסמך.

ערכים אפשריים:

  • application/pdf
VideoContent

בלוק של תוכן וידאו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "video".

data string  (אופציונלי)

תוכן הסרטון.

uri מחרוזת  (אופציונלי)

ה-URI של הסרטון.

mime_type enum (string)  (optional)

סוג ה-MIME של הסרטון.

ערכים אפשריים:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

ModelOutputStep

פלט שנוצר על ידי המודל.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "model_output".

content Content  (אופציונלי)

לא סופק תיאור.

תוכן התשובה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

AudioContent

בלוק של תוכן אודיו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "audio".

data string  (אופציונלי)

תוכן האודיו.

uri מחרוזת  (אופציונלי)

ה-URI של האודיו.

mime_type enum (string)  (optional)

סוג ה-MIME של האודיו.

ערכים אפשריים:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (אופציונלי)

מספר ערוצי האודיו.

sample_rate integer  (optional)

קצב הדגימה של האודיו.

DocumentContent

אבן בניין של תוכן במסמך.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "document".

data string  (אופציונלי)

תוכן המסמך.

uri מחרוזת  (אופציונלי)

ה-URI של המסמך.

mime_type enum (string)  (optional)

סוג ה-MIME של המסמך.

ערכים אפשריים:

  • application/pdf
VideoContent

בלוק של תוכן וידאו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "video".

data string  (אופציונלי)

תוכן הסרטון.

uri מחרוזת  (אופציונלי)

ה-URI של הסרטון.

mime_type enum (string)  (optional)

סוג ה-MIME של הסרטון.

ערכים אפשריים:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

ThoughtStep

שלב חשיבה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "thought".

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

summary ThoughtSummaryContent  (אופציונלי)

סיכום של המחשבה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

FunctionCallStep

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

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "function_call".

name string  (required)

חובה. השם של הכלי שאליו מתקשרים.

ארגומנטים object  (חובה)

חובה. הארגומנטים להעברה לפונקציה.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

CodeExecutionCallStep

שלב של קריאה להרצת קוד.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "code_execution_call".

arguments CodeExecutionCallStepArguments  (required)

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

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

שדות

language enum (string)  (optional)

שפת התכנות של ה-`code`.

ערכים אפשריים:

  • python
code string  (אופציונלי)

הקוד שיופעל.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

UrlContextCallStep

שלב של שיחה בהקשר של כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_context_call".

arguments UrlContextCallStepArguments  (required)

חובה. הארגומנטים להעברה להקשר של כתובת ה-URL.

הארגומנטים להעברה להקשר של כתובת ה-URL.

שדות

‫urls array (string)  (optional)

כתובות ה-URL לאחזור.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

McpServerToolCallStep

שלב הקריאה לכלי MCPServer.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "mcp_server_tool_call".

name string  (required)

חובה. השם של הכלי שהופעל.

server_name string  (required)

חובה. השם של שרת ה-MCP שנעשה בו שימוש.

ארגומנטים object  (חובה)

חובה. אובייקט JSON של הארגומנטים של הפונקציה.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleSearchCallStep

שלב השיחה בחיפוש Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_search_call".

arguments GoogleSearchCallStepArguments  (required)

חובה. הארגומנטים להעברה לחיפוש Google.

הארגומנטים להעברה לחיפוש Google.

שדות

‫queries array (string)  (optional)

שאילתות לחיפוש באינטרנט לצורך המשך החיפוש באינטרנט.

search_type enum (string)  (optional)

סוג ההארקה של החיפוש שמופעל.

ערכים אפשריים:

  • web_search
  • image_search
  • enterprise_web_search
id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

FileSearchCallStep

שלב של שיחה לחיפוש קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_search_call".

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleMapsCallStep

שלב השיחה במפות Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_maps_call".

arguments GoogleMapsCallStepArguments  (optional)

הארגומנטים להעברה לכלי של מפות Google.

הארגומנטים להעברה לכלי של מפות Google.

שדות

‫queries array (string)  (optional)

השאילתות שיופעלו.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

FunctionResultStep

התוצאה של קריאה לכלי פונקציה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "function_result".

name string  (אופציונלי)

שם הכלי שהופעל.

is_error boolean  (optional)

האם קריאת הפונקציה הסתיימה בשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

result array (FunctionResultSubcontent) or string  (required)

התוצאה של קריאת הכלי.

CodeExecutionResultStep

שלב התוצאה של הרצת הקוד.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "code_execution_result".

result string  (required)

חובה. הפלט של הרצת הקוד.

is_error boolean  (optional)

האם הרצת הקוד הסתיימה בשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

UrlContextResultStep

שלב התוצאה של ההקשר של כתובת ה-URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_context_result".

result UrlContextResultItem  (required)

חובה. התוצאות של ההקשר של כתובת ה-URL.

התוצאה של ההקשר של כתובת ה-URL.

שדות

‫url string  (optional)

כתובת ה-URL שאוחזרה.

status enum (string)  (optional)

הסטטוס של אחזור כתובת ה-URL.

ערכים אפשריים:

  • success
  • error
  • paywall
  • unsafe
is_error boolean  (optional)

האם ההקשר של כתובת ה-URL הוביל לשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleSearchResultStep

שלב של תוצאת חיפוש ב-Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_search_result".

result GoogleSearchResultItem  (חובה)

חובה. תוצאות מחיפוש Google.

התוצאה של חיפוש Google.

שדות

search_suggestions string  (optional)

קטע קוד של תוכן אינטרנט שאפשר להטמיע בדף אינטרנט או בתצוגת אינטרנט של אפליקציה.

is_error boolean  (optional)

האם החיפוש ב-Google הסתיים בשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

McpServerToolResultStep

שלב התוצאה של כלי MCPServer.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "mcp_server_tool_result".

name string  (אופציונלי)

השם של הכלי שמופעל עבור קריאה ספציפית לכלי.

server_name string  (optional)

השם של שרת ה-MCP שנעשה בו שימוש.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

result array (FunctionResultSubcontent) or string  (required)

הפלט מהשיחה עם שרת ה-MCP. יכול להיות טקסט פשוט או תוכן עשיר.

FileSearchResultStep

שלב של תוצאת חיפוש קבצים.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_search_result".

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleMapsResultStep

שלב התוצאה במפות Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_maps_result".

result GoogleMapsResultItem  (חובה)

לא סופק תיאור.

התוצאה של מפות Google.

שדות

מקומות GoogleMapsResultPlaces  (אופציונלי)

לא סופק תיאור.

שדות

place_id string  (optional)

לא סופק תיאור.

name string  (אופציונלי)

לא סופק תיאור.

‫url string  (optional)

לא סופק תיאור.

review_snippets ReviewSnippet  (אופציונלי)

לא סופק תיאור.

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

widget_context_token string  (optional)

לא סופק תיאור.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

‫input Content or array (Content) or array (Step) or string  (optional)

הקלט לאינטראקציה.

response_format ResponseFormat או ResponseFormatList  (אופציונלי)

ההגדרה הזו מחייבת שהתגובה שנוצרת תהיה אובייקט JSON שתואם לסכימת ה-JSON שצוינה בשדה הזה.

agent_config object  (optional)

פרמטרים להגדרה של האינטראקציה עם הנציג.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

DynamicAgentConfig

הגדרות של סוכנים דינמיים.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "dynamic".

DeepResearchAgentConfig

ההגדרה של סוכן Deep Research.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "deep-research".

thinking_summaries ThinkingSummaries  (אופציונלי)

האם לכלול בתשובה סיכומי מחשבות.

ערכים אפשריים:

  • auto
  • none

visualization enum (string)  (optional)

האם לכלול בתשובה פריטי ויזואליזציה.

ערכים אפשריים:

  • off
  • auto
collaborative_planning boolean  (optional)

הפעלה של תכנון עם מעורבות אנושית לסוכן Deep Research. אם הערך הוא true, סוכן Deep Research יספק תוכנית מחקר בתשובה שלו. הסוכן ימשיך רק אם המשתמש יאשר את התוכנית בתור הבא.

event_id string  (optional)

טוקן event_id שישמש להמשך זרם האינטראקציות, מהאירוע הזה.

InteractionCompletedEvent

event_type object  (required)

לא סופק תיאור.

הערך תמיד יהיה "interaction.completed".

interaction Interaction  (חובה)

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

משאב האינטראקציה.

שדות

model ModelOption  (אופציונלי)

השם של ה-`Model` שמשמש ליצירת האינטראקציה.

ערכים אפשריים:

  • gemini-2.5-computer-use-preview-10-2025

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

  • gemini-2.5-flash

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

  • gemini-2.5-flash-image

    מודל מקורי ליצירת תמונות, שעבר אופטימיזציה למהירות, לגמישות ולהבנה הקשרית. התמחור של קלט ופלט של טקסט זהה לזה של 2.5 Flash.

  • gemini-2.5-flash-lite

    המודל הכי קטן ומשתלם שלנו, שנועד לשימוש בהיקף גדול.

  • gemini-2.5-flash-lite-preview-09-2025

    המודל העדכני שמבוסס על Gemini 2.5 Flash lite ועבר אופטימיזציה ליעילות בעלויות, לתפוקה גבוהה ולאיכות גבוהה.

  • gemini-2.5-flash-native-audio-preview-12-2025

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

  • gemini-2.5-flash-preview-09-2025

    המודל הכי חדש שמבוסס על מודל ‎2.5 Flash. ‫2.5 Flash Preview הוא המודל הכי טוב לעיבוד בקנה מידה גדול, למשימות עם זמן טעינה נמוך ונפח גבוה שדורשות העמקה ולתרחישי שימוש סוכניים.

  • gemini-2.5-flash-preview-tts

    מודל ה-TTS שלנו, ‏‎2.5 Flash, מותאם ליצירת דיבור חזק עם זמן אחזור נמוך שאפשר לשלוט בו.

  • gemini-2.5-pro

    מודל רב-תכליתי מתקדם ביותר, שמצטיין בכתיבת קוד ובמשימות מורכבות של חשיבה רציונלית.

  • gemini-2.5-pro-preview-tts

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

  • gemini-3-flash-preview

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

  • gemini-3-pro-image-preview

    מודל חדשני ומתקדם ליצירה ועריכה של תמונות.

  • gemini-3-pro-preview

    המודל הכי חכם שלנו עם יכולות הסקת מסקנות מתקדמות והבנה מולטי-מודאלית, ויכולות עוצמתיות של סוכנים ושל תכנות בשיטת Vibe coding.

  • gemini-3.1-pro-preview

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

  • gemini-3.1-flash-image-preview

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

  • gemini-3.1-flash-lite-preview

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

  • gemini-3.1-flash-tts-preview

    ‫Gemini 3.1 Flash TTS: יצירת דיבור חזקה עם זמן אחזור נמוך. תוכלו ליהנות מתוצאות טבעיות, מהנחיות שניתנות להכוונה ומתגי אודיו חדשים שמאפשרים שליטה מדויקת בקריינות.

  • lyria-3-clip-preview

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

  • lyria-3-pro-preview

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

המודל שישלים את ההנחיה.\n\nפרטים נוספים זמינים במאמר בנושא [מודלים](https://ai.google.dev/gemini-api/docs/models).

agent AgentOption  (אופציונלי)

השם של ה-Agent ששימש ליצירת האינטראקציה.

ערכים אפשריים:

  • deep-research-pro-preview-12-2025

    סוכן Gemini Deep Research

  • deep-research-preview-04-2026

    סוכן Gemini Deep Research

  • deep-research-max-preview-04-2026

    סוכן Gemini Deep Research Max

הסוכן שאיתו רוצים ליצור אינטראקציה.

id string  (optional)

חובה. פלט בלבד. מזהה ייחודי של השלמת האינטראקציה.

status enum (string)  (optional)

חובה. פלט בלבד. הסטטוס של האינטראקציה.

ערכים אפשריים:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
created string  (אופציונלי)

חובה. פלט בלבד. השעה שבה התשובה נוצרה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

updated string  (אופציונלי)

חובה. פלט בלבד. השעה שבה התשובה עודכנה לאחרונה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

‫role string  (אופציונלי)

פלט בלבד. התפקיד של האינטראקציה.

system_instruction string  (optional)

הוראה למערכת לגבי האינטראקציה.

tools Tool  (אופציונלי)

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

כלי שהמודל יכול להשתמש בו.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

תפקיד

כלי שהמודל יכול להשתמש בו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "function".

name string  (אופציונלי)

שם הפונקציה.

description string  (אופציונלי)

תיאור של הפונקציה.

parameters object  (אופציונלי)

סכימת ה-JSON של הפרמטרים של הפונקציה.

CodeExecution

כלי שהמודל יכול להשתמש בו כדי להריץ קוד.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "code_execution".

UrlContext

כלי שהמודל יכול להשתמש בו כדי לאחזר הקשר של כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_context".

ComputerUse

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

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "computer_use".

environment enum (string)  (optional)

הסביבה שבה מתבצעת הפעולה.

ערכים אפשריים:

  • browser
excluded_predefined_functions array (string)  (optional)

רשימת הפונקציות המוגדרות מראש שמוחרגות מהקריאה למודל.

McpServer

שרת MCPServer הוא שרת שהמודל יכול להפעיל כדי לבצע פעולות.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "mcp_server".

name string  (אופציונלי)

השם של MCPServer.

‫url string  (optional)

כתובת ה-URL המלאה של נקודת הקצה של שרת ה-MCP. דוגמה: "https://api.example.com/mcp"

headers object  (אופציונלי)

אופציונלי: שדות לכותרות אימות, פסק זמן וכו', אם צריך.

allowed_tools AllowedTools  (אופציונלי)

הכלים המותרים.

ההגדרה של הכלים המותרים.

שדות

mode ToolChoiceType  (optional)

המצב של בחירת הכלי.

ערכים אפשריים:

  • auto
  • any
  • none
  • validated

tools מערך (מחרוזת)  (אופציונלי)

השמות של הכלים המותרים.

GoogleSearch

כלי שהמודל יכול להשתמש בו כדי לחפש ב-Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_search".

search_types array (enum (string))  (optional)

סוגי ההארקה של החיפוש שרוצים להפעיל.

ערכים אפשריים:

  • web_search
  • image_search
  • enterprise_web_search
FileSearch

כלי שהמודל יכול להשתמש בו כדי לחפש קבצים.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_search".

file_search_store_names array (string)  (optional)

הקובץ מכיל את שמות החנויות שרוצים לחפש.

top_k integer  (optional)

מספר החלקים של אחזור סמנטי שיש לאחזר.

‫metadata_filter string  (אופציונלי)

מסנן מטא-נתונים להחלה על המסמכים ועל חלקי הטקסט שחולצו באמצעות אחזור סמנטי.

GoogleMaps

כלי שהמודל יכול להשתמש בו כדי להתקשר למפות Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_maps".

enable_widget boolean  (optional)

האם להחזיר אסימון הקשר של הווידג'ט בתוצאה של קריאת הכלי בתגובה.

‫latitude number  (optional)

קו הרוחב של המיקום של המשתמש.

longitude number  (optional)

קו האורך של המיקום של המשתמש.

שליפה

כלי שהמודל יכול להשתמש בו כדי לאחזר קבצים.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "retrieval".

retrieval_types array (enum (string))  (optional)

סוגי אחזור הקבצים שרוצים להפעיל.

ערכים אפשריים:

  • vertex_ai_search
vertex_ai_search_config VertexAISearchConfig  (optional)

משמשת לציון הגדרות ל-VertexAISearch.

משמשת לציון הגדרות ל-VertexAISearch.

שדות

engine string  (אופציונלי)

אופציונלי. משמש לציון חיפוש מבוסס-Vertex AI.

datastores array (string)  (optional)

אופציונלי. משמש לציון מאגרי נתונים של חיפוש מבוסס-Vertex AI.

usage Usage  (אופציונלי)

פלט בלבד. נתונים סטטיסטיים על השימוש בטוקן של בקשת האינטראקציה.

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

שדות

total_input_tokens integer  (optional)

מספר הטוקנים בהנחיה (בהקשר).

input_tokens_by_modality ModalityTokens  (optional)

פירוט של השימוש בטוקנים של קלט לפי אופן השימוש.

מספר הטוקנים של אופן תגובה יחיד.

שדות

modality ResponseModality  (אופציונלי)

האופן שבו האסימונים נספרים.

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

‫tokens integer  (אופציונלי)

מספר הטוקנים של האופן.

total_cached_tokens integer  (optional)

מספר הטוקנים בחלק המאוחסן במטמון של ההנחיה (התוכן המאוחסן במטמון).

cached_tokens_by_modality ModalityTokens  (optional)

פירוט של השימוש בטוקנים במטמון לפי אופן השימוש.

מספר הטוקנים של אופן תגובה יחיד.

שדות

modality ResponseModality  (אופציונלי)

האופן שבו האסימונים נספרים.

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

‫tokens integer  (אופציונלי)

מספר הטוקנים של האופן.

total_output_tokens integer  (optional)

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

output_tokens_by_modality ModalityTokens  (optional)

פירוט של השימוש באסימוני פלט לפי אופן השימוש.

מספר הטוקנים של אופן תגובה יחיד.

שדות

modality ResponseModality  (אופציונלי)

האופן שבו האסימונים נספרים.

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

‫tokens integer  (אופציונלי)

מספר הטוקנים של האופן.

total_tool_use_tokens integer  (optional)

מספר הטוקנים שמופיעים בהנחיות לשימוש בכלים.

tool_use_tokens_by_modality ModalityTokens  (optional)

פירוט של השימוש בטוקנים של כלי לפי אופן השימוש.

מספר הטוקנים של אופן תגובה יחיד.

שדות

modality ResponseModality  (אופציונלי)

האופן שבו האסימונים נספרים.

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

‫tokens integer  (אופציונלי)

מספר הטוקנים של האופן.

total_thought_tokens integer  (optional)

מספר הטוקנים של מחשבות למודלים חושבים.

total_tokens integer  (optional)

המספר הכולל של הטוקנים בבקשת האינטראקציה (הנחיה + תגובות + טוקנים פנימיים אחרים).

grounding_tool_count GroundingToolCount  (optional)

מספר כלי העיגון.

מספר כלי ההארקה.

שדות

type enum (string)  (optional)

סוג כלי ההארקה שמשויך לספירה.

ערכים אפשריים:

  • google_search
  • google_maps
  • retrieval
count integer  (אופציונלי)

מספר כלי ההארקה.

response_modalities ResponseModality  (optional)

האופנים המבוקשים של התשובה (טקסט, תמונה, אודיו).

ערכים אפשריים:

  • text
  • image
  • audio
  • video
  • document

response_mime_type string  (optional)

סוג ה-MIME של התשובה. השדה הזה נדרש אם מוגדר response_format.

previous_interaction_id string  (optional)

המזהה של האינטראקציה הקודמת, אם יש כזו.

service_tier ServiceTier  (optional)

רמת השירות של האינטראקציה.

ערכים אפשריים:

  • flex
  • standard
  • priority

webhook_config WebhookConfig  (optional)

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

הודעה להגדרת אירועים של תגובה לפעולה מאתר אחר (webhook) לבקשה.

שדות

uris מערך (מחרוזת)  (אופציונלי)

אופציונלי. אם הגדרתם כתובות URI של webhook, הן ישמשו לאירועי webhook במקום כתובות ה-webhook הרשומות.

user_metadata object  (optional)

אופציונלי. מטא-נתוני המשתמש שיוחזרו בכל שליחת אירוע ל-webhook.

steps Step  (אופציונלי)

פלט בלבד. השלבים שמרכיבים את האינטראקציה.

שלב באינטראקציה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UserInputStep

קלט שסופק על ידי המשתמש.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "user_input".

content Content  (אופציונלי)

לא סופק תיאור.

תוכן התשובה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

AudioContent

בלוק של תוכן אודיו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "audio".

data string  (אופציונלי)

תוכן האודיו.

uri מחרוזת  (אופציונלי)

ה-URI של האודיו.

mime_type enum (string)  (optional)

סוג ה-MIME של האודיו.

ערכים אפשריים:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (אופציונלי)

מספר ערוצי האודיו.

sample_rate integer  (optional)

קצב הדגימה של האודיו.

DocumentContent

אבן בניין של תוכן במסמך.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "document".

data string  (אופציונלי)

תוכן המסמך.

uri מחרוזת  (אופציונלי)

ה-URI של המסמך.

mime_type enum (string)  (optional)

סוג ה-MIME של המסמך.

ערכים אפשריים:

  • application/pdf
VideoContent

בלוק של תוכן וידאו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "video".

data string  (אופציונלי)

תוכן הסרטון.

uri מחרוזת  (אופציונלי)

ה-URI של הסרטון.

mime_type enum (string)  (optional)

סוג ה-MIME של הסרטון.

ערכים אפשריים:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

ModelOutputStep

פלט שנוצר על ידי המודל.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "model_output".

content Content  (אופציונלי)

לא סופק תיאור.

תוכן התשובה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

AudioContent

בלוק של תוכן אודיו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "audio".

data string  (אופציונלי)

תוכן האודיו.

uri מחרוזת  (אופציונלי)

ה-URI של האודיו.

mime_type enum (string)  (optional)

סוג ה-MIME של האודיו.

ערכים אפשריים:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (אופציונלי)

מספר ערוצי האודיו.

sample_rate integer  (optional)

קצב הדגימה של האודיו.

DocumentContent

אבן בניין של תוכן במסמך.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "document".

data string  (אופציונלי)

תוכן המסמך.

uri מחרוזת  (אופציונלי)

ה-URI של המסמך.

mime_type enum (string)  (optional)

סוג ה-MIME של המסמך.

ערכים אפשריים:

  • application/pdf
VideoContent

בלוק של תוכן וידאו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "video".

data string  (אופציונלי)

תוכן הסרטון.

uri מחרוזת  (אופציונלי)

ה-URI של הסרטון.

mime_type enum (string)  (optional)

סוג ה-MIME של הסרטון.

ערכים אפשריים:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

ThoughtStep

שלב חשיבה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "thought".

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

summary ThoughtSummaryContent  (אופציונלי)

סיכום של המחשבה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

FunctionCallStep

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

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "function_call".

name string  (required)

חובה. השם של הכלי שאליו מתקשרים.

ארגומנטים object  (חובה)

חובה. הארגומנטים להעברה לפונקציה.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

CodeExecutionCallStep

שלב של קריאה להרצת קוד.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "code_execution_call".

arguments CodeExecutionCallStepArguments  (required)

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

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

שדות

language enum (string)  (optional)

שפת התכנות של ה-`code`.

ערכים אפשריים:

  • python
code string  (אופציונלי)

הקוד שיופעל.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

UrlContextCallStep

שלב של שיחה בהקשר של כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_context_call".

arguments UrlContextCallStepArguments  (required)

חובה. הארגומנטים להעברה להקשר של כתובת ה-URL.

הארגומנטים להעברה להקשר של כתובת ה-URL.

שדות

‫urls array (string)  (optional)

כתובות ה-URL לאחזור.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

McpServerToolCallStep

שלב הקריאה לכלי MCPServer.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "mcp_server_tool_call".

name string  (required)

חובה. השם של הכלי שהופעל.

server_name string  (required)

חובה. השם של שרת ה-MCP שנעשה בו שימוש.

ארגומנטים object  (חובה)

חובה. אובייקט JSON של הארגומנטים של הפונקציה.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleSearchCallStep

שלב השיחה בחיפוש Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_search_call".

arguments GoogleSearchCallStepArguments  (required)

חובה. הארגומנטים להעברה לחיפוש Google.

הארגומנטים להעברה לחיפוש Google.

שדות

‫queries array (string)  (optional)

שאילתות לחיפוש באינטרנט לצורך המשך החיפוש באינטרנט.

search_type enum (string)  (optional)

סוג ההארקה של החיפוש שמופעל.

ערכים אפשריים:

  • web_search
  • image_search
  • enterprise_web_search
id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

FileSearchCallStep

שלב של שיחה לחיפוש קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_search_call".

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleMapsCallStep

שלב השיחה במפות Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_maps_call".

arguments GoogleMapsCallStepArguments  (optional)

הארגומנטים להעברה לכלי של מפות Google.

הארגומנטים להעברה לכלי של מפות Google.

שדות

‫queries array (string)  (optional)

השאילתות שיופעלו.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

FunctionResultStep

התוצאה של קריאה לכלי פונקציה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "function_result".

name string  (אופציונלי)

שם הכלי שהופעל.

is_error boolean  (optional)

האם קריאת הפונקציה הסתיימה בשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

result array (FunctionResultSubcontent) or string  (required)

התוצאה של קריאת הכלי.

CodeExecutionResultStep

שלב התוצאה של הרצת הקוד.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "code_execution_result".

result string  (required)

חובה. הפלט של הרצת הקוד.

is_error boolean  (optional)

האם הרצת הקוד הסתיימה בשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

UrlContextResultStep

שלב התוצאה של ההקשר של כתובת ה-URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_context_result".

result UrlContextResultItem  (required)

חובה. התוצאות של ההקשר של כתובת ה-URL.

התוצאה של ההקשר של כתובת ה-URL.

שדות

‫url string  (optional)

כתובת ה-URL שאוחזרה.

status enum (string)  (optional)

הסטטוס של אחזור כתובת ה-URL.

ערכים אפשריים:

  • success
  • error
  • paywall
  • unsafe
is_error boolean  (optional)

האם ההקשר של כתובת ה-URL הוביל לשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleSearchResultStep

שלב של תוצאת חיפוש ב-Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_search_result".

result GoogleSearchResultItem  (חובה)

חובה. תוצאות מחיפוש Google.

התוצאה של חיפוש Google.

שדות

search_suggestions string  (optional)

קטע קוד של תוכן אינטרנט שאפשר להטמיע בדף אינטרנט או בתצוגת אינטרנט של אפליקציה.

is_error boolean  (optional)

האם החיפוש ב-Google הסתיים בשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

McpServerToolResultStep

שלב התוצאה של כלי MCPServer.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "mcp_server_tool_result".

name string  (אופציונלי)

השם של הכלי שמופעל עבור קריאה ספציפית לכלי.

server_name string  (optional)

השם של שרת ה-MCP שנעשה בו שימוש.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

result array (FunctionResultSubcontent) or string  (required)

הפלט מהשיחה עם שרת ה-MCP. יכול להיות טקסט פשוט או תוכן עשיר.

FileSearchResultStep

שלב של תוצאת חיפוש קבצים.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_search_result".

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleMapsResultStep

שלב התוצאה במפות Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_maps_result".

result GoogleMapsResultItem  (חובה)

לא סופק תיאור.

התוצאה של מפות Google.

שדות

מקומות GoogleMapsResultPlaces  (אופציונלי)

לא סופק תיאור.

שדות

place_id string  (optional)

לא סופק תיאור.

name string  (אופציונלי)

לא סופק תיאור.

‫url string  (optional)

לא סופק תיאור.

review_snippets ReviewSnippet  (אופציונלי)

לא סופק תיאור.

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

widget_context_token string  (optional)

לא סופק תיאור.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

‫input Content or array (Content) or array (Step) or string  (optional)

הקלט לאינטראקציה.

response_format ResponseFormat או ResponseFormatList  (אופציונלי)

ההגדרה הזו מחייבת שהתגובה שנוצרת תהיה אובייקט JSON שתואם לסכימת ה-JSON שצוינה בשדה הזה.

agent_config object  (optional)

פרמטרים להגדרה של האינטראקציה עם הנציג.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

DynamicAgentConfig

הגדרות של סוכנים דינמיים.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "dynamic".

DeepResearchAgentConfig

ההגדרה של סוכן Deep Research.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "deep-research".

thinking_summaries ThinkingSummaries  (אופציונלי)

האם לכלול בתשובה סיכומי מחשבות.

ערכים אפשריים:

  • auto
  • none

visualization enum (string)  (optional)

האם לכלול בתשובה פריטי ויזואליזציה.

ערכים אפשריים:

  • off
  • auto
collaborative_planning boolean  (optional)

הפעלה של תכנון עם מעורבות אנושית לסוכן Deep Research. אם הערך הוא true, סוכן Deep Research יספק תוכנית מחקר בתשובה שלו. הסוכן ימשיך רק אם המשתמש יאשר את התוכנית בתור הבא.

event_id string  (optional)

טוקן event_id שישמש להמשך זרם האינטראקציות, מהאירוע הזה.

InteractionStatusUpdate

event_type object  (required)

לא סופק תיאור.

הערך תמיד יהיה "interaction.status_update".

interaction_id string  (required)

לא סופק תיאור.

status enum (string)  (required)

לא סופק תיאור.

ערכים אפשריים:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
event_id string  (optional)

טוקן event_id שישמש להמשך זרם האינטראקציות, מהאירוע הזה.

ErrorEvent

event_type object  (required)

לא סופק תיאור.

הערך תמיד יהיה "error".

error Error  (אופציונלי)

לא סופק תיאור.

הודעת שגיאה מאינטראקציה.

שדות

code string  (אופציונלי)

‫URI שמזהה את סוג השגיאה.

‫message string  (אופציונלי)

הודעת שגיאה שאנשים יכולים לקרוא.

event_id string  (optional)

טוקן event_id שישמש להמשך זרם האינטראקציות, מהאירוע הזה.

StepStart

event_type object  (required)

לא סופק תיאור.

הערך תמיד יהיה "step.start".

index integer  (required)

לא סופק תיאור.

step Step  (חובה)

לא סופק תיאור.

שלב באינטראקציה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UserInputStep

קלט שסופק על ידי המשתמש.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "user_input".

content Content  (אופציונלי)

לא סופק תיאור.

תוכן התשובה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

AudioContent

בלוק של תוכן אודיו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "audio".

data string  (אופציונלי)

תוכן האודיו.

uri מחרוזת  (אופציונלי)

ה-URI של האודיו.

mime_type enum (string)  (optional)

סוג ה-MIME של האודיו.

ערכים אפשריים:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (אופציונלי)

מספר ערוצי האודיו.

sample_rate integer  (optional)

קצב הדגימה של האודיו.

DocumentContent

אבן בניין של תוכן במסמך.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "document".

data string  (אופציונלי)

תוכן המסמך.

uri מחרוזת  (אופציונלי)

ה-URI של המסמך.

mime_type enum (string)  (optional)

סוג ה-MIME של המסמך.

ערכים אפשריים:

  • application/pdf
VideoContent

בלוק של תוכן וידאו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "video".

data string  (אופציונלי)

תוכן הסרטון.

uri מחרוזת  (אופציונלי)

ה-URI של הסרטון.

mime_type enum (string)  (optional)

סוג ה-MIME של הסרטון.

ערכים אפשריים:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

ModelOutputStep

פלט שנוצר על ידי המודל.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "model_output".

content Content  (אופציונלי)

לא סופק תיאור.

תוכן התשובה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

AudioContent

בלוק של תוכן אודיו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "audio".

data string  (אופציונלי)

תוכן האודיו.

uri מחרוזת  (אופציונלי)

ה-URI של האודיו.

mime_type enum (string)  (optional)

סוג ה-MIME של האודיו.

ערכים אפשריים:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (אופציונלי)

מספר ערוצי האודיו.

sample_rate integer  (optional)

קצב הדגימה של האודיו.

DocumentContent

אבן בניין של תוכן במסמך.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "document".

data string  (אופציונלי)

תוכן המסמך.

uri מחרוזת  (אופציונלי)

ה-URI של המסמך.

mime_type enum (string)  (optional)

סוג ה-MIME של המסמך.

ערכים אפשריים:

  • application/pdf
VideoContent

בלוק של תוכן וידאו.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "video".

data string  (אופציונלי)

תוכן הסרטון.

uri מחרוזת  (אופציונלי)

ה-URI של הסרטון.

mime_type enum (string)  (optional)

סוג ה-MIME של הסרטון.

ערכים אפשריים:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

ThoughtStep

שלב חשיבה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "thought".

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

summary ThoughtSummaryContent  (אופציונלי)

סיכום של המחשבה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

FunctionCallStep

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

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "function_call".

name string  (required)

חובה. השם של הכלי שאליו מתקשרים.

ארגומנטים object  (חובה)

חובה. הארגומנטים להעברה לפונקציה.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

CodeExecutionCallStep

שלב של קריאה להרצת קוד.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "code_execution_call".

arguments CodeExecutionCallStepArguments  (required)

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

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

שדות

language enum (string)  (optional)

שפת התכנות של ה-`code`.

ערכים אפשריים:

  • python
code string  (אופציונלי)

הקוד שיופעל.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

UrlContextCallStep

שלב של שיחה בהקשר של כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_context_call".

arguments UrlContextCallStepArguments  (required)

חובה. הארגומנטים להעברה להקשר של כתובת ה-URL.

הארגומנטים להעברה להקשר של כתובת ה-URL.

שדות

‫urls array (string)  (optional)

כתובות ה-URL לאחזור.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

McpServerToolCallStep

שלב הקריאה לכלי MCPServer.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "mcp_server_tool_call".

name string  (required)

חובה. השם של הכלי שהופעל.

server_name string  (required)

חובה. השם של שרת ה-MCP שנעשה בו שימוש.

ארגומנטים object  (חובה)

חובה. אובייקט JSON של הארגומנטים של הפונקציה.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleSearchCallStep

שלב השיחה בחיפוש Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_search_call".

arguments GoogleSearchCallStepArguments  (required)

חובה. הארגומנטים להעברה לחיפוש Google.

הארגומנטים להעברה לחיפוש Google.

שדות

‫queries array (string)  (optional)

שאילתות לחיפוש באינטרנט לצורך המשך החיפוש באינטרנט.

search_type enum (string)  (optional)

סוג ההארקה של החיפוש שמופעל.

ערכים אפשריים:

  • web_search
  • image_search
  • enterprise_web_search
id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

FileSearchCallStep

שלב של שיחה לחיפוש קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_search_call".

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleMapsCallStep

שלב השיחה במפות Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_maps_call".

arguments GoogleMapsCallStepArguments  (optional)

הארגומנטים להעברה לכלי של מפות Google.

הארגומנטים להעברה לכלי של מפות Google.

שדות

‫queries array (string)  (optional)

השאילתות שיופעלו.

id string  (חובה)

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

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

FunctionResultStep

התוצאה של קריאה לכלי פונקציה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "function_result".

name string  (אופציונלי)

שם הכלי שהופעל.

is_error boolean  (optional)

האם קריאת הפונקציה הסתיימה בשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

result array (FunctionResultSubcontent) or string  (required)

התוצאה של קריאת הכלי.

CodeExecutionResultStep

שלב התוצאה של הרצת הקוד.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "code_execution_result".

result string  (required)

חובה. הפלט של הרצת הקוד.

is_error boolean  (optional)

האם הרצת הקוד הסתיימה בשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

UrlContextResultStep

שלב התוצאה של ההקשר של כתובת ה-URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_context_result".

result UrlContextResultItem  (required)

חובה. התוצאות של ההקשר של כתובת ה-URL.

התוצאה של ההקשר של כתובת ה-URL.

שדות

‫url string  (optional)

כתובת ה-URL שאוחזרה.

status enum (string)  (optional)

הסטטוס של אחזור כתובת ה-URL.

ערכים אפשריים:

  • success
  • error
  • paywall
  • unsafe
is_error boolean  (optional)

האם ההקשר של כתובת ה-URL הוביל לשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleSearchResultStep

שלב של תוצאת חיפוש ב-Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_search_result".

result GoogleSearchResultItem  (חובה)

חובה. תוצאות מחיפוש Google.

התוצאה של חיפוש Google.

שדות

search_suggestions string  (optional)

קטע קוד של תוכן אינטרנט שאפשר להטמיע בדף אינטרנט או בתצוגת אינטרנט של אפליקציה.

is_error boolean  (optional)

האם החיפוש ב-Google הסתיים בשגיאה.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

McpServerToolResultStep

שלב התוצאה של כלי MCPServer.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "mcp_server_tool_result".

name string  (אופציונלי)

השם של הכלי שמופעל עבור קריאה ספציפית לכלי.

server_name string  (optional)

השם של שרת ה-MCP שנעשה בו שימוש.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

result array (FunctionResultSubcontent) or string  (required)

הפלט מהשיחה עם שרת ה-MCP. יכול להיות טקסט פשוט או תוכן עשיר.

FileSearchResultStep

שלב של תוצאת חיפוש קבצים.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_search_result".

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

GoogleMapsResultStep

שלב התוצאה במפות Google.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "google_maps_result".

result GoogleMapsResultItem  (חובה)

לא סופק תיאור.

התוצאה של מפות Google.

שדות

מקומות GoogleMapsResultPlaces  (אופציונלי)

לא סופק תיאור.

שדות

place_id string  (optional)

לא סופק תיאור.

name string  (אופציונלי)

לא סופק תיאור.

‫url string  (optional)

לא סופק תיאור.

review_snippets ReviewSnippet  (אופציונלי)

לא סופק תיאור.

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

widget_context_token string  (optional)

לא סופק תיאור.

call_id string  (required)

חובה. מזהה שצריך להיות זהה למזהה מבלוק בקשה להפעלת פונקציה.

signature string  (אופציונלי)

גיבוב חתימה לאימות בקצה העורפי.

event_id string  (optional)

טוקן event_id שישמש להמשך זרם האינטראקציות, מהאירוע הזה.

StepDelta

event_type object  (required)

לא סופק תיאור.

הערך תמיד יהיה "step.delta".

index integer  (required)

לא סופק תיאור.

delta StepDeltaData  (required)

לא סופק תיאור.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextDelta

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

לא סופק תיאור.

ImageDelta

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

לא סופק תיאור.

uri מחרוזת  (אופציונלי)

לא סופק תיאור.

mime_type enum (string)  (optional)

לא סופק תיאור.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

AudioDelta

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "audio".

data string  (אופציונלי)

לא סופק תיאור.

uri מחרוזת  (אופציונלי)

לא סופק תיאור.

mime_type enum (string)  (optional)

לא סופק תיאור.

ערכים אפשריים:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
rate integer  (אופציונלי)

הוצא משימוש. במקום זאת, צריך להשתמש ב-sample_rate. המערכת מתעלמת מהערך.

sample_rate integer  (optional)

קצב הדגימה של האודיו.

channels integer  (אופציונלי)

מספר ערוצי האודיו.

DocumentDelta

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "document".

data string  (אופציונלי)

לא סופק תיאור.

uri מחרוזת  (אופציונלי)

לא סופק תיאור.

mime_type enum (string)  (optional)

לא סופק תיאור.

ערכים אפשריים:

  • application/pdf
VideoDelta

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "video".

data string  (אופציונלי)

לא סופק תיאור.

uri מחרוזת  (אופציונלי)

לא סופק תיאור.

mime_type enum (string)  (optional)

לא סופק תיאור.

ערכים אפשריים:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

ThoughtSummaryDelta

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "thought_summary".

content ThoughtSummaryContent  (אופציונלי)

פריט סיכום חדש שיוסף למחשבה.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

TextContent

בלוק של תוכן טקסט.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text".

text string  (חובה)

חובה. תוכן הטקסט.

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ImageContent

בלוק תוכן של תמונה.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "image".

data string  (אופציונלי)

תוכן התמונה.

uri מחרוזת  (אופציונלי)

ה-URI של התמונה.

mime_type enum (string)  (optional)

סוג ה-MIME של התמונה.

ערכים אפשריים:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (אופציונלי)

הרזולוציה של המדיה.

ערכים אפשריים:

  • low
  • medium
  • high
  • ultra_high

ThoughtSignatureDelta

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "thought_signature".

signature string  (אופציונלי)

חתימה שתתאים למקור ה-Backend שיהיה חלק מהיצירה.

TextAnnotationDelta

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "text_annotation_delta".

annotations Annotation  (אופציונלי)

מידע על ציטוט של תוכן שנוצר על ידי מודל.

מידע על ציטוט של תוכן שנוצר על ידי מודל.

סוגים אפשריים

ערך הדיסקרימינטור הפולימורפי: type

UrlCitation

הערה של ציטוט כתובת URL.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "url_citation".

‫url string  (optional)

כתובת ה-URL.

title string  (אופציונלי)

הכותרת של כתובת ה-URL.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

FileCitation

הערה לציטוט קובץ.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "file_citation".

document_uri string  (אופציונלי)

ה-URI של הקובץ.

file_name string  (optional)

שם הקובץ.

source string  (אופציונלי)

המקור שמשויך לחלק מהטקסט.

custom_metadata object  (optional)

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

page_number integer  (optional)

מספר הדף במסמך המצוטט, אם רלוונטי.

media_id string  (optional)

מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

PlaceCitation

הערה של ציטוט מקום.

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "place_citation".

place_id string  (optional)

המזהה של המקום, בפורמט ‎ `places/{place_id}` ‎.

name string  (אופציונלי)

שם המקום.

‫url string  (optional)

הפניה ל-URI של המקום.

review_snippets ReviewSnippet  (אופציונלי)

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

תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.

שדות

title string  (אופציונלי)

כותרת הביקורת.

‫url string  (optional)

קישור שמתאים לביקורת של המשתמש במפות Google.

review_id string  (optional)

המזהה של קטע הביקורת.

start_index integer  (optional)

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

end_index integer  (optional)

סוף הקטע המשויך, לא כולל.

ArgumentsDelta

type object  (חובה)

לא סופק תיאור.

הערך תמיד יהיה "arguments_delta".

partial_arguments string  (optional)

לא סופק תיאור.

event_id string  (optional)

טוקן event_id שישמש להמשך זרם האינטראקציות, מהאירוע הזה.

StepStop

event_type object  (required)

לא סופק תיאור.

הערך תמיד יהיה "step.stop".

index integer  (required)

לא סופק תיאור.

event_id string  (optional)

טוקן event_id שישמש להמשך זרם האינטראקציות, מהאירוע הזה.

דוגמאות

נוצרה אינטראקציה

{
  "event_type": "interaction.created",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "status": "in_progress",
    "created": "2025-12-04T15:01:45Z",
    "updated": "2025-12-04T15:01:45Z"
  },
  "event_id": "evt_123"
}

האינטראקציה הסתיימה

{
  "event_type": "interaction.completed",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "status": "completed",
    "created": "2025-12-04T15:01:45Z",
    "updated": "2025-12-04T15:01:45Z"
  },
  "event_id": "evt_123"
}

עדכון סטטוס האינטראקציה

{
  "event_type": "interaction.status_update",
  "interaction_id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM",
  "status": "in_progress"
}

אירוע שגיאה

{
  "event_type": "error",
  "error": {
    "message": "Failed to get completed interaction: Result not found.",
    "code": "not_found"
  }
}

התחלת השלב

{
  "event_type": "step.start",
  "index": 0,
  "step": {
    "type": "model_output"
  }
}

דלתא של שלבים

{
  "event_type": "step.delta",
  "index": 0,
  "delta": {
    "type": "text",
    "text": "Hello"
  }
}

מעצור מדרגה

{
  "event_type": "step.stop",
  "index": 0
}