رابط برنامهنویسی کاربردی Gemini Interactions یک رابط برنامهنویسی کاربردی آزمایشی است که به توسعهدهندگان اجازه میدهد تا با استفاده از مدلهای Gemini، برنامههای هوش مصنوعی مولد بسازند. Gemini توانمندترین مدل ما است که از پایه برای چندوجهی بودن ساخته شده است. این مدل میتواند انواع مختلف اطلاعات از جمله زبان، تصاویر، صدا، ویدئو و کد را تعمیم داده و به طور یکپارچه درک کند، در میان آنها عمل کند و ترکیب کند. میتوانید از API Gemini برای موارد استفاده مانند استدلال در متن و تصاویر، تولید محتوا، عاملهای گفتگو، سیستمهای خلاصهسازی و طبقهبندی و موارد دیگر استفاده کنید.
ایجاد وبهوک
یک وبهوک جدید ایجاد میکند.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
اختیاری. نام وبهوک که توسط کاربر ارائه شده است.
الزامی. آدرس اینترنتی (URI) که رویدادهای وبهوک به آن ارسال میشوند.
رویدادهایی که وبهوک در آنها مشترک میشود. رویدادهای موجود: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
پاسخ
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
اختیاری. نام وبهوک که توسط کاربر ارائه شده است.
الزامی. آدرس اینترنتی (URI) که رویدادهای وبهوک به آن ارسال میشوند.
رویدادهایی که وبهوک در آنها مشترک میشود. رویدادهای موجود: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
فقط خروجی. مهر زمانی که وبهوک ایجاد شده است.
فقط خروجی. نشانگر زمانی آخرین بهروزرسانی وبهوک.
signing_secrets رمز امضای (اختیاری)
فقط خروجی. اسرار امضای مرتبط با این وبهوک.
فیلدها
فقط خروجی. نسخه کوتاهشدهی رمز امضا.
فقط خروجی. تاریخ انقضای رمز امضا.
فقط خروجی. وضعیت وبهوک.
مقادیر ممکن:
-
enabled -
disabled -
disabled_due_to_failed_deliveries
فقط خروجی. رمز امضای جدید برای وبهوک. فقط در هنگام ایجاد، مقداردهی میشود.
فقط خروجی. شناسه وب هوک.
مثال
پاسخ نمونه
{ "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` دریافت شده است. این را برای بازیابی صفحه بعدی ارائه دهید.
پاسخ
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
وب هوک ها.
یک توکن، که میتواند به عنوان `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
یک وبهوک خاص دریافت میکند.
پارامترهای مسیر/پرسوجو
الزامی. شناسهی وبهوک مورد نظر برای بازیابی.
پاسخ
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
اختیاری. نام وبهوک که توسط کاربر ارائه شده است.
الزامی. آدرس اینترنتی (URI) که رویدادهای وبهوک به آن ارسال میشوند.
رویدادهایی که وبهوک در آنها مشترک میشود. رویدادهای موجود: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
فقط خروجی. مهر زمانی که وبهوک ایجاد شده است.
فقط خروجی. نشانگر زمانی آخرین بهروزرسانی وبهوک.
signing_secrets رمز امضای (اختیاری)
فقط خروجی. اسرار امضای مرتبط با این وبهوک.
فیلدها
فقط خروجی. نسخه کوتاهشدهی رمز امضا.
فقط خروجی. تاریخ انقضای رمز امضا.
فقط خروجی. وضعیت وبهوک.
مقادیر ممکن:
-
enabled -
disabled -
disabled_due_to_failed_deliveries
فقط خروجی. رمز امضای جدید برای وبهوک. فقط در هنگام ایجاد، مقداردهی میشود.
فقط خروجی. شناسه وب هوک.
مثال
پاسخ نمونه
{ "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" }
بهروزرسانی وبهوک
یک وبهوک موجود را بهروزرسانی میکند.
پارامترهای مسیر/پرسوجو
الزامی. شناسهی وبهوک مورد نظر برای بهروزرسانی.
اختیاری. لیست فیلدهایی که باید بهروزرسانی شوند.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
اختیاری. نام وبهوک که توسط کاربر ارائه شده است.
اختیاری. آدرس اینترنتی (URI) که رویدادهای وبهوک به آن ارسال میشوند.
اختیاری. رویدادهایی که وبهوک در آنها مشترک میشود. رویدادهای موجود: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
اختیاری. وضعیت وبهوک.
مقادیر ممکن:
-
enabled -
disabled -
disabled_due_to_failed_deliveries
پاسخ
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
اختیاری. نام وبهوک که توسط کاربر ارائه شده است.
الزامی. آدرس اینترنتی (URI) که رویدادهای وبهوک به آن ارسال میشوند.
رویدادهایی که وبهوک در آنها مشترک میشود. رویدادهای موجود: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
فقط خروجی. مهر زمانی که وبهوک ایجاد شده است.
فقط خروجی. نشانگر زمانی آخرین بهروزرسانی وبهوک.
signing_secrets رمز امضای (اختیاری)
فقط خروجی. اسرار امضای مرتبط با این وبهوک.
فیلدها
فقط خروجی. نسخه کوتاهشدهی رمز امضا.
فقط خروجی. تاریخ انقضای رمز امضا.
فقط خروجی. وضعیت وبهوک.
مقادیر ممکن:
-
enabled -
disabled -
disabled_due_to_failed_deliveries
فقط خروجی. رمز امضای جدید برای وبهوک. فقط در هنگام ایجاد، مقداردهی میشود.
فقط خروجی. شناسه وب هوک.
مثال
پاسخ نمونه
{ "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" }
حذف وبهوک
یک وبهوک را حذف میکند.
پارامترهای مسیر/پرسوجو
الزامی. شناسه وبهوک مورد نظر برای حذف. فرمت: `{webhook_id}`
پاسخ
در صورت موفقیت، پاسخ خالی است.
مثال
چرخش امضای مخفی
یک رمز امضای جدید برای یک وبهوک ایجاد میکند.
پارامترهای مسیر/پرسوجو
الزامی. شناسه وبهوک که برای آن یک رمز امضا ایجاد میشود. قالب: `{webhook_id}`
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
اختیاری. رفتار ابطال برای رمزهای امضای قبلی.
مقادیر ممکن:
-
revoke_previous_secrets_after_h24 -
revoke_previous_secrets_immediately
پاسخ
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
فقط خروجی. رمز امضای تازه تولید شده.
مثال
پاسخ نمونه
{ "secret": "string" }
پینگوبهوک
یک رویداد پینگ را به یک وبهوک ارسال میکند.
پارامترهای مسیر/پرسوجو
الزامی. شناسه وبهوک برای پینگ. فرمت: `{webhook_id}`
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
پاسخ
در صورت موفقیت، پاسخ خالی است.
مثال
منابع
وبهوک
یک منبع وبهوک.
فیلدها
اختیاری. نام وبهوک که توسط کاربر ارائه شده است.
الزامی. آدرس اینترنتی (URI) که رویدادهای وبهوک به آن ارسال میشوند.
رویدادهایی که وبهوک در آنها مشترک میشود. رویدادهای موجود: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
فقط خروجی. مهر زمانی که وبهوک ایجاد شده است.
فقط خروجی. نشانگر زمانی آخرین بهروزرسانی وبهوک.
signing_secrets رمز امضای (اختیاری)
فقط خروجی. اسرار امضای مرتبط با این وبهوک.
فیلدها
فقط خروجی. نسخه کوتاهشدهی رمز امضا.
فقط خروجی. تاریخ انقضای رمز امضا.
فقط خروجی. وضعیت وبهوک.
مقادیر ممکن:
-
enabled -
disabled -
disabled_due_to_failed_deliveries
فقط خروجی. رمز امضای جدید برای وبهوک. فقط در هنگام ایجاد، مقداردهی میشود.
فقط خروجی. شناسه وب هوک.
مدلهای داده
رویداد تعامل
انواع ممکن
تفکیککننده چندریختی: event_type
رویداد ایجاد شده توسط تعامل
هیچ توضیحی ارائه نشده است.
همیشه روی "interaction.created" تنظیم شود.
تعامل تعامل ( الزامی)
هیچ توضیحی ارائه نشده است.
فیلدها
مدل ModelOption (اختیاری)
نام «مدل» مورد استفاده برای تولید تعامل.
مقادیر ممکن:
-
gemini-2.5-computer-use-preview-10-2025یک مدل قابلیت عاملمحور که برای تعامل مستقیم رابط کاربری طراحی شده است و به Gemini اجازه میدهد محیطهای دیجیتال را درک و پیمایش کند.
-
gemini-2.5-flashاولین مدل استدلال ترکیبی ما که از یک پنجره زمینه ۱ میلیون توکنی پشتیبانی میکند و دارای بودجههای تفکر است.
-
gemini-2.5-flash-imageمدل تولید تصویر بومی ما، که برای سرعت، انعطافپذیری و درک متنی بهینه شده است. ورودی و خروجی متن با همان قیمت ۲.۵ فلش ارائه میشود.
-
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آخرین مدل مبتنی بر مدل فلش ۲.۵. پیشنمایش فلش ۲.۵ برای پردازش در مقیاس بزرگ، وظایف با تأخیر کم و حجم بالا که نیاز به تفکر دارند و موارد استفاده عاملمحور بهترین گزینه است.
-
gemini-2.5-flash-preview-ttsمدل تبدیل متن به گفتار ۲.۵ فلش ما برای تولید گفتار قابل کنترل قدرتمند و با تأخیر کم بهینه شده است.
-
gemini-2.5-proمدل چندمنظوره پیشرفته ما، که در کدنویسی و کارهای استدلالی پیچیده عالی عمل میکند.
-
gemini-2.5-pro-preview-ttsمدل صوتی متن به گفتار نسخه ۲.۵ پرو ما برای تولید گفتار قدرتمند و با تأخیر کم بهینه شده است تا خروجیهای طبیعیتر و هدایت آسانتر دستورات را فراهم کند.
-
gemini-3-flash-previewهوشمندترین مدل ما که برای سرعت ساخته شده است، هوش مرزی را با جستجو و ردیابی برتر ترکیب میکند.
-
gemini-3-pro-image-previewمدل پیشرفته تولید و ویرایش تصویر.
-
gemini-3-pro-previewهوشمندترین مدل ما با استدلال SOTA و درک چندوجهی، و قابلیتهای قدرتمند کدگذاری عاملی و ارتعاشی.
-
gemini-3.1-pro-previewجدیدترین مدل استدلال SOTA ما با عمق و ظرافت بیسابقه و قابلیتهای قدرتمند درک و کدنویسی چندوجهی.
-
gemini-3.1-flash-image-previewهوش بصری سطح حرفهای با کارایی فوقالعاده و قابلیتهای تولید مبتنی بر واقعیت.
-
gemini-3.1-flash-lite-previewمقرونبهصرفهترین مدل ما، بهینهشده برای وظایف عاملمحور با حجم بالا، ترجمه و پردازش دادههای ساده.
-
gemini-3.1-flash-tts-previewGemini 3.1 Flash TTS: تولید گفتار قدرتمند و با تأخیر کم. از خروجیهای طبیعی، دستورات قابل هدایت و برچسبهای صوتی رسا برای کنترل دقیق روایت لذت ببرید.
-
lyria-3-clip-previewمدل تولید موسیقی با تأخیر کم ما برای کلیپهای صوتی با کیفیت بالا و کنترل دقیق ریتمیک بهینه شده است.
-
lyria-3-pro-previewمدل پیشرفته و کامل ما برای تولید آهنگ با درک عمیق از آهنگسازی، بهینه شده برای کنترل ساختاری دقیق و انتقالهای پیچیده در سبکهای مختلف موسیقی.
گزینه عامل (اختیاری)
نام «عامل» مورد استفاده برای ایجاد تعامل.
مقادیر ممکن:
-
deep-research-pro-preview-12-2025نماینده تحقیقات عمیق جمینی
-
deep-research-preview-04-2026نماینده تحقیقات عمیق جمینی
-
deep-research-max-preview-04-2026مامور مکس تحقیقات عمیق جمینی
الزامی. فقط خروجی. یک شناسه منحصر به فرد برای تکمیل تعامل.
الزامی. فقط خروجی. وضعیت تعامل.
مقادیر ممکن:
-
in_progress -
requires_action -
completed -
failed -
cancelled -
incomplete
الزامی. فقط خروجی. زمانی که پاسخ در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) ایجاد شده است.
الزامی. فقط خروجی. زمانی که پاسخ آخرین بار در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) بهروزرسانی شده است.
فقط خروجی. نقش تعامل.
دستورالعمل سیستم برای تعامل.
ابزار ( اختیاری)
فهرستی از اعلانهای ابزار که مدل ممکن است در طول تعامل فراخوانی کند.
انواع ممکن
تفکیککننده چندریختی: type
عملکرد
ابزاری که میتواند توسط مدل مورد استفاده قرار گیرد.
هیچ توضیحی ارائه نشده است.
همیشه روی "function" تنظیم شود.
نام تابع.
شرحی از تابع.
طرحواره JSON برای پارامترهای تابع.
اجرای کد
ابزاری که میتواند توسط مدل برای اجرای کد استفاده شود.
هیچ توضیحی ارائه نشده است.
همیشه روی "code_execution" تنظیم شود.
متن آدرس
ابزاری که میتواند توسط مدل برای دریافت متن URL استفاده شود.
هیچ توضیحی ارائه نشده است.
همیشه روی "url_context" تنظیم شود.
استفاده از کامپیوتر
ابزاری که میتواند توسط مدل برای تعامل با کامپیوتر استفاده شود.
هیچ توضیحی ارائه نشده است.
همیشه روی "computer_use" تنظیم شود.
محیطی که در حال اجرا است.
مقادیر ممکن:
-
browser
فهرست توابع از پیش تعریف شدهای که از فراخوانی مدل مستثنی شدهاند.
مکپسرور
MCPServer سروری است که میتواند توسط مدل برای انجام اقدامات فراخوانی شود.
هیچ توضیحی ارائه نشده است.
همیشه روی "mcp_server" تنظیم شود.
نام سرور MCP.
آدرس کامل URL برای نقطه پایانی MCPServer. مثال: "https://api.example.com/mcp"
اختیاری: در صورت نیاز، فیلدهایی برای هدرهای احراز هویت، زمانهای انقضا و غیره.
ابزارهای مجاز (اختیاری)
ابزارهای مجاز.
فیلدها
حالت انتخاب ابزار (اختیاری)
حالت انتخاب ابزار.
مقادیر ممکن:
-
auto -
any -
none -
validated
نام ابزارهای مجاز
جستجوی گوگل
ابزاری که میتواند توسط مدل برای جستجو در گوگل استفاده شود.
هیچ توضیحی ارائه نشده است.
همیشه روی "google_search" تنظیم شود.
انواع زمینهسازی جستجو برای فعالسازی.
مقادیر ممکن:
-
web_search -
image_search -
enterprise_web_search
جستجوی فایل
ابزاری که میتواند توسط مدل برای جستجوی فایلها استفاده شود.
هیچ توضیحی ارائه نشده است.
همیشه روی "file_search" تنظیم شود.
جستجوی فایل، نامهای فروشگاه را برای جستجو ذخیره میکند.
تعداد تکههای بازیابی معنایی که باید بازیابی شوند.
فیلتر فراداده برای اعمال روی اسناد و تکههای بازیابی معنایی.
گوگل مپ
ابزاری که میتواند توسط مدل برای فراخوانی نقشههای گوگل استفاده شود.
هیچ توضیحی ارائه نشده است.
همیشه روی "google_maps" تنظیم شود.
اینکه آیا در نتیجه فراخوانی ابزار، توکن زمینه ویجت برگردانده شود یا خیر.
عرض جغرافیایی محل کاربر.
طول جغرافیایی موقعیت مکانی کاربر.
بازیابی
ابزاری که میتواند توسط مدل برای بازیابی فایلها استفاده شود.
هیچ توضیحی ارائه نشده است.
همیشه روی "retrieval" تنظیم شود.
انواع بازیابی فایل برای فعال کردن.
مقادیر ممکن:
-
vertex_ai_search
vertex_ai_search_config پیکربندی VertexAISearchConfig (اختیاری)
برای تعیین پیکربندی VertexAISearch استفاده میشود.
فیلدها
اختیاری. برای مشخص کردن موتور جستجوی Vertex AI استفاده میشود.
اختیاری. برای مشخص کردن محلهای ذخیرهسازی دادهی Vertex AI Search استفاده میشود.
کاربرد (اختیاری )
فقط خروجی. آمار مربوط به میزان استفاده از توکن درخواست تعامل.
فیلدها
تعداد توکنها در اعلان (زمینه).
ورودی_توکنها_براساس_مودالیتی توکنهای مودالیتی (اختیاری)
تفکیک استفاده از توکن ورودی بر اساس روش.
فیلدها
روش پاسخ (اختیاری)
روش مرتبط با شمارش توکنها.
مقادیر ممکن:
-
text -
image -
audio -
video -
document
تعداد توکنها برای روش.
تعداد توکنها در بخش ذخیرهشدهی اعلان (محتوای ذخیرهشده).
cached_tokens_by_modality توکنهای مودالیتی (اختیاری)
تفکیک میزان استفاده از توکنهای ذخیرهشده بر اساس روش.
فیلدها
روش پاسخ (اختیاری)
روش مرتبط با شمارش توکنها.
مقادیر ممکن:
-
text -
image -
audio -
video -
document
تعداد توکنها برای روش.
تعداد کل توکنها در تمام پاسخهای تولید شده.
خروجی_توکنها_براساس_مودالیتی توکنهای مودالیتی (اختیاری)
تفکیک استفاده از توکن خروجی بر اساس روش.
فیلدها
روش پاسخ (اختیاری)
روش مرتبط با شمارش توکنها.
مقادیر ممکن:
-
text -
image -
audio -
video -
document
تعداد توکنها برای روش.
تعداد توکنهای موجود در اعلان(های) استفاده از ابزار.
ابزار_استفاده_از_توکنها_توسط_مودالیتی توکنهای مودالیتی (اختیاری)
تفکیک میزان استفاده از توکنهای ابزار بر اساس روش.
فیلدها
روش پاسخ (اختیاری)
روش مرتبط با شمارش توکنها.
مقادیر ممکن:
-
text -
image -
audio -
video -
document
تعداد توکنها برای روش.
تعداد توکنهای افکار برای مدلهای تفکر.
تعداد کل توکنها برای درخواست تعامل (درخواست + پاسخها + سایر توکنهای داخلی).
grounding_tool_count تعداد ابزار زمینی (اختیاری)
تعداد ابزار اتصال به زمین
فیلدها
نوع ابزار اتصال زمین مرتبط با شمارش.
مقادیر ممکن:
-
google_search -
google_maps -
retrieval
تعداد ابزار اتصال به زمین مهم است.
روش_پاسخ ( اختیاری )
روشهای درخواستی برای پاسخ (متن، تصویر، صدا).
مقادیر ممکن:
-
text -
image -
audio -
video -
document
نوع MIME پاسخ. در صورت تنظیم response_format، این مورد الزامی است.
شناسهی تعامل قبلی، در صورت وجود.
service_tier لایه سرویس (اختیاری)
لایه سرویس برای تعامل.
مقادیر ممکن:
-
flex -
standard -
priority
webhook_config پیکربندی وب هوک (اختیاری)
اختیاری. پیکربندی وبهوک برای دریافت اعلانها پس از اتمام تعامل.
فیلدها
اختیاری. در صورت تنظیم، این URLهای وبهوک به جای وبهوکهای ثبتشده، برای رویدادهای وبهوک استفاده خواهند شد.
اختیاری. فراداده کاربر که در هر انتشار رویداد به وبهوکها بازگردانده میشود.
مراحل ( اختیاری )
فقط خروجی. مراحلی که تعامل را تشکیل میدهند.
انواع ممکن
تفکیککننده چندریختی: type
مرحله ورودی کاربر
ورودی ارائه شده توسط کاربر.
هیچ توضیحی ارائه نشده است.
همیشه روی "user_input" تنظیم شود.
محتوا ( اختیاری)
هیچ توضیحی ارائه نشده است.
انواع ممکن
تفکیککننده چندریختی: type
محتوای متن
یک بلوک محتوای متنی.
هیچ توضیحی ارائه نشده است.
همیشه روی "text" تنظیم شود.
محتوای متن الزامی است.
حاشیهنویسیها ( اختیاری )
اطلاعات استناد برای محتوای تولید شده توسط مدل.
انواع ممکن
تفکیککننده چندریختی: type
استناد به آدرس اینترنتی
حاشیهنویسی استناد URL.
هیچ توضیحی ارائه نشده است.
همیشه روی "url_citation" تنظیم شود.
آدرس اینترنتی (URL).
عنوان URL.
شروع بخش پاسخی که به این منبع نسبت داده میشود. اندیس، شروع بخش را نشان میدهد که بر حسب بایت اندازهگیری میشود.
پایان بخش منسوب، منحصر به فرد.
استناد به فایل
حاشیهنویسی استناد به فایل.
هیچ توضیحی ارائه نشده است.
همیشه روی "file_citation" تنظیم شود.
آدرس اینترنتی (URI) فایل.
نام فایل.
منبع برای بخشی از متن ذکر شده است.
فرادادههای ارائه شده توسط کاربر در مورد متن بازیابی شده.
شماره صفحه سند ذکر شده، در صورت وجود.
شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.
شروع بخش پاسخی که به این منبع نسبت داده میشود. اندیس، شروع بخش را نشان میدهد که بر حسب بایت اندازهگیری میشود.
پایان بخش منسوب، منحصر به فرد.
استناد به مکان
حاشیهنویسی برای استناد به مکان.
هیچ توضیحی ارائه نشده است.
همیشه روی "place_citation" تنظیم شود.
شناسه مکان، با فرمت `places/{place_id}`.
عنوان مکان.
مرجع URI آن مکان.
review_snippets قطعه کد نقد و بررسی (اختیاری)
گزیدههایی از نظرات که برای تولید پاسخ در مورد ویژگیهای یک مکان مشخص در نقشههای گوگل استفاده میشوند.
فیلدها
عنوان نقد.
لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.
شناسهی قطعه نقد و بررسی.
شروع بخش پاسخی که به این منبع نسبت داده میشود. اندیس، شروع بخش را نشان میدهد که بر حسب بایت اندازهگیری میشود.
پایان بخش منسوب، منحصر به فرد.
محتوای تصویر
یک بلوک محتوای تصویر.
هیچ توضیحی ارائه نشده است.
همیشه روی "image" تنظیم شود.
محتوای تصویر.
آدرس اینترنتی (URI) تصویر.
نوع مایم تصویر.
مقادیر ممکن:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
وضوح تصویر MediaResolution (اختیاری)
قطعنامه رسانهها.
مقادیر ممکن:
-
low -
medium -
high -
ultra_high
محتوای صوتی
یک بلوک محتوای صوتی.
هیچ توضیحی ارائه نشده است.
همیشه روی "audio" تنظیم شود.
محتوای صوتی.
آدرس اینترنتی (URI) فایل صوتی.
نوع مایم صدا.
مقادیر ممکن:
-
audio/wav -
audio/mp3 -
audio/aiff -
audio/aac -
audio/ogg -
audio/flac -
audio/mpeg -
audio/m4a -
audio/l16 -
audio/opus -
audio/alaw -
audio/mulaw
تعداد کانالهای صوتی
نرخ نمونهبرداری صدا.
محتوای سند
یک بلوک محتوای سند.
هیچ توضیحی ارائه نشده است.
همیشه روی "document" تنظیم شود.
محتوای سند.
آدرس اینترنتی (URI) سند.
نوع MIME سند.
مقادیر ممکن:
-
application/pdf
محتوای ویدیویی
یک بلوک محتوای ویدیویی.
هیچ توضیحی ارائه نشده است.
همیشه روی "video" تنظیم شود.
محتوای ویدیویی.
آدرس اینترنتی (URI) ویدیو.
نوع میم (شبیهسازی) ویدیو.
مقادیر ممکن:
-
video/mp4 -
video/mpeg -
video/mpg -
video/mov -
video/avi -
video/x-flv -
video/webm -
video/wmv -
video/3gpp
وضوح تصویر MediaResolution (اختیاری)
قطعنامه رسانهها.
مقادیر ممکن:
-
low -
medium -
high -
ultra_high
مرحله خروجی مدل
خروجی تولید شده توسط مدل.
هیچ توضیحی ارائه نشده است.
همیشه روی "model_output" تنظیم شود.
محتوا ( اختیاری)
هیچ توضیحی ارائه نشده است.
انواع ممکن
تفکیککننده چندریختی: type
محتوای متن
یک بلوک محتوای متنی.
هیچ توضیحی ارائه نشده است.
همیشه روی "text" تنظیم شود.
محتوای متن الزامی است.
حاشیهنویسیها ( اختیاری )
اطلاعات استناد برای محتوای تولید شده توسط مدل.
انواع ممکن
تفکیککننده چندریختی: type
استناد به آدرس اینترنتی
حاشیهنویسی استناد URL.
هیچ توضیحی ارائه نشده است.
همیشه روی "url_citation" تنظیم شود.
آدرس اینترنتی (URL).
عنوان URL.
شروع بخش پاسخی که به این منبع نسبت داده میشود. اندیس، شروع بخش را نشان میدهد که بر حسب بایت اندازهگیری میشود.
پایان بخش منسوب، منحصر به فرد.
استناد به فایل
حاشیهنویسی استناد به فایل.
هیچ توضیحی ارائه نشده است.
همیشه روی "file_citation" تنظیم شود.
آدرس اینترنتی (URI) فایل.
نام فایل.
منبع برای بخشی از متن ذکر شده است.
فرادادههای ارائه شده توسط کاربر در مورد متن بازیابی شده.
شماره صفحه سند ذکر شده، در صورت وجود.
شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.
شروع بخش پاسخی که به این منبع نسبت داده میشود. اندیس، شروع بخش را نشان میدهد که بر حسب بایت اندازهگیری میشود.
پایان بخش منسوب، منحصر به فرد.
استناد به مکان
حاشیهنویسی برای استناد به مکان.
هیچ توضیحی ارائه نشده است.
همیشه روی "place_citation" تنظیم شود.
شناسه مکان، با فرمت `places/{place_id}`.
عنوان مکان.
مرجع URI آن مکان.
review_snippets قطعه کد نقد و بررسی (اختیاری)
گزیدههایی از نظرات که برای تولید پاسخ در مورد ویژگیهای یک مکان مشخص در نقشههای گوگل استفاده میشوند.
فیلدها
عنوان نقد.
لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.
شناسهی قطعه نقد و بررسی.
شروع بخش پاسخی که به این منبع نسبت داده میشود. اندیس، شروع بخش را نشان میدهد که بر حسب بایت اندازهگیری میشود.
پایان بخش منسوب، منحصر به فرد.
محتوای تصویر
یک بلوک محتوای تصویر.
هیچ توضیحی ارائه نشده است.
همیشه روی "image" تنظیم شود.
محتوای تصویر.
آدرس اینترنتی (URI) تصویر.
نوع مایم تصویر.
مقادیر ممکن:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
وضوح تصویر MediaResolution (اختیاری)
قطعنامه رسانهها.
مقادیر ممکن:
-
low -
medium -
high -
ultra_high
محتوای صوتی
یک بلوک محتوای صوتی.
هیچ توضیحی ارائه نشده است.
همیشه روی "audio" تنظیم شود.
محتوای صوتی.
آدرس اینترنتی (URI) فایل صوتی.
نوع مایم صدا.
مقادیر ممکن:
-
audio/wav -
audio/mp3 -
audio/aiff -
audio/aac -
audio/ogg -
audio/flac -
audio/mpeg -
audio/m4a -
audio/l16 -
audio/opus -
audio/alaw -
audio/mulaw
تعداد کانالهای صوتی
نرخ نمونهبرداری صدا.
محتوای سند
یک بلوک محتوای سند.
هیچ توضیحی ارائه نشده است.
همیشه روی "document" تنظیم شود.
محتوای سند.
آدرس اینترنتی (URI) سند.
نوع MIME سند.
مقادیر ممکن:
-
application/pdf
محتوای ویدیویی
یک بلوک محتوای ویدیویی.
هیچ توضیحی ارائه نشده است.
همیشه روی "video" تنظیم شود.
محتوای ویدیویی.
آدرس اینترنتی (URI) ویدیو.
نوع میم (شبیهسازی) ویدیو.
مقادیر ممکن:
-
video/mp4 -
video/mpeg -
video/mpg -
video/mov -
video/avi -
video/x-flv -
video/webm -
video/wmv -
video/3gpp
وضوح تصویر MediaResolution (اختیاری)
قطعنامه رسانهها.
مقادیر ممکن:
-
low -
medium -
high -
ultra_high
اندیشه گام
یک گام فکری.
هیچ توضیحی ارائه نشده است.
همیشه روی "thought" تنظیم شود.
یک هش امضا برای اعتبارسنجی backend.
خلاصه محتوای خلاصه اندیشه (اختیاری)
خلاصهای از اندیشه.
انواع ممکن
تفکیککننده چندریختی: type
محتوای متن
یک بلوک محتوای متنی.
هیچ توضیحی ارائه نشده است.
همیشه روی "text" تنظیم شود.
محتوای متن الزامی است.
حاشیهنویسیها ( اختیاری )
اطلاعات استناد برای محتوای تولید شده توسط مدل.
انواع ممکن
تفکیککننده چندریختی: type
استناد به آدرس اینترنتی
حاشیهنویسی استناد URL.
هیچ توضیحی ارائه نشده است.
همیشه روی "url_citation" تنظیم شود.
آدرس اینترنتی (URL).
عنوان URL.
شروع بخش پاسخی که به این منبع نسبت داده میشود. اندیس، شروع بخش را نشان میدهد که بر حسب بایت اندازهگیری میشود.
پایان بخش منسوب، منحصر به فرد.
استناد به فایل
حاشیهنویسی استناد به فایل.
هیچ توضیحی ارائه نشده است.
همیشه روی "file_citation" تنظیم شود.
آدرس اینترنتی (URI) فایل.
نام فایل.
منبع برای بخشی از متن ذکر شده است.
فرادادههای ارائه شده توسط کاربر در مورد متن بازیابی شده.
شماره صفحه سند ذکر شده، در صورت وجود.
شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.
شروع بخش پاسخی که به این منبع نسبت داده میشود. اندیس، شروع بخش را نشان میدهد که بر حسب بایت اندازهگیری میشود.
پایان بخش منسوب، منحصر به فرد.
استناد به مکان
حاشیهنویسی برای استناد به مکان.
هیچ توضیحی ارائه نشده است.
همیشه روی "place_citation" تنظیم شود.
شناسه مکان، با فرمت `places/{place_id}`.
عنوان مکان.
مرجع URI آن مکان.
review_snippets قطعه کد نقد و بررسی (اختیاری)
گزیدههایی از نظرات که برای تولید پاسخ در مورد ویژگیهای یک مکان مشخص در نقشههای گوگل استفاده میشوند.
فیلدها
عنوان نقد.
لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.
شناسهی قطعه نقد و بررسی.
شروع بخش پاسخی که به این منبع نسبت داده میشود. اندیس، شروع بخش را نشان میدهد که بر حسب بایت اندازهگیری میشود.
پایان بخش منسوب، منحصر به فرد.
محتوای تصویر
یک بلوک محتوای تصویر.
هیچ توضیحی ارائه نشده است.
همیشه روی "image" تنظیم شود.
محتوای تصویر.
آدرس اینترنتی (URI) تصویر.
نوع مایم تصویر.
مقادیر ممکن:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
وضوح تصویر MediaResolution (اختیاری)
قطعنامه رسانهها.
مقادیر ممکن:
-
low -
medium -
high -
ultra_high
مرحله فراخوانی تابع
مرحله فراخوانی ابزار تابع.
هیچ توضیحی ارائه نشده است.
همیشه روی "function_call" تنظیم شود.
الزامی. نام ابزاری که باید فراخوانی شود.
آرگومانهایی که باید به تابع ارسال شوند.
الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.
یک هش امضا برای اعتبارسنجی backend.
مرحله فراخوانی کد (CodeExecutionCallStep)
مرحله فراخوانی اجرای کد.
هیچ توضیحی ارائه نشده است.
همیشه روی "code_execution_call" تنظیم شود.
آرگومانهای CodeExecutionCallStepArgumentها (الزامی)
الزامی. آرگومانهایی که برای اجرای کد ارسال میشوند.
فیلدها
زبان برنامهنویسی «کد».
مقادیر ممکن:
-
python
کدی که قرار است اجرا شود.
الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.
یک هش امضا برای اعتبارسنجی backend.
مرحله فراخوانی متن (UrlContextCallStep)
مرحله فراخوانی زمینه URL.
هیچ توضیحی ارائه نشده است.
همیشه روی "url_context_call" تنظیم شود.
آرگومانهای UrlContextCallStepArgument (الزامی)
آرگومانهایی که باید به متن URL ارسال شوند.
فیلدها
آدرسهای اینترنتی (URL) برای دریافت.
الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.
یک هش امضا برای اعتبارسنجی backend.
ابزار فراخوانی مکپسرور (McpServerToolCallStep)
مرحله فراخوانی ابزار MCPServer.
هیچ توضیحی ارائه نشده است.
همیشه روی "mcp_server_tool_call" تنظیم شود.
الزامی. نام ابزاری که فراخوانی شده است.
الزامی. نام سرور MCP مورد استفاده.
الزامی. شیء JSON آرگومانهای تابع.
الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.
یک هش امضا برای اعتبارسنجی backend.
جستجوی گوگل
مرحله تماس جستجوی گوگل.
هیچ توضیحی ارائه نشده است.
همیشه روی "google_search_call" تنظیم شود.
آرگومانهای GoogleSearchCallStepArguments (الزامی)
الزامی. آرگومانهایی که باید به جستجوی گوگل ارسال شوند.
فیلدها
عبارتهای جستجوی وب برای جستجوی وب بعدی.
The type of search grounding enabled.
Possible values:
-
web_search -
image_search -
enterprise_web_search
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
FileSearchCallStep
File Search call step.
هیچ توضیحی ارائه نشده است.
Always set to "file_search_call" .
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
GoogleMapsCallStep
Google Maps call step.
هیچ توضیحی ارائه نشده است.
Always set to "google_maps_call" .
arguments GoogleMapsCallStepArguments (optional)
The arguments to pass to the Google Maps tool.
فیلدها
The queries to be executed.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
FunctionResultStep
Result of a function tool call.
هیچ توضیحی ارائه نشده است.
Always set to "function_result" .
The name of the tool that was called.
Whether the tool call resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
The result of the tool call.
CodeExecutionResultStep
Code execution result step.
هیچ توضیحی ارائه نشده است.
Always set to "code_execution_result" .
Required. The output of the code execution.
Whether the code execution resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
UrlContextResultStep
URL context result step.
هیچ توضیحی ارائه نشده است.
Always set to "url_context_result" .
result UrlContextResultItem (required)
Required. The results of the URL context.
فیلدها
The URL that was fetched.
The status of the URL retrieval.
Possible values:
-
success -
error -
paywall -
unsafe
Whether the URL context resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
GoogleSearchResultStep
Google Search result step.
هیچ توضیحی ارائه نشده است.
Always set to "google_search_result" .
result GoogleSearchResultItem (required)
Required. The results of the Google Search.
فیلدها
Web content snippet that can be embedded in a web page or an app webview.
Whether the Google Search resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
McpServerToolResultStep
MCPServer tool result step.
هیچ توضیحی ارائه نشده است.
Always set to "mcp_server_tool_result" .
Name of the tool which is called for this specific tool call.
The name of the used MCP server.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
The output from the MCP server call. Can be simple text or rich content.
FileSearchResultStep
File Search result step.
هیچ توضیحی ارائه نشده است.
Always set to "file_search_result" .
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
GoogleMapsResultStep
Google Maps result step.
هیچ توضیحی ارائه نشده است.
Always set to "google_maps_result" .
result GoogleMapsResultItem (required)
هیچ توضیحی ارائه نشده است.
فیلدها
places GoogleMapsResultPlaces (optional)
هیچ توضیحی ارائه نشده است.
فیلدها
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
review_snippets ReviewSnippet (optional)
هیچ توضیحی ارائه نشده است.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
هیچ توضیحی ارائه نشده است.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
The input for the interaction.
Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
agent_config object (optional)
Configuration parameters for the agent interaction.
Possible Types
Polymorphic discriminator: type
DynamicAgentConfig
Configuration for dynamic agents.
هیچ توضیحی ارائه نشده است.
Always set to "dynamic" .
DeepResearchAgentConfig
Configuration for the Deep Research agent.
هیچ توضیحی ارائه نشده است.
Always set to "deep-research" .
thinking_summaries ThinkingSummaries (optional)
Whether to include thought summaries in the response.
Possible values:
-
auto -
none
Whether to include visualizations in the response.
Possible values:
-
off -
auto
Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.
The event_id token to be used to resume the interaction stream, from this event.
InteractionCompletedEvent
هیچ توضیحی ارائه نشده است.
Always set to "interaction.completed" .
interaction Interaction (required)
Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output.
فیلدها
model ModelOption (optional)
The name of the `Model` used for generating the interaction.
Possible values:
-
gemini-2.5-computer-use-preview-10-2025An agentic capability model designed for direct interface interaction, allowing Gemini to perceive and navigate digital environments.
-
gemini-2.5-flashOur first hybrid reasoning model which supports a 1M token context window and has thinking budgets.
-
gemini-2.5-flash-imageOur native image generation model, optimized for speed, flexibility, and contextual understanding. Text input and output is priced the same as 2.5 Flash.
-
gemini-2.5-flash-liteOur smallest and most cost effective model, built for at scale usage.
-
gemini-2.5-flash-lite-preview-09-2025The latest model based on Gemini 2.5 Flash lite optimized for cost-efficiency, high throughput and high quality.
-
gemini-2.5-flash-native-audio-preview-12-2025Our native audio models optimized for higher quality audio outputs with better pacing, voice naturalness, verbosity, and mood.
-
gemini-2.5-flash-preview-09-2025The latest model based on the 2.5 Flash model. 2.5 Flash Preview is best for large scale processing, low-latency, high volume tasks that require thinking, and agentic use cases.
-
gemini-2.5-flash-preview-ttsOur 2.5 Flash text-to-speech model optimized for powerful, low-latency controllable speech generation.
-
gemini-2.5-proOur state-of-the-art multipurpose model, which excels at coding and complex reasoning tasks.
-
gemini-2.5-pro-preview-ttsOur 2.5 Pro text-to-speech audio model optimized for powerful, low-latency speech generation for more natural outputs and easier to steer prompts.
-
gemini-3-flash-previewهوشمندترین مدل ما که برای سرعت ساخته شده است، هوش مرزی را با جستجو و ردیابی برتر ترکیب میکند.
-
gemini-3-pro-image-previewمدل پیشرفته تولید و ویرایش تصویر.
-
gemini-3-pro-previewOur most intelligent model with SOTA reasoning and multimodal understanding, and powerful agentic and vibe coding capabilities.
-
gemini-3.1-pro-previewOur latest SOTA reasoning model with unprecedented depth and nuance, and powerful multimodal understanding and coding capabilities.
-
gemini-3.1-flash-image-previewهوش بصری سطح حرفهای با کارایی فوقالعاده و قابلیتهای تولید مبتنی بر واقعیت.
-
gemini-3.1-flash-lite-previewمقرونبهصرفهترین مدل ما، بهینهشده برای وظایف عاملمحور با حجم بالا، ترجمه و پردازش دادههای ساده.
-
gemini-3.1-flash-tts-previewGemini 3.1 Flash TTS: تولید گفتار قدرتمند و با تأخیر کم. از خروجیهای طبیعی، دستورات قابل هدایت و برچسبهای صوتی رسا برای کنترل دقیق روایت لذت ببرید.
-
lyria-3-clip-previewمدل تولید موسیقی با تأخیر کم ما برای کلیپهای صوتی با کیفیت بالا و کنترل دقیق ریتمیک بهینه شده است.
-
lyria-3-pro-previewمدل پیشرفته و کامل ما برای تولید آهنگ با درک عمیق از آهنگسازی، بهینه شده برای کنترل ساختاری دقیق و انتقالهای پیچیده در سبکهای مختلف موسیقی.
agent AgentOption (optional)
The name of the `Agent` used for generating the interaction.
Possible values:
-
deep-research-pro-preview-12-2025نماینده تحقیقات عمیق جمینی
-
deep-research-preview-04-2026نماینده تحقیقات عمیق جمینی
-
deep-research-max-preview-04-2026Gemini Deep Research Max Agent
Required. Output only. A unique identifier for the interaction completion.
Required. Output only. The status of the interaction.
Possible values:
-
in_progress -
requires_action -
completed -
failed -
cancelled -
incomplete
Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
Output only. The role of the interaction.
System instruction for the interaction.
tools Tool (optional)
A list of tool declarations the model may call during interaction.
Possible Types
Polymorphic discriminator: type
عملکرد
A tool that can be used by the model.
هیچ توضیحی ارائه نشده است.
Always set to "function" .
The name of the function.
A description of the function.
The JSON Schema for the function's parameters.
CodeExecution
A tool that can be used by the model to execute code.
هیچ توضیحی ارائه نشده است.
Always set to "code_execution" .
UrlContext
A tool that can be used by the model to fetch URL context.
هیچ توضیحی ارائه نشده است.
Always set to "url_context" .
ComputerUse
A tool that can be used by the model to interact with the computer.
هیچ توضیحی ارائه نشده است.
Always set to "computer_use" .
The environment being operated.
Possible values:
-
browser
The list of predefined functions that are excluded from the model call.
McpServer
A MCPServer is a server that can be called by the model to perform actions.
هیچ توضیحی ارائه نشده است.
Always set to "mcp_server" .
The name of the MCPServer.
The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"
Optional: Fields for authentication headers, timeouts, etc., if needed.
allowed_tools AllowedTools (optional)
The allowed tools.
فیلدها
mode ToolChoiceType (optional)
The mode of the tool choice.
Possible values:
-
auto -
any -
none -
validated
The names of the allowed tools.
GoogleSearch
A tool that can be used by the model to search Google.
هیچ توضیحی ارائه نشده است.
Always set to "google_search" .
The types of search grounding to enable.
Possible values:
-
web_search -
image_search -
enterprise_web_search
FileSearch
A tool that can be used by the model to search files.
هیچ توضیحی ارائه نشده است.
Always set to "file_search" .
The file search store names to search.
The number of semantic retrieval chunks to retrieve.
Metadata filter to apply to the semantic retrieval documents and chunks.
گوگل مپ
A tool that can be used by the model to call Google Maps.
هیچ توضیحی ارائه نشده است.
Always set to "google_maps" .
Whether to return a widget context token in the tool call result of the response.
The latitude of the user's location.
The longitude of the user's location.
بازیابی
A tool that can be used by the model to retrieve files.
هیچ توضیحی ارائه نشده است.
Always set to "retrieval" .
The types of file retrieval to enable.
Possible values:
-
vertex_ai_search
vertex_ai_search_config VertexAISearchConfig (optional)
Used to specify configuration for VertexAISearch.
فیلدها
Optional. Used to specify Vertex AI Search engine.
Optional. Used to specify Vertex AI Search datastores.
usage Usage (optional)
Output only. Statistics on the interaction request's token usage.
فیلدها
Number of tokens in the prompt (context).
input_tokens_by_modality ModalityTokens (optional)
A breakdown of input token usage by modality.
فیلدها
modality ResponseModality (optional)
The modality associated with the token count.
Possible values:
-
text -
image -
audio -
video -
document
Number of tokens for the modality.
Number of tokens in the cached part of the prompt (the cached content).
cached_tokens_by_modality ModalityTokens (optional)
A breakdown of cached token usage by modality.
فیلدها
modality ResponseModality (optional)
The modality associated with the token count.
Possible values:
-
text -
image -
audio -
video -
document
Number of tokens for the modality.
Total number of tokens across all the generated responses.
output_tokens_by_modality ModalityTokens (optional)
A breakdown of output token usage by modality.
فیلدها
modality ResponseModality (optional)
The modality associated with the token count.
Possible values:
-
text -
image -
audio -
video -
document
Number of tokens for the modality.
Number of tokens present in tool-use prompt(s).
tool_use_tokens_by_modality ModalityTokens (optional)
A breakdown of tool-use token usage by modality.
فیلدها
modality ResponseModality (optional)
The modality associated with the token count.
Possible values:
-
text -
image -
audio -
video -
document
Number of tokens for the modality.
Number of tokens of thoughts for thinking models.
Total token count for the interaction request (prompt + responses + other internal tokens).
grounding_tool_count GroundingToolCount (optional)
Grounding tool count.
فیلدها
The grounding tool type associated with the count.
Possible values:
-
google_search -
google_maps -
retrieval
The number of grounding tool counts.
response_modalities ResponseModality (optional)
The requested modalities of the response (TEXT, IMAGE, AUDIO).
Possible values:
-
text -
image -
audio -
video -
document
The mime type of the response. This is required if response_format is set.
The ID of the previous interaction, if any.
service_tier ServiceTier (optional)
The service tier for the interaction.
Possible values:
-
flex -
standard -
priority
webhook_config WebhookConfig (optional)
Optional. Webhook configuration for receiving notifications when the interaction completes.
فیلدها
Optional. If set, these webhook URIs will be used for webhook events instead of the registered webhooks.
Optional. The user metadata that will be returned on each event emission to the webhooks.
steps Step (optional)
Output only. The steps that make up the interaction.
Possible Types
Polymorphic discriminator: type
UserInputStep
Input provided by the user.
هیچ توضیحی ارائه نشده است.
Always set to "user_input" .
content Content (optional)
هیچ توضیحی ارائه نشده است.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
هیچ توضیحی ارائه نشده است.
Always set to "text" .
Required. The text content.
annotations Annotation (optional)
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "url_citation" .
The URL.
The title of the URL.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
FileCitation
A file citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "file_citation" .
The URI of the file.
The name of the file.
Source attributed for a portion of the text.
User provided metadata about the retrieved context.
Page number of the cited document, if applicable.
Media ID in-case of image citations, if applicable.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
PlaceCitation
A place citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "place_citation" .
The ID of the place, in `places/{place_id}` format.
Title of the place.
URI reference of the place.
review_snippets ReviewSnippet (optional)
Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
ImageContent
An image content block.
هیچ توضیحی ارائه نشده است.
Always set to "image" .
The image content.
The URI of the image.
The mime type of the image.
Possible values:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
AudioContent
An audio content block.
هیچ توضیحی ارائه نشده است.
Always set to "audio" .
The audio content.
The URI of the audio.
The mime type of the audio.
Possible values:
-
audio/wav -
audio/mp3 -
audio/aiff -
audio/aac -
audio/ogg -
audio/flac -
audio/mpeg -
audio/m4a -
audio/l16 -
audio/opus -
audio/alaw -
audio/mulaw
The number of audio channels.
The sample rate of the audio.
DocumentContent
A document content block.
هیچ توضیحی ارائه نشده است.
Always set to "document" .
The document content.
The URI of the document.
The mime type of the document.
Possible values:
-
application/pdf
VideoContent
A video content block.
هیچ توضیحی ارائه نشده است.
Always set to "video" .
The video content.
The URI of the video.
The mime type of the video.
Possible values:
-
video/mp4 -
video/mpeg -
video/mpg -
video/mov -
video/avi -
video/x-flv -
video/webm -
video/wmv -
video/3gpp
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
ModelOutputStep
Output generated by the model.
هیچ توضیحی ارائه نشده است.
Always set to "model_output" .
content Content (optional)
هیچ توضیحی ارائه نشده است.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
هیچ توضیحی ارائه نشده است.
Always set to "text" .
Required. The text content.
annotations Annotation (optional)
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "url_citation" .
The URL.
The title of the URL.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
FileCitation
A file citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "file_citation" .
The URI of the file.
The name of the file.
Source attributed for a portion of the text.
User provided metadata about the retrieved context.
Page number of the cited document, if applicable.
Media ID in-case of image citations, if applicable.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
PlaceCitation
A place citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "place_citation" .
The ID of the place, in `places/{place_id}` format.
Title of the place.
URI reference of the place.
review_snippets ReviewSnippet (optional)
Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
ImageContent
An image content block.
هیچ توضیحی ارائه نشده است.
Always set to "image" .
The image content.
The URI of the image.
The mime type of the image.
Possible values:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
AudioContent
An audio content block.
هیچ توضیحی ارائه نشده است.
Always set to "audio" .
The audio content.
The URI of the audio.
The mime type of the audio.
Possible values:
-
audio/wav -
audio/mp3 -
audio/aiff -
audio/aac -
audio/ogg -
audio/flac -
audio/mpeg -
audio/m4a -
audio/l16 -
audio/opus -
audio/alaw -
audio/mulaw
The number of audio channels.
The sample rate of the audio.
DocumentContent
A document content block.
هیچ توضیحی ارائه نشده است.
Always set to "document" .
The document content.
The URI of the document.
The mime type of the document.
Possible values:
-
application/pdf
VideoContent
A video content block.
هیچ توضیحی ارائه نشده است.
Always set to "video" .
The video content.
The URI of the video.
The mime type of the video.
Possible values:
-
video/mp4 -
video/mpeg -
video/mpg -
video/mov -
video/avi -
video/x-flv -
video/webm -
video/wmv -
video/3gpp
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
ThoughtStep
A thought step.
هیچ توضیحی ارائه نشده است.
Always set to "thought" .
A signature hash for backend validation.
summary ThoughtSummaryContent (optional)
A summary of the thought.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
هیچ توضیحی ارائه نشده است.
Always set to "text" .
Required. The text content.
annotations Annotation (optional)
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "url_citation" .
The URL.
The title of the URL.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
FileCitation
A file citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "file_citation" .
The URI of the file.
The name of the file.
Source attributed for a portion of the text.
User provided metadata about the retrieved context.
Page number of the cited document, if applicable.
Media ID in-case of image citations, if applicable.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
PlaceCitation
A place citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "place_citation" .
The ID of the place, in `places/{place_id}` format.
Title of the place.
URI reference of the place.
review_snippets ReviewSnippet (optional)
Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
ImageContent
An image content block.
هیچ توضیحی ارائه نشده است.
Always set to "image" .
The image content.
The URI of the image.
The mime type of the image.
Possible values:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
FunctionCallStep
A function tool call step.
هیچ توضیحی ارائه نشده است.
Always set to "function_call" .
Required. The name of the tool to call.
Required. The arguments to pass to the function.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
CodeExecutionCallStep
Code execution call step.
هیچ توضیحی ارائه نشده است.
Always set to "code_execution_call" .
arguments CodeExecutionCallStepArguments (required)
Required. The arguments to pass to the code execution.
فیلدها
Programming language of the `code`.
Possible values:
-
python
The code to be executed.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
UrlContextCallStep
URL context call step.
هیچ توضیحی ارائه نشده است.
Always set to "url_context_call" .
arguments UrlContextCallStepArguments (required)
Required. The arguments to pass to the URL context.
فیلدها
The URLs to fetch.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
McpServerToolCallStep
MCPServer tool call step.
هیچ توضیحی ارائه نشده است.
Always set to "mcp_server_tool_call" .
Required. The name of the tool which was called.
Required. The name of the used MCP server.
Required. The JSON object of arguments for the function.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
GoogleSearchCallStep
Google Search call step.
هیچ توضیحی ارائه نشده است.
Always set to "google_search_call" .
arguments GoogleSearchCallStepArguments (required)
Required. The arguments to pass to Google Search.
فیلدها
Web search queries for the following-up web search.
The type of search grounding enabled.
Possible values:
-
web_search -
image_search -
enterprise_web_search
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
FileSearchCallStep
File Search call step.
هیچ توضیحی ارائه نشده است.
Always set to "file_search_call" .
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
GoogleMapsCallStep
Google Maps call step.
هیچ توضیحی ارائه نشده است.
Always set to "google_maps_call" .
arguments GoogleMapsCallStepArguments (optional)
The arguments to pass to the Google Maps tool.
فیلدها
The queries to be executed.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
FunctionResultStep
Result of a function tool call.
هیچ توضیحی ارائه نشده است.
Always set to "function_result" .
The name of the tool that was called.
Whether the tool call resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
The result of the tool call.
CodeExecutionResultStep
Code execution result step.
هیچ توضیحی ارائه نشده است.
Always set to "code_execution_result" .
Required. The output of the code execution.
Whether the code execution resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
UrlContextResultStep
URL context result step.
هیچ توضیحی ارائه نشده است.
Always set to "url_context_result" .
result UrlContextResultItem (required)
Required. The results of the URL context.
فیلدها
The URL that was fetched.
The status of the URL retrieval.
Possible values:
-
success -
error -
paywall -
unsafe
Whether the URL context resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
GoogleSearchResultStep
Google Search result step.
هیچ توضیحی ارائه نشده است.
Always set to "google_search_result" .
result GoogleSearchResultItem (required)
Required. The results of the Google Search.
فیلدها
Web content snippet that can be embedded in a web page or an app webview.
Whether the Google Search resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
McpServerToolResultStep
MCPServer tool result step.
هیچ توضیحی ارائه نشده است.
Always set to "mcp_server_tool_result" .
Name of the tool which is called for this specific tool call.
The name of the used MCP server.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
The output from the MCP server call. Can be simple text or rich content.
FileSearchResultStep
File Search result step.
هیچ توضیحی ارائه نشده است.
Always set to "file_search_result" .
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
GoogleMapsResultStep
Google Maps result step.
هیچ توضیحی ارائه نشده است.
Always set to "google_maps_result" .
result GoogleMapsResultItem (required)
هیچ توضیحی ارائه نشده است.
فیلدها
places GoogleMapsResultPlaces (optional)
هیچ توضیحی ارائه نشده است.
فیلدها
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
review_snippets ReviewSnippet (optional)
هیچ توضیحی ارائه نشده است.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
هیچ توضیحی ارائه نشده است.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
The input for the interaction.
Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
agent_config object (optional)
Configuration parameters for the agent interaction.
Possible Types
Polymorphic discriminator: type
DynamicAgentConfig
Configuration for dynamic agents.
هیچ توضیحی ارائه نشده است.
Always set to "dynamic" .
DeepResearchAgentConfig
Configuration for the Deep Research agent.
هیچ توضیحی ارائه نشده است.
Always set to "deep-research" .
thinking_summaries ThinkingSummaries (optional)
Whether to include thought summaries in the response.
Possible values:
-
auto -
none
Whether to include visualizations in the response.
Possible values:
-
off -
auto
Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.
The event_id token to be used to resume the interaction stream, from this event.
InteractionStatusUpdate
هیچ توضیحی ارائه نشده است.
Always set to "interaction.status_update" .
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
Possible values:
-
in_progress -
requires_action -
completed -
failed -
cancelled -
incomplete
The event_id token to be used to resume the interaction stream, from this event.
رویداد خطا
هیچ توضیحی ارائه نشده است.
Always set to "error" .
error Error (optional)
هیچ توضیحی ارائه نشده است.
فیلدها
A URI that identifies the error type.
A human-readable error message.
The event_id token to be used to resume the interaction stream, from this event.
StepStart
هیچ توضیحی ارائه نشده است.
Always set to "step.start" .
هیچ توضیحی ارائه نشده است.
step Step (required)
هیچ توضیحی ارائه نشده است.
Possible Types
Polymorphic discriminator: type
UserInputStep
Input provided by the user.
هیچ توضیحی ارائه نشده است.
Always set to "user_input" .
content Content (optional)
هیچ توضیحی ارائه نشده است.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
هیچ توضیحی ارائه نشده است.
Always set to "text" .
Required. The text content.
annotations Annotation (optional)
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "url_citation" .
The URL.
The title of the URL.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
FileCitation
A file citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "file_citation" .
The URI of the file.
The name of the file.
Source attributed for a portion of the text.
User provided metadata about the retrieved context.
Page number of the cited document, if applicable.
Media ID in-case of image citations, if applicable.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
PlaceCitation
A place citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "place_citation" .
The ID of the place, in `places/{place_id}` format.
Title of the place.
URI reference of the place.
review_snippets ReviewSnippet (optional)
Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
ImageContent
An image content block.
هیچ توضیحی ارائه نشده است.
Always set to "image" .
The image content.
The URI of the image.
The mime type of the image.
Possible values:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
AudioContent
An audio content block.
هیچ توضیحی ارائه نشده است.
Always set to "audio" .
The audio content.
The URI of the audio.
The mime type of the audio.
Possible values:
-
audio/wav -
audio/mp3 -
audio/aiff -
audio/aac -
audio/ogg -
audio/flac -
audio/mpeg -
audio/m4a -
audio/l16 -
audio/opus -
audio/alaw -
audio/mulaw
The number of audio channels.
The sample rate of the audio.
DocumentContent
A document content block.
هیچ توضیحی ارائه نشده است.
Always set to "document" .
The document content.
The URI of the document.
The mime type of the document.
Possible values:
-
application/pdf
VideoContent
A video content block.
هیچ توضیحی ارائه نشده است.
Always set to "video" .
The video content.
The URI of the video.
The mime type of the video.
Possible values:
-
video/mp4 -
video/mpeg -
video/mpg -
video/mov -
video/avi -
video/x-flv -
video/webm -
video/wmv -
video/3gpp
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
ModelOutputStep
Output generated by the model.
هیچ توضیحی ارائه نشده است.
Always set to "model_output" .
content Content (optional)
هیچ توضیحی ارائه نشده است.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
هیچ توضیحی ارائه نشده است.
Always set to "text" .
Required. The text content.
annotations Annotation (optional)
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "url_citation" .
The URL.
The title of the URL.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
FileCitation
A file citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "file_citation" .
The URI of the file.
The name of the file.
Source attributed for a portion of the text.
User provided metadata about the retrieved context.
Page number of the cited document, if applicable.
Media ID in-case of image citations, if applicable.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
PlaceCitation
A place citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "place_citation" .
The ID of the place, in `places/{place_id}` format.
Title of the place.
URI reference of the place.
review_snippets ReviewSnippet (optional)
Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
ImageContent
An image content block.
هیچ توضیحی ارائه نشده است.
Always set to "image" .
The image content.
The URI of the image.
The mime type of the image.
Possible values:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
AudioContent
An audio content block.
هیچ توضیحی ارائه نشده است.
Always set to "audio" .
The audio content.
The URI of the audio.
The mime type of the audio.
Possible values:
-
audio/wav -
audio/mp3 -
audio/aiff -
audio/aac -
audio/ogg -
audio/flac -
audio/mpeg -
audio/m4a -
audio/l16 -
audio/opus -
audio/alaw -
audio/mulaw
The number of audio channels.
The sample rate of the audio.
DocumentContent
A document content block.
هیچ توضیحی ارائه نشده است.
Always set to "document" .
The document content.
The URI of the document.
The mime type of the document.
Possible values:
-
application/pdf
VideoContent
A video content block.
هیچ توضیحی ارائه نشده است.
Always set to "video" .
The video content.
The URI of the video.
The mime type of the video.
Possible values:
-
video/mp4 -
video/mpeg -
video/mpg -
video/mov -
video/avi -
video/x-flv -
video/webm -
video/wmv -
video/3gpp
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
ThoughtStep
A thought step.
هیچ توضیحی ارائه نشده است.
Always set to "thought" .
A signature hash for backend validation.
summary ThoughtSummaryContent (optional)
A summary of the thought.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
هیچ توضیحی ارائه نشده است.
Always set to "text" .
Required. The text content.
annotations Annotation (optional)
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "url_citation" .
The URL.
The title of the URL.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
FileCitation
A file citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "file_citation" .
The URI of the file.
The name of the file.
Source attributed for a portion of the text.
User provided metadata about the retrieved context.
Page number of the cited document, if applicable.
Media ID in-case of image citations, if applicable.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
PlaceCitation
A place citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "place_citation" .
The ID of the place, in `places/{place_id}` format.
Title of the place.
URI reference of the place.
review_snippets ReviewSnippet (optional)
Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
ImageContent
An image content block.
هیچ توضیحی ارائه نشده است.
Always set to "image" .
The image content.
The URI of the image.
The mime type of the image.
Possible values:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
FunctionCallStep
A function tool call step.
هیچ توضیحی ارائه نشده است.
Always set to "function_call" .
Required. The name of the tool to call.
Required. The arguments to pass to the function.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
CodeExecutionCallStep
Code execution call step.
هیچ توضیحی ارائه نشده است.
Always set to "code_execution_call" .
arguments CodeExecutionCallStepArguments (required)
Required. The arguments to pass to the code execution.
فیلدها
Programming language of the `code`.
Possible values:
-
python
The code to be executed.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
UrlContextCallStep
URL context call step.
هیچ توضیحی ارائه نشده است.
Always set to "url_context_call" .
arguments UrlContextCallStepArguments (required)
Required. The arguments to pass to the URL context.
فیلدها
The URLs to fetch.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
McpServerToolCallStep
MCPServer tool call step.
هیچ توضیحی ارائه نشده است.
Always set to "mcp_server_tool_call" .
Required. The name of the tool which was called.
Required. The name of the used MCP server.
Required. The JSON object of arguments for the function.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
GoogleSearchCallStep
Google Search call step.
هیچ توضیحی ارائه نشده است.
Always set to "google_search_call" .
arguments GoogleSearchCallStepArguments (required)
Required. The arguments to pass to Google Search.
فیلدها
Web search queries for the following-up web search.
The type of search grounding enabled.
Possible values:
-
web_search -
image_search -
enterprise_web_search
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
FileSearchCallStep
File Search call step.
هیچ توضیحی ارائه نشده است.
Always set to "file_search_call" .
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
GoogleMapsCallStep
Google Maps call step.
هیچ توضیحی ارائه نشده است.
Always set to "google_maps_call" .
arguments GoogleMapsCallStepArguments (optional)
The arguments to pass to the Google Maps tool.
فیلدها
The queries to be executed.
Required. A unique ID for this specific tool call.
A signature hash for backend validation.
FunctionResultStep
Result of a function tool call.
هیچ توضیحی ارائه نشده است.
Always set to "function_result" .
The name of the tool that was called.
Whether the tool call resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
The result of the tool call.
CodeExecutionResultStep
Code execution result step.
هیچ توضیحی ارائه نشده است.
Always set to "code_execution_result" .
Required. The output of the code execution.
Whether the code execution resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
UrlContextResultStep
URL context result step.
هیچ توضیحی ارائه نشده است.
Always set to "url_context_result" .
result UrlContextResultItem (required)
Required. The results of the URL context.
فیلدها
The URL that was fetched.
The status of the URL retrieval.
Possible values:
-
success -
error -
paywall -
unsafe
Whether the URL context resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
GoogleSearchResultStep
Google Search result step.
هیچ توضیحی ارائه نشده است.
Always set to "google_search_result" .
result GoogleSearchResultItem (required)
Required. The results of the Google Search.
فیلدها
Web content snippet that can be embedded in a web page or an app webview.
Whether the Google Search resulted in an error.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
McpServerToolResultStep
MCPServer tool result step.
هیچ توضیحی ارائه نشده است.
Always set to "mcp_server_tool_result" .
Name of the tool which is called for this specific tool call.
The name of the used MCP server.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
The output from the MCP server call. Can be simple text or rich content.
FileSearchResultStep
File Search result step.
هیچ توضیحی ارائه نشده است.
Always set to "file_search_result" .
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
GoogleMapsResultStep
Google Maps result step.
هیچ توضیحی ارائه نشده است.
Always set to "google_maps_result" .
result GoogleMapsResultItem (required)
هیچ توضیحی ارائه نشده است.
فیلدها
places GoogleMapsResultPlaces (optional)
هیچ توضیحی ارائه نشده است.
فیلدها
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
review_snippets ReviewSnippet (optional)
هیچ توضیحی ارائه نشده است.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
هیچ توضیحی ارائه نشده است.
Required. ID to match the ID from the function call block.
A signature hash for backend validation.
The event_id token to be used to resume the interaction stream, from this event.
StepDelta
هیچ توضیحی ارائه نشده است.
Always set to "step.delta" .
هیچ توضیحی ارائه نشده است.
delta StepDeltaData (required)
هیچ توضیحی ارائه نشده است.
Possible Types
Polymorphic discriminator: type
TextDelta
هیچ توضیحی ارائه نشده است.
Always set to "text" .
هیچ توضیحی ارائه نشده است.
ImageDelta
هیچ توضیحی ارائه نشده است.
Always set to "image" .
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
Possible values:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
AudioDelta
هیچ توضیحی ارائه نشده است.
Always set to "audio" .
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
Possible values:
-
audio/wav -
audio/mp3 -
audio/aiff -
audio/aac -
audio/ogg -
audio/flac -
audio/mpeg -
audio/m4a -
audio/l16 -
audio/opus -
audio/alaw -
audio/mulaw
Deprecated. Use sample_rate instead. The value is ignored.
The sample rate of the audio.
The number of audio channels.
DocumentDelta
هیچ توضیحی ارائه نشده است.
Always set to "document" .
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
Possible values:
-
application/pdf
VideoDelta
هیچ توضیحی ارائه نشده است.
Always set to "video" .
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
هیچ توضیحی ارائه نشده است.
Possible values:
-
video/mp4 -
video/mpeg -
video/mpg -
video/mov -
video/avi -
video/x-flv -
video/webm -
video/wmv -
video/3gpp
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
ThoughtSummaryDelta
هیچ توضیحی ارائه نشده است.
Always set to "thought_summary" .
content ThoughtSummaryContent (optional)
A new summary item to be added to the thought.
Possible Types
Polymorphic discriminator: type
TextContent
A text content block.
هیچ توضیحی ارائه نشده است.
Always set to "text" .
Required. The text content.
annotations Annotation (optional)
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "url_citation" .
The URL.
The title of the URL.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
FileCitation
A file citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "file_citation" .
The URI of the file.
The name of the file.
Source attributed for a portion of the text.
User provided metadata about the retrieved context.
Page number of the cited document, if applicable.
Media ID in-case of image citations, if applicable.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
PlaceCitation
A place citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "place_citation" .
The ID of the place, in `places/{place_id}` format.
Title of the place.
URI reference of the place.
review_snippets ReviewSnippet (optional)
Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
ImageContent
An image content block.
هیچ توضیحی ارائه نشده است.
Always set to "image" .
The image content.
The URI of the image.
The mime type of the image.
Possible values:
-
image/png -
image/jpeg -
image/webp -
image/heic -
image/heif -
image/gif -
image/bmp -
image/tiff
resolution MediaResolution (optional)
The resolution of the media.
Possible values:
-
low -
medium -
high -
ultra_high
ThoughtSignatureDelta
هیچ توضیحی ارائه نشده است.
Always set to "thought_signature" .
Signature to match the backend source to be part of the generation.
TextAnnotationDelta
هیچ توضیحی ارائه نشده است.
Always set to "text_annotation_delta" .
annotations Annotation (optional)
Citation information for model-generated content.
Possible Types
Polymorphic discriminator: type
UrlCitation
A URL citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "url_citation" .
The URL.
The title of the URL.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
FileCitation
A file citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "file_citation" .
The URI of the file.
The name of the file.
Source attributed for a portion of the text.
User provided metadata about the retrieved context.
Page number of the cited document, if applicable.
Media ID in-case of image citations, if applicable.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
PlaceCitation
A place citation annotation.
هیچ توضیحی ارائه نشده است.
Always set to "place_citation" .
The ID of the place, in `places/{place_id}` format.
Title of the place.
URI reference of the place.
review_snippets ReviewSnippet (optional)
Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
فیلدها
Title of the review.
A link that corresponds to the user review on Google Maps.
The ID of the review snippet.
Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
End of the attributed segment, exclusive.
ArgumentsDelta
هیچ توضیحی ارائه نشده است.
Always set to "arguments_delta" .
هیچ توضیحی ارائه نشده است.
The event_id token to be used to resume the interaction stream, from this event.
StepStop
هیچ توضیحی ارائه نشده است.
Always set to "step.stop" .
هیچ توضیحی ارائه نشده است.
The event_id token to be used to resume the interaction stream, from this event.
مثالها
Interaction Created
{ "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" }
Interaction Status Update
{ "event_type": "interaction.status_update", "interaction_id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM", "status": "in_progress" }
Error Event
{ "event_type": "error", "error": { "message": "Failed to get completed interaction: Result not found.", "code": "not_found" } }
Step Start
{ "event_type": "step.start", "index": 0, "step": { "type": "model_output" } }
گام دلتا
{ "event_type": "step.delta", "index": 0, "delta": { "type": "text", "text": "Hello" } }
Step Stop
{ "event_type": "step.stop", "index": 0 }