Gemini Triggers API

تریگرها به شما امکان می‌دهند تا اجرای عامل‌ها را در یک برنامه‌ی cron زمان‌بندی کنید و وظایف خودکار و تکرارشونده را فعال کنید.

مشاهده به صورت markdown مشاهده مشخصات OpenAPI

ایجادتریگر

ارسال به آدرس https://generativelanguage.googleapis.com/v1beta/triggers

یک تریگر جدید ایجاد می‌کند که عامل مشخص شده را در زمان‌بندی cron داده شده فراخوانی می‌کند.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

رشته‌ی display_name (اختیاری)

اختیاری. نام نمایشی تریگر.

رشته‌ی environment_id (اختیاری)

اختیاری. شناسه محیط برای اجرای تریگر.

عدد صحیح execution_timeout_seconds (اختیاری)

اختیاری. زمان اجرای تعامل فعال‌شده.

پارامترهای تعامل CreateAgentInteractionParams یا CreateModelInteractionParams (الزامی)

الزامی. الگوی درخواست تعاملی که باید اجرا شود.

عدد صحیح max_consecutive_failures (اختیاری)

اختیاری. حداکثر تعداد خطاهای متوالی مجاز قبل از اینکه تریگر به طور خودکار متوقف شود (وضعیت به ERROR تبدیل شود).

رشته زمانبندی (الزامی)

الزامی. برنامه زمانی cron که trigger باید روی آن اجرا شود. قالب استاندارد cron.

رشته منطقه زمانی (الزامی)

الزامی. منطقه زمانی که برنامه باید در آن تفسیر شود.

پاسخ

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

عدد صحیح sequential_failure_count (اختیاری)

فقط خروجی. تعداد شکست‌های متوالی که از آخرین اجرای موفق رخ داده‌اند.

رشته‌ی create_time (اختیاری)

فقط خروجی. زمانی که تریگر ایجاد شده است.

رشته‌ی display_name (اختیاری)

اختیاری. نام نمایشی تریگر.

رشته‌ی environment_id (اختیاری)

اختیاری. شناسه محیط برای اجرای تریگر.

عدد صحیح execution_timeout_seconds (اختیاری)

اختیاری. زمان اجرای تعامل فعال‌شده.

رشته شناسه (اختیاری)

الزامی. فقط خروجی. شناسه. شناسه‌ی تریگر.

تعامل تعامل (اختیاری)

الزامی. الگوی درخواست تعاملی که باید اجرا شود.

منبع تعامل.

فیلدها

گزینه عامل (اختیاری)

نام «عامل» مورد استفاده برای ایجاد تعامل.

عاملی که باید با آن تعامل داشت.

مقادیر ممکن

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

    نماینده تحقیقات عمیق جمینی

  • deep-research-preview-04-2026

    نماینده تحقیقات عمیق جمینی

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

    مامور مکس تحقیقات عمیق جمینی

  • antigravity-preview-05-2026

    از عامل مدیریت‌شده‌ی Antigravity برای انجام وظایف چند مرحله‌ای که نیاز به استدلال، عملیات فایل و استفاده از ابزار دارند، استفاده کنید.

شیء agent_config (اختیاری)

پارامترهای پیکربندی برای تعامل عامل.

انواع ممکن

تفکیک‌کننده چندریختی: type

پیکربندی عامل ضد جاذبه

پیکربندی برای زمان اجرای عامل Antigravity. کنترل سمت سرور بر محیط اجرای عامل و پیکربندی ابزار را فراهم می‌کند.

رشته‌ی max_total_tokens (اختیاری)

حداکثر مجموع توکن‌ها برای اجرای عامل.

رشته مدل (اختیاری)

مدلی که برای استدلال عامل استفاده می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "antigravity" تنظیم شود.

پیکربندی CodeMenderAgentConfig

پیکربندی برای عامل CodeMender.

درخواست_یافتن (اختیاری )

پارامترهایی برای یافتن آسیب‌پذیری‌ها

پارامترهای درخواست مختص جلسات FIND، که برای کشف آسیب‌پذیری‌ها در یک پایگاه کد استفاده می‌شوند.

فیلدها

رشته توضیحات (اختیاری)

دستورالعمل‌های زمینه‌ای یا سفارشی اضافی که توسط کاربر برای هدایت تحلیل آسیب‌پذیری ارائه می‌شود.

رشته find_id (اختیاری)

شناسه‌ی یک یافته‌ی خاص برای تأیید. این مورد عمدتاً در حالت VERIFY برای تمرکز اعتبارسنجی مبتنی بر اجرای عامل بر روی یک آسیب‌پذیری واحد استفاده می‌شود.

حالت شمارشی (رشته) (اختیاری)

نحوه‌ی جلسه‌ی یافتن.

مقادیر ممکن:

  • scan

    اسکن سریع فقط با استفاده از طبقه‌بندی‌کننده اولیه.

  • verify

    طبقه‌بندی را انجام می‌دهد و به دنبال آن بررسی دقیقی انجام می‌دهد.

آرایه source_files (محتوای فایل) (اختیاری)

فهرستی از فایل‌های منبع که به عنوان زمینه برای اسکن ارائه می‌شوند.

محتوای یک فایل واحد در کدبیس.

فیلدها

رشته محتوا (اختیاری)

محتوای متنی فایل که با استاندارد UTF-8 کدگذاری شده است.

رشته مسیر (اختیاری)

مسیر نسبی فایل از ریشه پروژه.

درخواست رفع مشکل (اختیاری)

پارامترهای رفع آسیب‌پذیری‌ها

پارامترهای مخصوص جلسات FIX را درخواست کنید، که برای تولید و اعتبارسنجی وصله‌های امنیتی استفاده می‌شوند.

فیلدها

رشته توضیحات (اختیاری)

دستورالعمل‌های زمینه‌ای یا سفارشی اضافی که توسط کاربر برای هدایت فرآیند تولید پچ ارائه می‌شود.

رشته find_id (اختیاری)

شناسه‌ی یافته‌ی امنیتی خاصی که باید اصلاح شود. این شناسه به یک آسیب‌پذیری کشف‌شده‌ی قبلی اشاره دارد.

آرایه source_files (محتوای فایل) (اختیاری)

فهرستی از فایل‌های منبع که زمینه را برای اصلاح فراهم می‌کنند. این فایل‌ها معمولاً فایل‌هایی هستند که حاوی آسیب‌پذیری شناسایی‌شده هستند.

محتوای یک فایل واحد در کدبیس.

فیلدها

رشته محتوا (اختیاری)

محتوای متنی فایل که با استاندارد UTF-8 کدگذاری شده است.

رشته مسیر (اختیاری)

مسیر نسبی فایل از ریشه پروژه.

رشته مدل (اختیاری)

نام مدلی که برای عامل CodeMender استفاده می‌شود. در هر جلسه CodeMender فقط از یک مدل استفاده خواهد شد.

session_config پیکربندی جلسه (اختیاری)

پیکربندی‌های اختیاری مختص جلسه برای لغو رفتار پیش‌فرض عامل.

پیکربندی جلسات CodeMender.

فیلدها

عدد صحیح max_rounds (اختیاری)

حداکثر تعداد دورهای تعاملی که عامل مجاز است قبل از رسیدن به مهلت زمانی مشخص شده انجام دهد.

رشته session_id (اختیاری)

پارامتری برای گروه‌بندی چندین تعامل که متعلق به یک جلسه CodeMender هستند.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code-mender" تنظیم شود.

پیکربندی DeepResearchAgent

پیکربندی برای عامل تحقیقات عمیق.

نوع بولی collaboration_planning (اختیاری)

برنامه‌ریزی انسان در حلقه را برای عامل تحقیقات عمیق فعال می‌کند. اگر روی درست تنظیم شود، عامل تحقیقات عمیق در پاسخ خود یک طرح تحقیقاتی ارائه می‌دهد. سپس عامل تنها در صورتی ادامه می‌دهد که کاربر طرح را در نوبت بعدی تأیید کند.

enable_bigquery_tool مقدار بولی (اختیاری)

ابزار bigquery را برای عامل Deep Research فعال می‌کند.

خلاصه‌های تفکر ( اختیاری)

اینکه آیا خلاصه نظرات در پاسخ گنجانده شود یا خیر.

مقادیر ممکن

  • auto

    خلاصه‌های تفکر خودکار

  • none

    بدون خلاصه نویسی فکری.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "deep-research" تنظیم شود.

تجسم enum (رشته) (اختیاری)

اینکه آیا باید از تصاویر در پاسخ استفاده کرد یا خیر.

مقادیر ممکن:

  • off

    تجسمات را لحاظ نکنید.

  • auto

    به طور خودکار تجسم‌ها را شامل می‌شود.

پیکربندی DynamicAgent

پیکربندی برای عامل‌های پویا

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "dynamic" تنظیم شود.

رشته ایجاد شده (اختیاری)

فقط خروجی. زمانی که پاسخ در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) ایجاد شده است.

environmentConfig یا رشته (اختیاری)

پیکربندی محیط برای تعامل. می‌تواند یک شیء باشد که منابع محیط از راه دور را مشخص می‌کند یا رشته‌ای باشد که به یک شناسه محیط موجود اشاره می‌کند.

پیکربندی برای یک محیط سفارشی.

فیلدها

رشته‌ی environment_id (اختیاری)

اختیاری. شناسه محیط برای تعامل. در صورت مشخص شدن، درخواست به جای ایجاد یک محیط جدید، محیط موجود را به‌روزرسانی می‌کند.

شبکه EnvironmentNetworkEgressAllowlist یا enum (رشته‌ای) (اختیاری)

پیکربندی شبکه برای محیط.

پیکربندی شبکه خروجی برای sandbox. یک شیء با آرایه 'allowlist' را برای محدود کردن ترافیک یا رشته 'disabled' را برای خاموش کردن تمام دسترسی به شبکه می‌پذیرد. برای مجاز کردن تمام ترافیک خروجی بدون تزریق هدر، این بخش را به طور کامل حذف کنید.

انواع ممکن

شیء

پیکربندی شبکه خروجی برای sandbox. در صورت مشخص شدن، دامنه‌های خارجی که sandbox می‌تواند به آنها دسترسی داشته باشد را محدود می‌کند. برای مجاز کردن تمام ترافیک خروجی بدون تزریق هدر، این مورد را به طور کامل حذف کنید.

آرایه allowlist (AllowlistEntry) (اختیاری)

فهرست دامنه‌های خروجی مجاز. فقط درخواست‌ها به دامنه‌های فهرست‌شده مجاز هستند. از [{'domain': '*'}] برای مجاز کردن همه دامنه‌ها استفاده کنید و در عین حال هدرها را روی دامنه‌های خاص تزریق کنید.

یک قانون لیست مجاز دامنه واحد با تزریق هدر اختیاری.

فیلدها

رشته دامنه (اختیاری)

دامنه‌ای که درخواست‌های خروجی به آن مجاز است. از کاراکترهای عمومی (مثلاً '*.googleapis.com') پشتیبانی می‌کند. از '*' برای مجاز کردن همه دامنه‌ها استفاده کنید.

تبدیل آرایه (شیء) یا شیء (اختیاری)

هدرهایی برای تزریق در تمام درخواست‌های خروجی مطابق با این دامنه. یک dict یا لیستی از dictها را می‌پذیرد. پروکسی خروجی این موارد را به طور خودکار تزریق می‌کند.

رشته

تمام شبکه‌ها را خاموش می‌کند.

مقادیر ممکن

  • disabled

    تمام شبکه‌ها را خاموش می‌کند.

آرایه منابع (منبع) (اختیاری)

هیچ توضیحی ارائه نشده است.

منبعی که باید در محیط نصب شود.

فیلدها

رشته محتوا (اختیاری)

محتوای درون‌خطی اگر `type` باشد، `INLINE` است.

رشته کدگذاری (اختیاری)

کدگذاری اختیاری برای محتوای درون‌خطی (مثلاً `base64`).

رشته منبع (اختیاری)

منبع محیط. برای فضای ذخیره‌سازی ابری، این مسیر فضای ذخیره‌سازی ابری است. برای گیت‌هاب، این مسیر گیت‌هاب است.

رشته هدف (اختیاری)

جایی که منبع باید در محیط ظاهر شود.

نوع enum (رشته) (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • gcs

    یک مخزن ذخیره‌سازی ابری.

  • inline

    محتوای درون خطی.

  • repository

    یک مخزن عمومی. پیشوند پروتکل در URL منبع، ارائه‌دهنده را مشخص می‌کند (مثلاً github://، gcs://).

  • skill_registry

    یک منبع مهارت از سرویس ثبت مهارت. مهارت: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} پشتیبانی از نصب همه مهارت‌ها تحت یک پروژه: projects/{project}/locations/{location}/skills.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "remote" تنظیم شود.

رشته‌ی environment_id (اختیاری)

فقط خروجی. شناسه محیط برای تعامل. فقط در صورتی که پیکربندی محیط در درخواست تنظیم شده باشد، پر می‌شود.

آرایه خطاها (Error) (اختیاری)

فقط خروجی. خطاهای تشخیصی / خطاهای پلتفرم که در تعامل ثبت شده‌اند.

پیام خطا از یک تعامل.

فیلدها

رشته کد (اختیاری)

یک URI که نوع خطا را مشخص می‌کند.

رشته پیام (اختیاری)

یک پیام خطا که برای انسان قابل خواندن باشد.

رشته شناسه (اختیاری)

الزامی. فقط خروجی. یک شناسه منحصر به فرد برای تکمیل تعامل.

پیش‌فرض‌ها به:

ورودی محتوا یا آرایه (Content) یا آرایه (Step) یا رشته (اختیاری)

ورودی برای تعامل.

شیء برچسب‌ها (اختیاری)

برچسب‌هایی با فراداده‌های تعریف‌شده توسط کاربر برای درخواست.

مدل ModelOption (اختیاری)

نام «مدل» مورد استفاده برای تولید تعامل.

مدلی که اعلان شما را تکمیل می‌کند.\n\nبرای جزئیات بیشتر به [models](https://ai.google.dev/gemini-api/docs/models) مراجعه کنید.

مقادیر ممکن

  • gemini-2.5-flash

    اولین مدل استدلال ترکیبی ما که از یک پنجره زمینه ۱ میلیون توکنی پشتیبانی می‌کند و دارای بودجه‌های تفکر است.

  • gemini-2.5-pro

    مدل چندمنظوره پیشرفته ما، که در کدنویسی و کارهای استدلالی پیچیده عالی عمل می‌کند.

  • gemma-4-26b-a4b-it

    جما ۴ ۲۶ب A4ب آی تی

  • gemma-4-31b-it

    جما ۴ ۳۱ب آی‌تی

  • gemini-flash-latest

    آخرین نسخه از بازی Gemini Flash

  • gemini-flash-lite-latest

    آخرین نسخه Gemini Flash-Lite

  • gemini-pro-latest

    آخرین نسخه Gemini Pro

  • gemini-2.5-flash-lite

    کوچکترین و مقرون به صرفه ترین مدل ما، ساخته شده برای استفاده در مقیاس بزرگ.

  • gemini-2.5-flash-image

    مدل تولید تصویر بومی ما، که برای سرعت، انعطاف‌پذیری و درک متنی بهینه شده است. ورودی و خروجی متن با همان قیمت ۲.۵ فلش ارائه می‌شود.

  • gemini-3-flash-preview

    هوشمندترین مدل ما که برای سرعت ساخته شده است، هوش مرزی را با جستجو و ردیابی برتر ترکیب می‌کند.

  • gemini-3.1-pro-preview

    جدیدترین مدل استدلال SOTA ما با عمق و ظرافت بی‌سابقه و قابلیت‌های قدرتمند درک و کدنویسی چندوجهی.

  • gemini-3.1-pro-preview-customtools

    پیش‌نمایش Gemini 3.1 Pro برای استفاده از ابزارهای سفارشی بهینه شده است

  • gemini-3.1-flash-lite

    مقرون‌به‌صرفه‌ترین مدل ما، بهینه‌شده برای وظایف عامل‌محور با حجم بالا، ترجمه و پردازش داده‌های ساده.

  • gemini-3-pro-image

    تصویر Gemini 3 Pro

  • nano-banana-pro-preview

    پیش‌نمایش تصویر Gemini 3 Pro

  • gemini-3.1-flash-image

    تصویر فلش جمینی ۳.۱.

  • gemini-3.5-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • gemini-3.6-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • gemini-3.7-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • lyria-3-clip-preview

    مدل تولید موسیقی با تأخیر کم ما برای کلیپ‌های صوتی با کیفیت بالا و کنترل دقیق ریتمیک بهینه شده است.

  • lyria-3-pro-preview

    مدل پیشرفته و کامل ما برای تولید آهنگ با درک عمیق از آهنگسازی، بهینه شده برای کنترل ساختاری دقیق و انتقال‌های پیچیده در سبک‌های مختلف موسیقی.

  • gemini-robotics-er-1.6-preview

    پیش‌نمایش Gemini Robotics-ER 1.6

  • gemini-robotics-er-2-preview

    پیش‌نمایش Gemini Robotics Embodied Reasoning 2

محتوای صوتی output_audio (اختیاری)

آخرین صدای تولید شده توسط مدل در پاسخ به درخواست فعلی. توجه: این توسط SDK اضافه شده است.

یک بلوک محتوای صوتی.

فیلدها

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای تصویر خروجی (اختیاری)

آخرین تصویری که توسط مدل در پاسخ به درخواست فعلی تولید شده است. توجه: این تصویر توسط SDK اضافه شده است.

یک بلوک محتوای تصویر.

فیلدها

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

رشته‌ی output_text (اختیاری)

متن به هم پیوسته از آخرین خروجی مدل در پاسخ به درخواست فعلی. توجه: این توسط SDK اضافه شده است.

خروجی_ویدئو محتوای ویدیویی (اختیاری)

آخرین ویدیویی که توسط مدل در پاسخ به درخواست فعلی تولید شده است. توجه: این توسط SDK اضافه شده است.

یک بلوک محتوای ویدیویی.

فیلدها

رشته داده (اختیاری)

محتوای ویدیویی.

mime_type enum (رشته) (اختیاری)

نوع میم (شبیه‌سازی) ویدیو.

مقادیر ممکن:

  • video/mp4

    فرمت ویدیویی MP4

  • video/mpeg

    فرمت ویدیویی MPEG

  • video/mpg

    فرمت ویدیویی MPG

  • video/mov

    فرمت ویدیویی MOV

  • video/avi

    فرمت ویدیویی AVI

  • video/x-flv

    فرمت ویدیویی FLV

  • video/webm

    فرمت ویدیویی وب‌ام

  • video/wmv

    فرمت ویدیویی WMV

  • video/3gpp

    فرمت ویدیویی 3GPP

پردازش MediaProcessing یا enum (رشته‌ای) (اختیاری)

چگونه مدل این ویدیو را برای درک پردازش می‌کند.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "video" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) ویدیو.

رشته‌ی previous_interaction_id (اختیاری)

شناسه‌ی تعامل قبلی، در صورت وجود.

response_format فرمت پاسخ یا آرایه (ResponseFormat) (اختیاری)

تأکید می‌کند که پاسخ تولید شده یک شیء JSON است که با طرحواره JSON مشخص شده در این فیلد مطابقت دارد.

انواع ممکن

قالب پاسخ صوتی

پیکربندی فرمت خروجی صدا

عدد صحیح bit_rate (اختیاری)

نرخ بیت بر حسب بیت در ثانیه (bps). فقط برای فرمت‌های فشرده (MP3، Opus) قابل استفاده است.

متغیر شمارشی تحویل (رشته‌ای) (اختیاری)

حالت تحویل برای خروجی صدا.

مقادیر ممکن:

  • inline

    داده‌های صوتی به صورت درون‌خطی در پاسخ بازگردانده می‌شوند.

  • uri

    داده‌های صوتی به صورت یک URI برگردانده می‌شوند.

mime_type enum (رشته) (اختیاری)

نوع MIME خروجی صدا.

مقادیر ممکن:

  • audio/mp3

    فرمت صوتی MP3.

  • audio/ogg_opus

    فرمت صوتی OGG Opus.

  • audio/l16

    فرمت صوتی خام PCM (L16).

  • audio/wav

    فرمت صوتی WAV.

  • audio/alaw

    فرمت صوتی A-law.

  • audio/mulaw

    فرمت صوتی مو-لا.

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری بر حسب هرتز.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

قالب پاسخ تصویر

پیکربندی فرمت خروجی تصویر

متغیر شمارشی aspect_ratio (رشته‌ای) (اختیاری)

نسبت ابعاد برای خروجی تصویر.

مقادیر ممکن:

  • 1:1

    نسبت تصویر ۱:۱.

  • 2:3

    نسبت تصویر ۲:۳.

  • 3:2

    نسبت تصویر ۳:۲.

  • 3:4

    نسبت تصویر ۳:۴.

  • 4:3

    نسبت تصویر ۴:۳.

  • 4:5

    نسبت تصویر ۴:۵.

  • 5:4

    نسبت تصویر ۵:۴.

  • 9:16

    نسبت تصویر ۹:۱۶

  • 16:9

    نسبت تصویر ۱۶:۹.

  • 21:9

    نسبت تصویر ۲۱:۹.

  • 1:8

    نسبت تصویر ۱:۸.

  • 8:1

    نسبت تصویر ۸:۱.

  • 1:4

    نسبت تصویر ۱:۴.

  • 4:1

    نسبت تصویر ۴:۱.

متغیر شمارشی تحویل (رشته‌ای) (اختیاری)

حالت تحویل برای خروجی تصویر.

مقادیر ممکن:

  • inline

    داده‌های تصویر به صورت درون‌خطی در پاسخ بازگردانده می‌شوند.

  • uri

    داده‌های تصویر به صورت یک URI برگردانده می‌شوند.

متغیر شمارشی image_size (رشته‌ای) (اختیاری)

اندازه تصویر خروجی

مقادیر ممکن:

  • 512

    اندازه تصویر ۵۱۲ پیکسل.

  • 1K

    حجم تصویر ۱ کیلوبایت

  • 2K

    اندازه تصویر ۲K

  • 4K

    اندازه تصویر 4K

mime_type enum (رشته) (اختیاری)

نوع MIME تصویر خروجی.

مقادیر ممکن:

  • image/jpeg

    فرمت تصویر JPEG.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

قالب پاسخ متنی

پیکربندی فرمت خروجی متن

mime_type enum (رشته) (اختیاری)

نوع MIME متن خروجی.

مقادیر ممکن:

  • application/json

    فرمت خروجی JSON

  • text/plain

    قالب خروجی متن ساده.

شیء طرحواره (اختیاری)

طرحواره JSON که خروجی باید با آن مطابقت داشته باشد. فقط زمانی قابل اجرا است که mime_type برابر با application/json باشد.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

قالب پاسخ ویدیویی

پیکربندی فرمت خروجی ویدئو

متغیر شمارشی aspect_ratio (رشته‌ای) (اختیاری)

نسبت ابعاد برای خروجی ویدئو.

مقادیر ممکن:

  • 16:9

    نسبت تصویر ۱۶:۹.

  • 9:16

    نسبت تصویر ۹:۱۶

متغیر شمارشی تحویل (رشته‌ای) (اختیاری)

حالت تحویل برای خروجی ویدئو.

مقادیر ممکن:

  • inline

    داده‌های ویدیویی به صورت درون‌خطی در پاسخ بازگردانده می‌شوند.

  • uri

    داده‌های ویدیویی به صورت یک URI برگردانده می‌شوند.

رشته مدت زمان (اختیاری)

مدت زمان خروجی ویدیو.

رشته gcs_uri (اختیاری)

آدرس اینترنتی فضای ابری برای ذخیره خروجی ویدیو. در صورتی که حالت تحویل URI باشد، برای Vertex مورد نیاز است.

شمارشگر تفکیک‌پذیری (رشته) (اختیاری)

وضوح خروجی ویدیو. پیش‌فرض روی ۷۲۰p.

مقادیر ممکن:

  • 360p

    وضوح تصویر ۳۶۰p.

  • 720p

    وضوح تصویر ۷۲۰p.

  • 1080p

    وضوح تصویر ۱۰۸۰p.

  • 4k

    وضوح تصویر 4K.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "video" تنظیم شود.

آرایه safety_settings (SafetySetting) (اختیاری)

تنظیمات ایمنی برای تعامل.

یک تنظیم ایمنی که بر رفتار مسدود کردن ایمنی تأثیر می‌گذارد. یک تنظیم ایمنی شامل یک دسته آسیب و یک آستانه برای آن دسته است.

فیلدها

متد enum (رشته) (اختیاری)

اختیاری. روش مسدود کردن محتوا. اگر مشخص نشده باشد، رفتار پیش‌فرض استفاده از امتیاز احتمال است.

مقادیر ممکن:

  • severity

    روش بلوک آسیب از هر دو امتیاز احتمال و شدت استفاده می‌کند.

  • probability

    روش بلوک آسیب از امتیاز احتمال استفاده می‌کند.

شمارش آستانه (رشته) (اختیاری)

الزامی. آستانه‌ی مسدود کردن محتوا. اگر احتمال آسیب از این آستانه بیشتر شود، محتوا مسدود خواهد شد.

مقادیر ممکن:

  • block_low_and_above

    مسدود کردن محتوا با احتمال آسیب کم یا بیشتر.

  • block_medium_and_above

    محتوایی را که احتمال آسیب‌رسانی آن متوسط ​​یا بالاتر است، مسدود کنید.

  • block_only_high

    مسدود کردن محتوا با احتمال آسیب بالا.

  • block_none

    صرف نظر از احتمال آسیب‌رسانی آن، هیچ محتوایی را مسدود نکنید.

  • off

    فیلتر ایمنی را کاملاً خاموش کنید.

نوع آسیب (اختیاری)

الزامی. نوع دسته‌بندی آسیبی که باید مسدود شود.

مقادیر ممکن

  • hate_speech

    محتوایی که خشونت را ترویج می‌دهد یا بر اساس ویژگی‌های خاص، نفرت علیه افراد یا گروه‌ها را برمی‌انگیزد.

  • dangerous_content

    محتوایی که فعالیت‌های خطرناک را ترویج، تسهیل یا امکان‌پذیر می‌کند.

  • harassment

    محتوای توهین‌آمیز، تهدیدآمیز یا با هدف قلدری، شکنجه یا تمسخر.

  • sexually_explicit

    محتوایی که حاوی مطالب جنسی و غیراخلاقی باشد.

  • civic_integrity

    منسوخ شده: فیلتر انتخابات دیگر پشتیبانی نمی‌شود. دسته‌بندی آسیب، سلامت مدنی است.

  • image_hate

    تصاویری که حاوی نفرت‌پراکنی هستند.

  • image_dangerous_content

    تصاویری که حاوی محتوای خطرناک هستند.

  • image_harassment

    تصاویری که حاوی آزار و اذیت هستند.

  • image_sexually_explicit

    تصاویری که حاوی محتوای جنسی هستند.

  • jailbreak

    اعلان‌هایی که برای دور زدن فیلترهای ایمنی طراحی شده‌اند.

service_tier لایه سرویس (اختیاری)

لایه سرویس برای تعامل.

مقادیر ممکن

  • flex

    سطح خدمات انعطاف‌پذیر.

  • standard

    سطح خدمات استاندارد.

  • priority

    ردیف خدمات اولویت‌دار.

  • deferred

    ردیف خدمات معوق.

شمارش وضعیت (رشته) (اختیاری)

الزامی. فقط خروجی. وضعیت تعامل.

مقادیر ممکن:

  • in_progress

    تعامل در حال انجام است.

  • requires_action

    این تعامل نیاز به اقدام/ورودی از سوی کاربر دارد.

  • completed

    تعامل تکمیل شده است.

  • failed

    تعامل شکست خورد.

  • cancelled

    تعامل لغو شد.

  • incomplete

    تعامل تکمیل شده است، اما شامل نتایج ناقص است (مثلاً رسیدن به max_tokens).

  • budget_exceeded

    تعامل متوقف شد زیرا بودجه توکن از حد مجاز فراتر رفته بود.

  • queued

    تعامل در صف انتظار پردازش قرار می‌گیرد.

آرایه گام‌ها (Step) (اختیاری)

فقط خروجی. مراحلی که تعامل را تشکیل می‌دهند، زمانی که در پاسخ گنجانده شوند.

گامی در تعامل.

انواع ممکن

مرحله فراخوانی کد (CodeExecutionCallStep)

مرحله فراخوانی اجرای کد.

آرگومان‌های CodeExecutionCallStepArgumentها (الزامی)

الزامی. آرگومان‌هایی که برای اجرای کد ارسال می‌شوند.

آرگومان‌هایی که باید به اجرای کد ارسال شوند.

فیلدها

رشته کد (اختیاری)

کدی که قرار است اجرا شود.

شمارش زبان (رشته) (اختیاری)

زبان برنامه‌نویسی «کد».

مقادیر ممکن:

  • python

    پایتون >= 3.10، با numpy و simpy در دسترس است.

رشته شناسه (الزامی)

الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution_call" تنظیم شود.

مرحله اجرای کد (CodeExecutionResultStep)

مرحله نتیجه اجرای کد.

رشته call_id (الزامی)

الزامی. شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت داشته باشد.

is_error نوع داده بولی (اختیاری)

اینکه آیا اجرای کد منجر به خطا شده است یا خیر.

رشته نتیجه (الزامی)

خروجی اجرای کد. الزامی.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution_result" تنظیم شود.

جستجوی فایلفراخوانیمرحله

مرحله فراخوانی جستجوی فایل.

رشته شناسه (الزامی)

الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_search_call" تنظیم شود.

مرحله‌ی جستجوی فایل

مرحله نتیجه جستجوی فایل

رشته call_id (الزامی)

الزامی. شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت داشته باشد.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_search_result" تنظیم شود.

مرحله فراخوانی تابع

مرحله فراخوانی ابزار تابع.

شیء آرگومان‌ها (الزامی)

آرگومان‌هایی که باید به تابع ارسال شوند.

رشته شناسه (الزامی)

الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

رشته نام (الزامی)

الزامی. نام ابزاری که باید فراخوانی شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "function_call" تنظیم شود.

تابعنتیجهمرحله

نتیجه‌ی فراخوانی ابزار تابع.

رشته call_id (الزامی)

الزامی. شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت داشته باشد.

is_error نوع داده بولی (اختیاری)

اینکه آیا فراخوانی ابزار منجر به خطا شده است یا خیر.

رشته نام (اختیاری)

نام ابزاری که نامیده شد.

آرایه نتیجه (ImageContent یا TextContent) یا شیء یا رشته (الزامی)

الزامی. نتیجه‌ی فراخوانی ابزار.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "function_result" تنظیم شود.

گوگل مپ کال استپ

مرحله تماس با نقشه گوگل

آرگومان‌های GoogleMapsCallStepArguments (اختیاری)

آرگومان‌هایی که باید به ابزار نقشه‌های گوگل ارسال شوند.

آرگومان‌هایی که باید به ابزار نقشه‌های گوگل ارسال شوند.

فیلدها

آرایه کوئری‌ها (رشته) (اختیاری)

کوئری‌هایی که باید اجرا شوند.

رشته شناسه (الزامی)

الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_maps_call" تنظیم شود.

مرحله نتیجه گوگل مپ

مرحله نتایج نقشه گوگل

رشته call_id (الزامی)

الزامی. شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت داشته باشد.

آرایه نتایج (GoogleMapsResultItem) (الزامی)

هیچ توضیحی ارائه نشده است.

نتیجه نقشه‌های گوگل.

فیلدها

آرایه مکان‌ها (GoogleMapsResultPlaces) (اختیاری)

هیچ توضیحی ارائه نشده است.

فیلدها

رشته نام (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته place_id (اختیاری)

هیچ توضیحی ارائه نشده است.

آرایه review_snippets (ReviewSnippet) (اختیاری)

هیچ توضیحی ارائه نشده است.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

رشته آدرس اینترنتی (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته widget_context_token (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_maps_result" تنظیم شود.

جستجوی گوگل

مرحله تماس جستجوی گوگل.

آرگومان‌های GoogleSearchCallStepArguments (الزامی)

الزامی. آرگومان‌هایی که باید به جستجوی گوگل ارسال شوند.

آرگومان‌هایی که باید به جستجوی گوگل ارسال شوند.

فیلدها

آرایه کوئری‌ها (رشته) (اختیاری)

عبارت‌های جستجوی وب برای جستجوی وب بعدی.

رشته شناسه (الزامی)

الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

تابع search_type enum (رشته‌ای) (اختیاری)

نوع اتصال زمینی جستجو فعال شده.

مقادیر ممکن:

  • web_search

    تنظیم این فیلد، جستجوی وب را فعال می‌کند. فقط نتایج متنی برگردانده می‌شوند.

  • image_search

    تنظیم این فیلد، جستجوی تصویر را فعال می‌کند. بایت‌های تصویر برگردانده می‌شوند.

  • enterprise_web_search

    تنظیم این فیلد، جستجوی وب سازمانی را فعال می‌کند.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_search_call" تنظیم شود.

مرحله نتایج جستجوی گوگل

مرحله نتیجه جستجوی گوگل

رشته call_id (الزامی)

الزامی. شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت داشته باشد.

is_error نوع داده بولی (اختیاری)

اینکه آیا جستجوی گوگل منجر به خطا شده است یا خیر.

آرایه نتایج (GoogleSearchResultItem) (الزامی)

الزامی. نتایج جستجوی گوگل.

نتیجه جستجوی گوگل.

فیلدها

رشته‌ی search_suggestions (اختیاری)

قطعه محتوای وب که می‌تواند در یک صفحه وب یا نمای وب یک برنامه تعبیه شود.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_search_result" تنظیم شود.

ابزار فراخوانی مک‌پ‌سرور (McpServerToolCallStep)

مرحله فراخوانی ابزار MCPServer.

شیء آرگومان‌ها (الزامی)

الزامی. شیء JSON آرگومان‌های تابع.

رشته شناسه (الزامی)

الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

رشته نام (الزامی)

الزامی. نام ابزاری که فراخوانی شده است.

رشته نام سرور (الزامی)

الزامی. نام سرور MCP مورد استفاده.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "mcp_server_tool_call" تنظیم شود.

ابزار نتیجه McpServerTool

مرحله نتیجه ابزار MCPServer.

رشته call_id (الزامی)

الزامی. شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت داشته باشد.

رشته نام (اختیاری)

نام ابزاری که برای این فراخوانی ابزار خاص فراخوانی می‌شود.

آرایه نتیجه (ImageContent یا TextContent) یا شیء یا رشته (الزامی)

الزامی. خروجی حاصل از فراخوانی سرور MCP. می‌تواند متن ساده یا محتوای غنی باشد.

رشته server_name (اختیاری)

نام سرور MCP مورد استفاده.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "mcp_server_tool_result" تنظیم شود.

مرحله خروجی مدل

خروجی تولید شده توسط مدل.

آرایه محتوا (محتوا) (اختیاری)

هیچ توضیحی ارائه نشده است.

محتوای پاسخ.

انواع ممکن

محتوای صوتی

یک بلوک محتوای صوتی.

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای سند

یک بلوک محتوای سند.

رشته داده (اختیاری)

محتوای سند.

mime_type enum (رشته) (اختیاری)

نوع MIME سند.

مقادیر ممکن:

  • application/pdf

    فرمت سند PDF

  • text/csv

    فرمت سند CSV

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "document" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) سند.

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

ورد اینفو

حاشیه‌نویسی ASR در سطح کلمه برای خروجی رونویسی. متن کلمه، زمان‌بندی اختیاری و انتساب اختیاری گوینده را در خود جای می‌دهد.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته end_offset (اختیاری)

فاصله پایان کلمه نسبت به شروع فایل صوتی. وقتی timestamp_granularities شامل "word" باشد، نمایش داده می‌شود.

سیم بلندگو (اختیاری)

اختیاری. برچسب گوینده برای این کلمه (مثلاً "spk_1"، "spk_2"). وقتی diarization_mode در TranscriptionConfig تنظیم شده باشد، ارائه می‌شود.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته start_offset (اختیاری)

فاصله شروع کلمه نسبت به شروع فایل صوتی. وقتی timestamp_granularities شامل "word" باشد، نمایش داده می‌شود.

رشته متن (اختیاری)

کلمه رونویسی شده.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "word_info" تنظیم شود.

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

محتوای ویدیویی

یک بلوک محتوای ویدیویی.

رشته داده (اختیاری)

محتوای ویدیویی.

mime_type enum (رشته) (اختیاری)

نوع میم (شبیه‌سازی) ویدیو.

مقادیر ممکن:

  • video/mp4

    فرمت ویدیویی MP4

  • video/mpeg

    فرمت ویدیویی MPEG

  • video/mpg

    فرمت ویدیویی MPG

  • video/mov

    فرمت ویدیویی MOV

  • video/avi

    فرمت ویدیویی AVI

  • video/x-flv

    فرمت ویدیویی FLV

  • video/webm

    فرمت ویدیویی وب‌ام

  • video/wmv

    فرمت ویدیویی WMV

  • video/3gpp

    فرمت ویدیویی 3GPP

پردازش MediaProcessing یا enum (رشته‌ای) (اختیاری)

چگونه مدل این ویدیو را برای درک پردازش می‌کند.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "video" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) ویدیو.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "model_output" تنظیم شود.

اندیشه گام

یک گام فکری.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

آرایه خلاصه (ThoughtSummaryContent) (اختیاری)

خلاصه‌ای از اندیشه.

انواع ممکن

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

ورد اینفو

حاشیه‌نویسی ASR در سطح کلمه برای خروجی رونویسی. متن کلمه، زمان‌بندی اختیاری و انتساب اختیاری گوینده را در خود جای می‌دهد.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته end_offset (اختیاری)

فاصله پایان کلمه نسبت به شروع فایل صوتی. وقتی timestamp_granularities شامل "word" باشد، نمایش داده می‌شود.

سیم بلندگو (اختیاری)

اختیاری. برچسب گوینده برای این کلمه (مثلاً "spk_1"، "spk_2"). وقتی diarization_mode در TranscriptionConfig تنظیم شده باشد، ارائه می‌شود.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته start_offset (اختیاری)

فاصله شروع کلمه نسبت به شروع فایل صوتی. وقتی timestamp_granularities شامل "word" باشد، نمایش داده می‌شود.

رشته متن (اختیاری)

کلمه رونویسی شده.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "word_info" تنظیم شود.

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "thought" تنظیم شود.

مرحله فراخوانی متن (UrlContextCallStep)

مرحله فراخوانی زمینه URL.

آرگومان‌های UrlContextCallArguments (الزامی)

آرگومان‌هایی که باید به متن URL ارسال شوند.

آرگومان‌هایی که باید به متن URL ارسال شوند.

فیلدها

آرایه آدرس‌های اینترنتی (رشته‌ای) (اختیاری)

آدرس‌های اینترنتی (URL) برای دریافت.

رشته شناسه (الزامی)

الزامی. یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_context_call" تنظیم شود.

مرحله نتیجه گیری UrlContext

مرحله نتیجه زمینه URL.

رشته call_id (الزامی)

الزامی. شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت داشته باشد.

is_error نوع داده بولی (اختیاری)

اینکه آیا زمینه URL منجر به خطا شده است یا خیر.

آرایه نتیجه (UrlContextResult) (الزامی)

الزامی. نتایج زمینه URL.

نتیجه‌ی زمینه‌ی URL.

فیلدها

شمارش وضعیت (رشته) (اختیاری)

وضعیت بازیابی URL.

مقادیر ممکن:

  • success

    بازیابی آدرس اینترنتی (URL) با موفقیت انجام شد.

  • error

    بازیابی آدرس اینترنتی (URL) به دلیل خطا با شکست مواجه شد.

  • paywall

    بازیابی آدرس اینترنتی (URL) ناموفق است زیرا محتوا پشت دیوار پرداخت (paywall) قرار دارد.

  • unsafe

    بازیابی آدرس اینترنتی (URL) به دلیل ناامن بودن محتوا با شکست مواجه شد.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL) که دریافت شده است.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_context_result" تنظیم شود.

مرحله ورودی کاربر

ورودی ارائه شده توسط کاربر.

آرایه محتوا (محتوا) (اختیاری)

هیچ توضیحی ارائه نشده است.

محتوای پاسخ.

انواع ممکن

محتوای صوتی

یک بلوک محتوای صوتی.

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای سند

یک بلوک محتوای سند.

رشته داده (اختیاری)

محتوای سند.

mime_type enum (رشته) (اختیاری)

نوع MIME سند.

مقادیر ممکن:

  • application/pdf

    فرمت سند PDF

  • text/csv

    فرمت سند CSV

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "document" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) سند.

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

ورد اینفو

حاشیه‌نویسی ASR در سطح کلمه برای خروجی رونویسی. متن کلمه، زمان‌بندی اختیاری و انتساب اختیاری گوینده را در خود جای می‌دهد.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته end_offset (اختیاری)

فاصله پایان کلمه نسبت به شروع فایل صوتی. وقتی timestamp_granularities شامل "word" باشد، نمایش داده می‌شود.

سیم بلندگو (اختیاری)

اختیاری. برچسب گوینده برای این کلمه (مثلاً "spk_1"، "spk_2"). وقتی diarization_mode در TranscriptionConfig تنظیم شده باشد، ارائه می‌شود.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته start_offset (اختیاری)

فاصله شروع کلمه نسبت به شروع فایل صوتی. وقتی timestamp_granularities شامل "word" باشد، نمایش داده می‌شود.

رشته متن (اختیاری)

کلمه رونویسی شده.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "word_info" تنظیم شود.

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

محتوای ویدیویی

یک بلوک محتوای ویدیویی.

رشته داده (اختیاری)

محتوای ویدیویی.

mime_type enum (رشته) (اختیاری)

نوع میم (شبیه‌سازی) ویدیو.

مقادیر ممکن:

  • video/mp4

    فرمت ویدیویی MP4

  • video/mpeg

    فرمت ویدیویی MPEG

  • video/mpg

    فرمت ویدیویی MPG

  • video/mov

    فرمت ویدیویی MOV

  • video/avi

    فرمت ویدیویی AVI

  • video/x-flv

    فرمت ویدیویی FLV

  • video/webm

    فرمت ویدیویی وب‌ام

  • video/wmv

    فرمت ویدیویی WMV

  • video/3gpp

    فرمت ویدیویی 3GPP

پردازش MediaProcessing یا enum (رشته‌ای) (اختیاری)

چگونه مدل این ویدیو را برای درک پردازش می‌کند.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "video" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) ویدیو.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "user_input" تنظیم شود.

رشته system_instruction (اختیاری)

دستورالعمل سیستم برای تعامل.

آرایه ابزارها (ابزار) (اختیاری)

فهرستی از اعلان‌های ابزار که مدل ممکن است در طول تعامل فراخوانی کند.

ابزاری که می‌تواند توسط مدل مورد استفاده قرار گیرد.

انواع ممکن

اجرای کد

ابزاری که می‌تواند توسط مدل برای اجرای کد استفاده شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution" تنظیم شود.

استفاده از کامپیوتر

ابزاری که می‌تواند توسط مدل برای تعامل با کامپیوتر استفاده شود.

آرایه disabled_safety_policies (enum (string)) (اختیاری)

اختیاری. سیاست‌های ایمنی معلولین برای استفاده از کامپیوتر.

مقادیر ممکن:

  • financial_transactions

    سیاست ایمنی برای تراکنش‌های مالی

  • sensitive_data_modification

    سیاست ایمنی برای اصلاح داده‌های حساس.

  • communication_tool

    سیاست ایمنی برای ابزارهای ارتباطی (مانند Gmail، Chat، Meet).

  • account_creation

    سیاست ایمنی برای ایجاد حساب کاربری.

  • data_modification

    سیاست ایمنی برای اصلاح داده‌ها.

  • user_consent_management

    سیاست ایمنی برای مدیریت رضایت کاربر.

  • legal_terms_and_agreements

    سیاست ایمنی برای شرایط و توافق‌نامه‌های قانونی.

enable_prompt_injection_detection مقدار بولی (اختیاری)

آیا بررسی تشخیص تزریق سریع در صورت درخواست استفاده از رایانه فعال است یا خیر.

enum محیطی (رشته‌ای) (اختیاری)

محیطی که در حال اجرا است.

مقادیر ممکن:

  • browser

    در یک مرورگر وب کار می‌کند.

  • mobile

    در محیط موبایل کار می‌کند.

  • desktop

    در محیط دسکتاپ کار می‌کند.

آرایه exclude_predefined_functions (رشته) (اختیاری)

فهرست توابع از پیش تعریف شده‌ای که از فراخوانی مدل مستثنی شده‌اند.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "computer_use" تنظیم شود.

جستجوی فایل

ابزاری که می‌تواند توسط مدل برای جستجوی فایل‌ها استفاده شود.

آرایه file_search_store_names (رشته‌ای) (اختیاری)

جستجوی فایل، نام‌های فروشگاه را برای جستجو ذخیره می‌کند.

رشته metadata_filter (اختیاری)

فیلتر فراداده برای اعمال روی اسناد و تکه‌های بازیابی معنایی.

عدد صحیح top_k (اختیاری)

تعداد تکه‌های بازیابی معنایی که باید بازیابی شوند.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_search" تنظیم شود.

عملکرد

ابزاری که می‌تواند توسط مدل مورد استفاده قرار گیرد.

رشته توضیحات (اختیاری)

شرحی از تابع.

رشته نام (اختیاری)

نام تابع.

پارامتر شیء (اختیاری)

طرحواره JSON برای پارامترهای تابع.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "function" تنظیم شود.

گوگل مپ

ابزاری که می‌تواند توسط مدل برای فراخوانی نقشه‌های گوگل استفاده شود.

enable_widget بولی (اختیاری)

اینکه آیا در نتیجه فراخوانی ابزار، توکن زمینه ویجت برگردانده شود یا خیر.

شماره عرض جغرافیایی (اختیاری)

عرض جغرافیایی محل کاربر.

شماره طول جغرافیایی (اختیاری)

طول جغرافیایی موقعیت مکانی کاربر.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_maps" تنظیم شود.

جستجوی گوگل

ابزاری که می‌تواند توسط مدل برای جستجو در گوگل استفاده شود.

آرایه search_types (enum (رشته)) (اختیاری)

انواع زمینه‌سازی جستجو برای فعال‌سازی.

مقادیر ممکن:

  • web_search

    تنظیم این فیلد، جستجوی وب را فعال می‌کند. فقط نتایج متنی برگردانده می‌شوند.

  • image_search

    تنظیم این فیلد، جستجوی تصویر را فعال می‌کند. بایت‌های تصویر برگردانده می‌شوند.

  • enterprise_web_search

    تنظیم این فیلد، جستجوی وب سازمانی را فعال می‌کند.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_search" تنظیم شود.

مک‌پ‌سرور

MCPServer سروری است که می‌تواند توسط مدل برای انجام اقدامات فراخوانی شود.

آرایه allowed_tools (AllowedTools) (اختیاری)

ابزارهای مجاز.

پیکربندی ابزارهای مجاز.

فیلدها

حالت شمارشی (رشته) (اختیاری)

حالت انتخاب ابزار.

مقادیر ممکن:

  • auto

    انتخاب خودکار ابزار.

  • any

    هر انتخاب ابزاری.

  • none

    بدون انتخاب ابزار.

  • validated

    انتخاب ابزار معتبر.

آرایه ابزار (رشته) (اختیاری)

نام ابزارهای مجاز

شیء هدر (اختیاری)

اختیاری: در صورت نیاز، فیلدهایی برای هدرهای احراز هویت، زمان‌های انقضا و غیره.

رشته نام (اختیاری)

نام سرور MCP.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "mcp_server" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس کامل URL برای نقطه پایانی MCPServer. مثال: "https://api.example.com/mcp"

بازیابی

ابزاری که می‌تواند توسط مدل برای بازیابی فایل‌ها استفاده شود.

exa_ai_search_config پیکربندی ExaAISearchConfig (اختیاری)

برای مشخص کردن پیکربندی ExaAISearch استفاده می‌شود.

برای مشخص کردن پیکربندی ExaAISearch استفاده می‌شود.

فیلدها

رشته api_key (اختیاری)

الزامی. کلید API برای ExaAiSearch.

شیء custom_config (اختیاری)

اختیاری. این فیلد می‌تواند برای ارسال هر پارامتری از API جستجوی Exa.ai استفاده شود.

parallel_ai_search_config پیکربندی ParallelAISearchConfig (اختیاری)

برای مشخص کردن پیکربندی ParallelAISearch استفاده می‌شود.

برای مشخص کردن پیکربندی ParallelAISearch استفاده می‌شود.

فیلدها

رشته api_key (اختیاری)

اختیاری. کلید API برای ParallelAiSearch.

شیء custom_config (اختیاری)

اختیاری. پیکربندی‌های سفارشی برای ParallelAiSearch.

پیکربندی فروشگاه rag_store (اختیاری)

برای تعیین پیکربندی RagStore استفاده می‌شود.

برای مشخص کردن پیکربندی فروشگاه RAG استفاده کنید.

فیلدها

آرایه rag_resources (RagResource) (اختیاری)

اختیاری. نمایش منبع rag.

تعریف منبع Rag.

فیلدها

رشته rag_corpus (اختیاری)

اختیاری. نام منبع RagCorpora.

آرایه rag_file_ids (رشته‌ای) (اختیاری)

اختیاری. rag_file_id. فایل‌ها باید در همان مجموعه rag_corpus در فیلد rag_corpus باشند.

پیکربندی بازیابی رگ (اختیاری)

اختیاری. پیکربندی بازیابی برای کوئری Rag.

پیکربندی بازیابی زمینه را مشخص می‌کند.

فیلدها

فیلتر فیلتر (اختیاری)

اختیاری. پیکربندی برای فیلترها.

پیکربندی برای فیلترها

فیلدها

رشته metadata_filter (اختیاری)

اختیاری. رشته‌ای برای فیلتر کردن فراداده.

عدد آستانه_فاصله_بردار (اختیاری)

اختیاری. فقط زمینه‌هایی را برمی‌گرداند که فاصله برداری آنها کوچکتر از آستانه باشد.

عدد آستانه‌ی شباهت بردار (اختیاری)

اختیاری. فقط زمینه‌هایی را برمی‌گرداند که شباهت برداری آنها بزرگتر از آستانه باشد.

جستجوی ترکیبی ( اختیاری)

اختیاری. پیکربندی برای جستجوی ترکیبی.

پیکربندی برای جستجوی ترکیبی.

فیلدها

عدد آلفا (اختیاری)

اختیاری. مقدار آلفا وزن بین نتایج جستجوی بردار متراکم و پراکنده را کنترل می‌کند.

رتبه‌بندی رتبه‌بندی (اختیاری)

اختیاری. پیکربندی برای رتبه‌بندی و تغییر رتبه.

پیکربندی برای رتبه‌بندی و تغییر رتبه‌بندی.

عدد صحیح top_k (اختیاری)

اختیاری. تعداد زمینه‌هایی که باید بازیابی شوند.

آرایه retrieval_types (enum (string)) (اختیاری)

انواع بازیابی فایل برای فعال کردن.

مقادیر ممکن:

  • rag_store
  • exa_ai_search
  • parallel_ai_search
نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "retrieval" تنظیم شود.

متن آدرس

ابزاری که می‌تواند توسط مدل برای دریافت متن URL استفاده شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_context" تنظیم شود.

رشته به‌روزرسانی‌شده (اختیاری)

فقط خروجی. زمانی که پاسخ آخرین بار در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) به‌روزرسانی شده است.

کاربرد (اختیاری )

فقط خروجی. آمار مربوط به میزان استفاده از توکن درخواست تعامل.

آمار مربوط به میزان استفاده از توکن درخواست تعامل.

فیلدها

آرایه cached_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک میزان استفاده از توکن‌های ذخیره‌شده بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه grounding_tool_count (GroundingToolCount) (اختیاری)

تعداد ابزار اتصال به زمین

تعداد ابزار اتصال به زمین مهم است.

فیلدها

شمارش عدد صحیح (اختیاری)

تعداد ابزار اتصال به زمین مهم است.

نوع enum (رشته) (اختیاری)

نوع ابزار اتصال زمین مرتبط با شمارش.

مقادیر ممکن:

  • google_search

    اتصال به زمین با جستجوی وب و جستجوی تصویر گوگل، و اتصال به زمین وب برای سازمان‌ها.

  • google_maps

    اتصال به زمین با نقشه‌های گوگل.

  • retrieval

    پایه گذاری با داده های مشتری، به عنوان مثال، VertexAISearch.

آرایه input_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک استفاده از توکن ورودی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه output_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک استفاده از توکن خروجی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه tool_use_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک میزان استفاده از توکن‌های ابزار بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

عدد صحیح total_cached_tokens (اختیاری)

تعداد توکن‌ها در بخش ذخیره‌شده‌ی اعلان (محتوای ذخیره‌شده).

عدد صحیح total_input_tokens (اختیاری)

تعداد توکن‌ها در اعلان (زمینه).

total_output_tokens عدد صحیح (اختیاری)

تعداد کل توکن‌ها در تمام پاسخ‌های تولید شده.

total_thought_tokens عدد صحیح (اختیاری)

تعداد توکن‌های افکار برای مدل‌های تفکر.

عدد صحیح total_tokens (اختیاری)

تعداد کل توکن‌ها برای درخواست تعامل (درخواست + پاسخ‌ها + سایر توکن‌های داخلی).

عدد صحیح total_tool_use_tokens (اختیاری)

تعداد توکن‌های موجود در اعلان(های) استفاده از ابزار.

webhook_config پیکربندی وب هوک (اختیاری)

اختیاری. پیکربندی وب‌هوک برای دریافت اعلان‌ها پس از اتمام تعامل.

پیام مربوط به پیکربندی رویدادهای وب‌هوک برای یک درخواست.

فیلدها

آرایه uris (رشته) (اختیاری)

اختیاری. در صورت تنظیم، این URLهای وب‌هوک به جای وب‌هوک‌های ثبت‌شده، برای رویدادهای وب‌هوک استفاده خواهند شد.

شیء user_metadata (اختیاری)

اختیاری. فراداده کاربر که در هر انتشار رویداد به وب‌هوک‌ها بازگردانده می‌شود.

رشته‌ی last_pause_time (اختیاری)

فقط خروجی. زمانی که ماشه آخرین بار متوقف شده است.

رشته‌ی last_resume_time (اختیاری)

فقط خروجی. زمانی که آخرین بار تریگر از سر گرفته شده است.

رشته‌ی last_run_time (اختیاری)

فقط خروجی. زمان آخرین اجرای تریگر.

عدد صحیح max_consecutive_failures (اختیاری)

اختیاری. حداکثر تعداد خطاهای متوالی مجاز قبل از اینکه تریگر به طور خودکار متوقف شود (وضعیت به ERROR تبدیل شود).

رشته‌ی زمان اجرای بعدی (اختیاری)

فقط خروجی. زمانی که قرار است تریگر در مرحله بعد اجرا شود.

رشته‌ی previous_interaction_id (اختیاری)

فقط خروجی. شناسه آخرین تعامل ایجاد شده توسط این تریگر.

رشته زمانبندی (اختیاری)

الزامی. برنامه زمانی cron که trigger باید روی آن اجرا شود. قالب استاندارد cron.

شمارش وضعیت (رشته) (اختیاری)

فقط خروجی. وضعیت فعلی تریگر.

مقادیر ممکن:

  • active

    ماشه فعال است و طبق برنامه شلیک خواهد کرد.

  • paused

    ماشه متوقف شده و شلیک نمی‌کند.

  • error

    تریگر به دلیل خرابی‌های متوالی وارد حالت خطا شده است.

رشته منطقه زمانی (اختیاری)

الزامی. منطقه زمانی که برنامه باید در آن تفسیر شود.

رشته‌ی update_time (اختیاری)

فقط خروجی. زمان آخرین به‌روزرسانی تریگر.

مثال

پاسخ نمونه 

{
  "consecutive_failure_count": 0,
  "create_time": "string",
  "display_name": "string",
  "environment_id": "string",
  "execution_timeout_seconds": 0,
  "id": "string",
  "interaction": {
    "created": "2025-12-04T15:01:45Z",
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3.6-flash",
    "object": "interaction",
    "status": "completed",
    "steps": [
      {
        "type": "model_output",
        "content": [
          {
            "type": "text",
            "text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?"
          }
        ]
      }
    ],
    "updated": "2025-12-04T15:01:45Z",
    "usage": {
      "input_tokens_by_modality": [
        {
          "modality": "text",
          "tokens": 7
        }
      ],
      "total_cached_tokens": 0,
      "total_input_tokens": 7,
      "total_output_tokens": 23,
      "total_thought_tokens": 49,
      "total_tokens": 79,
      "total_tool_use_tokens": 0
    }
  },
  "last_pause_time": "string",
  "last_resume_time": "string",
  "last_run_time": "string",
  "max_consecutive_failures": 0,
  "next_run_time": "string",
  "previous_interaction_id": "string",
  "schedule": "string",
  "status": "active",
  "time_zone": "string",
  "update_time": "string"
}

اجراکننده

ارسال به آدرس https://generativelanguage.googleapis.com/v1beta/triggers/{trigger_id}/executions

بلافاصله یک تریگر اجرا می‌کند.

پاسخ

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

رشته‌ی زمان پایان (اختیاری)

فقط خروجی. زمان پایان اجرا.

رشته‌ی environment_id (اختیاری)

فقط خروجی. شناسه محیطی که برای اجرا استفاده شده است.

رشته خطا (اختیاری)

فقط خروجی. پیام خطا در صورت عدم موفقیت در اجرا.

رشته شناسه (اختیاری)

الزامی. فقط خروجی. شناسه. شناسه اجرای تریگر.

رشته‌ی interaction_id (اختیاری)

فقط خروجی. شناسه‌ی تعامل ایجاد شده توسط این اجرا، در صورت وجود.

رشته زمان‌بندی‌شده (اختیاری)

فقط خروجی. زمانی که قرار بود اجرا انجام شود.

رشته‌ی زمان شروع (اختیاری)

فقط خروجی. زمان شروع اجرا.

شمارش وضعیت (رشته) (اختیاری)

فقط خروجی. وضعیت اجرا.

مقادیر ممکن:

  • in_progress

    اجرای حکم در حال حاضر در حال انجام است.

  • completed

    اجرا با موفقیت به پایان رسید.

  • failed

    اعدام شکست خورد.

  • skipped

    از اجرا صرف نظر شد (مثلاً، اجرای قبلی هنوز در حال اجرا است).

  • timed_out

    زمان اجرا به پایان رسید.

رشته trigger_id (اختیاری)

الزامی. فقط خروجی. شناسه. شناسه‌ی تریگری که این اجرا را ایجاد کرده است.

مثال

پاسخ نمونه 

{
  "end_time": "string",
  "environment_id": "string",
  "error": "string",
  "id": "string",
  "interaction_id": "string",
  "scheduled_time": "string",
  "start_time": "string",
  "status": "in_progress",
  "trigger_id": "string"
}

لیست تریگرها

دریافت https://generativelanguage.googleapis.com/v1beta/triggers

محرک‌های یک پروژه را فهرست می‌کند.

پارامترهای مسیر/پرس‌وجو

رشته فیلتر (اختیاری)

اختیاری. عبارت را فیلتر کنید (مثلاً بر اساس حالت).

عدد صحیح page_size (اختیاری)

اختیاری. حداکثر تعداد triggerهایی که در هر صفحه برگردانده می‌شوند.

رشته‌ی page_token (اختیاری)

اختیاری. یک توکن صفحه از فراخوانی قبلی ListTriggers.

پاسخ

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

رشته‌ی next_page_token (اختیاری)

یک توکن صفحه، که از فراخوانی قبلی `ListTriggers` دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید.

آرایه تریگرها ( Trigger ) (اختیاری)

فهرست محرک‌ها.

مثال

پاسخ نمونه 

{
  "next_page_token": "string",
  "triggers": [
    {
      "consecutive_failure_count": 0,
      "create_time": "string",
      "display_name": "string",
      "environment_id": "string",
      "execution_timeout_seconds": 0,
      "id": "string",
      "interaction": {
        "created": "2025-12-04T15:01:45Z",
        "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
        "model": "gemini-3.6-flash",
        "object": "interaction",
        "status": "completed",
        "steps": [
          {
            "type": "model_output",
            "content": [
              {
                "type": "text",
                "text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?"
              }
            ]
          }
        ],
        "updated": "2025-12-04T15:01:45Z",
        "usage": {
          "input_tokens_by_modality": [
            {
              "modality": "text",
              "tokens": 7
            }
          ],
          "total_cached_tokens": 0,
          "total_input_tokens": 7,
          "total_output_tokens": 23,
          "total_thought_tokens": 49,
          "total_tokens": 79,
          "total_tool_use_tokens": 0
        }
      },
      "last_pause_time": "string",
      "last_resume_time": "string",
      "last_run_time": "string",
      "max_consecutive_failures": 0,
      "next_run_time": "string",
      "previous_interaction_id": "string",
      "schedule": "string",
      "status": "active",
      "time_zone": "string",
      "update_time": "string"
    }
  ]
}

دریافت تریگر

دریافت کنید https://generativelanguage.googleapis.com/v1beta/triggers/{id}

جزئیات یک تریگر واحد را دریافت می‌کند.

پاسخ

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

عدد صحیح sequential_failure_count (اختیاری)

فقط خروجی. تعداد شکست‌های متوالی که از آخرین اجرای موفق رخ داده‌اند.

رشته‌ی create_time (اختیاری)

فقط خروجی. زمانی که تریگر ایجاد شده است.

رشته‌ی display_name (اختیاری)

اختیاری. نام نمایشی تریگر.

رشته‌ی environment_id (اختیاری)

اختیاری. شناسه محیط برای اجرای تریگر.

عدد صحیح execution_timeout_seconds (اختیاری)

اختیاری. زمان اجرای تعامل فعال‌شده.

رشته شناسه (اختیاری)

الزامی. فقط خروجی. شناسه. شناسه‌ی تریگر.

تعامل تعامل (اختیاری)

الزامی. الگوی درخواست تعاملی که باید اجرا شود.

منبع تعامل.

فیلدها

گزینه عامل (اختیاری)

نام «عامل» مورد استفاده برای ایجاد تعامل.

عاملی که باید با آن تعامل داشت.

مقادیر ممکن

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

    نماینده تحقیقات عمیق جمینی

  • deep-research-preview-04-2026

    نماینده تحقیقات عمیق جمینی

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

    مامور مکس تحقیقات عمیق جمینی

  • antigravity-preview-05-2026

    از عامل مدیریت‌شده‌ی Antigravity برای انجام وظایف چند مرحله‌ای که نیاز به استدلال، عملیات فایل و استفاده از ابزار دارند، استفاده کنید.

شیء agent_config (اختیاری)

پارامترهای پیکربندی برای تعامل عامل.

انواع ممکن

تفکیک‌کننده چندریختی: type

پیکربندی عامل ضد جاذبه

پیکربندی برای زمان اجرای عامل Antigravity. کنترل سمت سرور بر محیط اجرای عامل و پیکربندی ابزار را فراهم می‌کند.

رشته‌ی max_total_tokens (اختیاری)

حداکثر مجموع توکن‌ها برای اجرای عامل.

رشته مدل (اختیاری)

مدلی که برای استدلال عامل استفاده می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "antigravity" تنظیم شود.

پیکربندی CodeMenderAgentConfig

پیکربندی برای عامل CodeMender.

درخواست_یافتن (اختیاری )

پارامترهایی برای یافتن آسیب‌پذیری‌ها

پارامترهای درخواست مختص جلسات FIND، که برای کشف آسیب‌پذیری‌ها در یک پایگاه کد استفاده می‌شوند.

فیلدها

رشته توضیحات (اختیاری)

دستورالعمل‌های زمینه‌ای یا سفارشی اضافی که توسط کاربر برای هدایت تحلیل آسیب‌پذیری ارائه می‌شود.

رشته find_id (اختیاری)

شناسه‌ی یک یافته‌ی خاص برای تأیید. این مورد عمدتاً در حالت VERIFY برای تمرکز اعتبارسنجی مبتنی بر اجرای عامل بر روی یک آسیب‌پذیری واحد استفاده می‌شود.

حالت شمارشی (رشته) (اختیاری)

نحوه‌ی جلسه‌ی یافتن.

مقادیر ممکن:

  • scan

    اسکن سریع فقط با استفاده از طبقه‌بندی‌کننده اولیه.

  • verify

    طبقه‌بندی را انجام می‌دهد و به دنبال آن بررسی دقیقی انجام می‌دهد.

آرایه source_files (محتوای فایل) (اختیاری)

فهرستی از فایل‌های منبع که به عنوان زمینه برای اسکن ارائه می‌شوند.

محتوای یک فایل واحد در کدبیس.

فیلدها

رشته محتوا (اختیاری)

محتوای متنی فایل که با استاندارد UTF-8 کدگذاری شده است.

رشته مسیر (اختیاری)

مسیر نسبی فایل از ریشه پروژه.

درخواست رفع مشکل (اختیاری)

پارامترهای رفع آسیب‌پذیری‌ها

پارامترهای مخصوص جلسات FIX را درخواست کنید، که برای تولید و اعتبارسنجی وصله‌های امنیتی استفاده می‌شوند.

فیلدها

رشته توضیحات (اختیاری)

دستورالعمل‌های زمینه‌ای یا سفارشی اضافی که توسط کاربر برای هدایت فرآیند تولید پچ ارائه می‌شود.

رشته find_id (اختیاری)

شناسه‌ی یافته‌ی امنیتی خاصی که باید اصلاح شود. این شناسه به یک آسیب‌پذیری کشف‌شده‌ی قبلی اشاره دارد.

آرایه source_files (محتوای فایل) (اختیاری)

فهرستی از فایل‌های منبع که زمینه را برای اصلاح فراهم می‌کنند. این فایل‌ها معمولاً فایل‌هایی هستند که حاوی آسیب‌پذیری شناسایی‌شده هستند.

محتوای یک فایل واحد در کدبیس.

فیلدها

رشته محتوا (اختیاری)

محتوای متنی فایل که با استاندارد UTF-8 کدگذاری شده است.

رشته مسیر (اختیاری)

مسیر نسبی فایل از ریشه پروژه.

رشته مدل (اختیاری)

نام مدلی که برای عامل CodeMender استفاده می‌شود. در هر جلسه CodeMender فقط از یک مدل استفاده خواهد شد.

session_config پیکربندی جلسه (اختیاری)

پیکربندی‌های اختیاری مختص جلسه برای لغو رفتار پیش‌فرض عامل.

پیکربندی جلسات CodeMender.

فیلدها

عدد صحیح max_rounds (اختیاری)

حداکثر تعداد دورهای تعاملی که عامل مجاز است قبل از رسیدن به مهلت زمانی مشخص شده انجام دهد.

رشته session_id (اختیاری)

پارامتری برای گروه‌بندی چندین تعامل که متعلق به یک جلسه CodeMender هستند.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code-mender" تنظیم شود.

پیکربندی DeepResearchAgent

پیکربندی برای عامل تحقیقات عمیق.

نوع بولی collaboration_planning (اختیاری)

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.

enable_bigquery_tool boolean (optional)

Enables bigquery tool for the Deep Research agent.

خلاصه‌های تفکر ( اختیاری)

اینکه آیا خلاصه نظرات در پاسخ گنجانده شود یا خیر.

مقادیر ممکن

  • auto

    خلاصه‌های تفکر خودکار

  • none

    بدون خلاصه نویسی فکری.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "deep-research" .

visualization enum (string) (optional)

Whether to include visualizations in the response.

مقادیر ممکن:

  • off

    Do not include visualizations.

  • auto

    Automatically include visualizations.

DynamicAgentConfig

پیکربندی برای عامل‌های پویا

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "dynamic" تنظیم شود.

رشته ایجاد شده (اختیاری)

فقط خروجی. زمانی که پاسخ در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) ایجاد شده است.

environment EnvironmentConfig or string (optional)

The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.

Configuration for a custom environment.

فیلدها

environment_id string (optional)

Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.

network EnvironmentNetworkEgressAllowlist or enum (string) (optional)

Network configuration for the environment.

Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.

انواع ممکن

شیء

Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.

allowlist array (AllowlistEntry) (optional)

List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.

A single domain allowlist rule with optional header injection.

فیلدها

domain string (optional)

Domain to allow outbound requests to. Supports wildcards (eg '*.googleapis.com'). Use '*' to allow all domains.

transform array (object) or object (optional)

Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.

رشته

Turns all network off.

مقادیر ممکن

  • disabled

    Turns all network off.

sources array (Source) (optional)

هیچ توضیحی ارائه نشده است.

A source to be mounted into the environment.

فیلدها

content string (optional)

The inline content if `type` is `INLINE`.

encoding string (optional)

Optional encoding for inline content (eg `base64`).

رشته منبع (اختیاری)

The source of the environment. For Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path.

target string (optional)

Where the source should appear in the environment.

نوع enum (رشته) (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • gcs

    A Cloud Storage bucket.

  • inline

    Inline content.

  • repository

    A generic repository. The protocol prefix in the source URL identifies the provider (eg, github://, gcs://).

  • skill_registry

    A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

Always set to "remote" .

environment_id string (optional)

Output only. The environment ID for the interaction. Only populated if environment config is set in the request.

آرایه خطاها (Error) (اختیاری)

فقط خروجی. خطاهای تشخیصی / خطاهای پلتفرم که در تعامل ثبت شده‌اند.

پیام خطا از یک تعامل.

فیلدها

رشته کد (اختیاری)

یک URI که نوع خطا را مشخص می‌کند.

رشته پیام (اختیاری)

یک پیام خطا که برای انسان قابل خواندن باشد.

رشته شناسه (اختیاری)

الزامی. فقط خروجی. یک شناسه منحصر به فرد برای تکمیل تعامل.

پیش‌فرض‌ها به:

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

ورودی برای تعامل.

شیء برچسب‌ها (اختیاری)

برچسب‌هایی با فراداده‌های تعریف‌شده توسط کاربر برای درخواست.

مدل ModelOption (اختیاری)

نام «مدل» مورد استفاده برای تولید تعامل.

مدلی که اعلان شما را تکمیل می‌کند.\n\nبرای جزئیات بیشتر به [models](https://ai.google.dev/gemini-api/docs/models) مراجعه کنید.

مقادیر ممکن

  • gemini-2.5-flash

    اولین مدل استدلال ترکیبی ما که از یک پنجره زمینه ۱ میلیون توکنی پشتیبانی می‌کند و دارای بودجه‌های تفکر است.

  • gemini-2.5-pro

    Our state-of-the-art multipurpose model, which excels at coding and complex reasoning tasks.

  • gemma-4-26b-a4b-it

    Gemma 4 26B A4B IT

  • gemma-4-31b-it

    Gemma 4 31B IT

  • gemini-flash-latest

    Latest release of Gemini Flash

  • gemini-flash-lite-latest

    Latest release of Gemini Flash-Lite

  • gemini-pro-latest

    Latest release of Gemini Pro

  • gemini-2.5-flash-lite

    کوچکترین و مقرون به صرفه ترین مدل ما، ساخته شده برای استفاده در مقیاس بزرگ.

  • gemini-2.5-flash-image

    مدل تولید تصویر بومی ما، که برای سرعت، انعطاف‌پذیری و درک متنی بهینه شده است. ورودی و خروجی متن با همان قیمت ۲.۵ فلش ارائه می‌شود.

  • gemini-3-flash-preview

    هوشمندترین مدل ما که برای سرعت ساخته شده است، هوش مرزی را با جستجو و ردیابی برتر ترکیب می‌کند.

  • gemini-3.1-pro-preview

    Our latest SOTA reasoning model with unprecedented depth and nuance, and powerful multimodal understanding and coding capabilities.

  • gemini-3.1-pro-preview-customtools

    Gemini 3.1 Pro Preview optimized for custom tool usage

  • gemini-3.1-flash-lite

    مقرون‌به‌صرفه‌ترین مدل ما، بهینه‌شده برای وظایف عامل‌محور با حجم بالا، ترجمه و پردازش داده‌های ساده.

  • gemini-3-pro-image

    Gemini 3 Pro Image

  • nano-banana-pro-preview

    Gemini 3 Pro Image Preview

  • gemini-3.1-flash-image

    Gemini 3.1 Flash Image.

  • gemini-3.5-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • gemini-3.6-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • gemini-3.7-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • lyria-3-clip-preview

    Our low-latency, music generation model optimized for high-fidelity audio clips and precise rhythmic control.

  • lyria-3-pro-preview

    Our advanced, full-song generative model with deep compositional understanding, optimized for precise structural control and complex transitions across diverse musical styles.

  • gemini-robotics-er-1.6-preview

    Gemini Robotics-ER 1.6 Preview

  • gemini-robotics-er-2-preview

    Gemini Robotics Embodied Reasoning 2 Preview

محتوای صوتی output_audio (اختیاری)

آخرین صدای تولید شده توسط مدل در پاسخ به درخواست فعلی. توجه: این توسط SDK اضافه شده است.

یک بلوک محتوای صوتی.

فیلدها

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای تصویر خروجی (اختیاری)

آخرین تصویری که توسط مدل در پاسخ به درخواست فعلی تولید شده است. توجه: این تصویر توسط SDK اضافه شده است.

یک بلوک محتوای تصویر.

فیلدها

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

رشته‌ی output_text (اختیاری)

متن به هم پیوسته از آخرین خروجی مدل در پاسخ به درخواست فعلی. توجه: این توسط SDK اضافه شده است.

output_video VideoContent (optional)

The last video generated by the model in response to the current request. Note: this is added by the SDK.

A video content block.

فیلدها

رشته داده (اختیاری)

The video content.

mime_type enum (رشته) (اختیاری)

The mime type of the video.

مقادیر ممکن:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

processing MediaProcessing or enum (string) (optional)

How the model processes this video for understanding.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

رشته uri (اختیاری)

The URI of the video.

رشته‌ی previous_interaction_id (اختیاری)

شناسه‌ی تعامل قبلی، در صورت وجود.

response_format ResponseFormat or array (ResponseFormat) (optional)

تأکید می‌کند که پاسخ تولید شده یک شیء JSON است که با طرحواره JSON مشخص شده در این فیلد مطابقت دارد.

انواع ممکن

AudioResponseFormat

Configuration for audio output format.

bit_rate integer (optional)

Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).

delivery enum (string) (optional)

The delivery mode for the audio output.

مقادیر ممکن:

  • inline

    Audio data is returned inline in the response.

  • uri

    Audio data is returned as a URI.

mime_type enum (رشته) (اختیاری)

The MIME type of the audio output.

مقادیر ممکن:

  • audio/mp3

    MP3 audio format.

  • audio/ogg_opus

    OGG Opus audio format.

  • audio/l16

    Raw PCM (L16) audio format.

  • audio/wav

    WAV audio format.

  • audio/alaw

    A-law audio format.

  • audio/mulaw

    Mu-law audio format.

عدد صحیح sample_rate (اختیاری)

Sample rate in Hz.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

ImageResponseFormat

Configuration for image output format.

aspect_ratio enum (string) (optional)

The aspect ratio for the image output.

مقادیر ممکن:

  • 1:1

    نسبت تصویر ۱:۱.

  • 2:3

    2:3 aspect ratio.

  • 3:2

    3:2 aspect ratio.

  • 3:4

    3:4 aspect ratio.

  • 4:3

    نسبت تصویر ۴:۳.

  • 4:5

    4:5 aspect ratio.

  • 5:4

    5:4 aspect ratio.

  • 9:16

    نسبت تصویر ۹:۱۶

  • 16:9

    نسبت تصویر ۱۶:۹.

  • 21:9

    21:9 aspect ratio.

  • 1:8

    1:8 aspect ratio.

  • 8:1

    8:1 aspect ratio.

  • 1:4

    1:4 aspect ratio.

  • 4:1

    4:1 aspect ratio.

delivery enum (string) (optional)

The delivery mode for the image output.

مقادیر ممکن:

  • inline

    Image data is returned inline in the response.

  • uri

    Image data is returned as a URI.

image_size enum (string) (optional)

The size of the image output.

مقادیر ممکن:

  • 512

    512px image size.

  • 1K

    1K image size.

  • 2K

    2K image size.

  • 4K

    4K image size.

mime_type enum (رشته) (اختیاری)

The MIME type of the image output.

مقادیر ممکن:

  • image/jpeg

    JPEG image format.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

TextResponseFormat

Configuration for text output format.

mime_type enum (رشته) (اختیاری)

The MIME type of the text output.

مقادیر ممکن:

  • application/json

    JSON output format.

  • text/plain

    Plain text output format.

schema object (optional)

The JSON schema that the output should conform to. Only applicable when mime_type is application/json.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

VideoResponseFormat

Configuration for video output format.

aspect_ratio enum (string) (optional)

The aspect ratio for the video output.

مقادیر ممکن:

  • 16:9

    نسبت تصویر ۱۶:۹.

  • 9:16

    نسبت تصویر ۹:۱۶

delivery enum (string) (optional)

The delivery mode for the video output.

مقادیر ممکن:

  • inline

    Video data is returned inline in the response.

  • uri

    Video data is returned as a URI.

duration string (optional)

The duration for the video output.

gcs_uri string (optional)

The Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.

resolution enum (string) (optional)

The video output resolution. Defaults to 720p.

مقادیر ممکن:

  • 360p

    360p resolution.

  • 720p

    720p resolution.

  • 1080p

    1080p resolution.

  • 4k

    وضوح تصویر 4K.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

آرایه safety_settings (SafetySetting) (اختیاری)

تنظیمات ایمنی برای تعامل.

A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.

فیلدها

method enum (string) (optional)

Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.

مقادیر ممکن:

  • severity

    The harm block method uses both probability and severity scores.

  • probability

    The harm block method uses the probability score.

threshold enum (string) (optional)

Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.

مقادیر ممکن:

  • block_low_and_above

    Block content with a low harm probability or higher.

  • block_medium_and_above

    Block content with a medium harm probability or higher.

  • block_only_high

    Block content with a high harm probability.

  • block_none

    Do not block any content, regardless of its harm probability.

  • off

    Turn off the safety filter entirely.

type HarmCategory (optional)

Required. The type of harm category to be blocked.

مقادیر ممکن

  • hate_speech

    Content that promotes violence or incites hatred against individuals or groups based on certain attributes.

  • dangerous_content

    Content that promotes, facilitates, or enables dangerous activities.

  • harassment

    Abusive, threatening, or content intended to bully, torment, or ridicule.

  • sexually_explicit

    Content that contains sexually explicit material.

  • civic_integrity

    Deprecated: Election filter is not longer supported. The harm category is civic integrity.

  • image_hate

    Images that contain hate speech.

  • image_dangerous_content

    Images that contain dangerous content.

  • image_harassment

    Images that contain harassment.

  • image_sexually_explicit

    Images that contain sexually explicit content.

  • jailbreak

    Prompts designed to bypass safety filters.

service_tier ServiceTier (optional)

The service tier for the interaction.

مقادیر ممکن

  • flex

    Flex service tier.

  • standard

    Standard service tier.

  • priority

    Priority service tier.

  • deferred

    Deferred service tier.

شمارش وضعیت (رشته) (اختیاری)

الزامی. فقط خروجی. وضعیت تعامل.

مقادیر ممکن:

  • in_progress

    تعامل در حال انجام است.

  • requires_action

    این تعامل نیاز به اقدام/ورودی از سوی کاربر دارد.

  • completed

    تعامل تکمیل شده است.

  • failed

    تعامل شکست خورد.

  • cancelled

    تعامل لغو شد.

  • incomplete

    تعامل تکمیل شده است، اما شامل نتایج ناقص است (مثلاً رسیدن به max_tokens).

  • budget_exceeded

    The interaction was halted because the token budget was exceeded.

  • queued

    The interaction is queued, waiting for processing.

steps array (Step) (optional)

فقط خروجی. مراحلی که تعامل را تشکیل می‌دهند، زمانی که در پاسخ گنجانده شوند.

A step in the interaction.

انواع ممکن

CodeExecutionCallStep

Code execution call step.

arguments CodeExecutionCallStepArguments (required)

Required. The arguments to pass to the code execution.

آرگومان‌هایی که باید به اجرای کد ارسال شوند.

فیلدها

رشته کد (اختیاری)

کدی که قرار است اجرا شود.

شمارش زبان (رشته) (اختیاری)

زبان برنامه‌نویسی «کد».

مقادیر ممکن:

  • python

    پایتون >= 3.10، با numpy و simpy در دسترس است.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution_call" تنظیم شود.

CodeExecutionResultStep

Code execution result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the code execution resulted in an error.

رشته نتیجه (الزامی)

Required. The output of the code execution.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution_result" تنظیم شود.

FileSearchCallStep

File Search call step.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "file_search_call" .

FileSearchResultStep

File Search result step.

call_id string (required)

Required. ID to match the ID from the function call block.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "file_search_result" .

FunctionCallStep

A function tool call step.

arguments object (required)

Required. The arguments to pass to the function.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

name string (required)

Required. The name of the tool to call.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "function_call" .

FunctionResultStep

Result of a function tool call.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the tool call resulted in an error.

رشته نام (اختیاری)

The name of the tool that was called.

result array (ImageContent or TextContent) or object or string (required)

Required. The result of the tool call.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "function_result" .

GoogleMapsCallStep

Google Maps call step.

arguments GoogleMapsCallStepArguments (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

فیلدها

queries array (string) (optional)

The queries to be executed.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_maps_call" .

GoogleMapsResultStep

Google Maps result step.

call_id string (required)

Required. ID to match the ID from the function call block.

result array (GoogleMapsResultItem) (required)

هیچ توضیحی ارائه نشده است.

The result of the Google Maps.

فیلدها

places array (GoogleMapsResultPlaces) (optional)

هیچ توضیحی ارائه نشده است.

فیلدها

رشته نام (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته place_id (اختیاری)

هیچ توضیحی ارائه نشده است.

آرایه review_snippets (ReviewSnippet) (اختیاری)

هیچ توضیحی ارائه نشده است.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

رشته آدرس اینترنتی (اختیاری)

هیچ توضیحی ارائه نشده است.

widget_context_token string (optional)

هیچ توضیحی ارائه نشده است.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_maps_result" .

GoogleSearchCallStep

Google Search call step.

arguments GoogleSearchCallStepArguments (required)

Required. The arguments to pass to Google Search.

The arguments to pass to Google Search.

فیلدها

queries array (string) (optional)

Web search queries for the following-up web search.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

search_type enum (string) (optional)

The type of search grounding enabled.

مقادیر ممکن:

  • web_search

    تنظیم این فیلد، جستجوی وب را فعال می‌کند. فقط نتایج متنی برگردانده می‌شوند.

  • image_search

    تنظیم این فیلد، جستجوی تصویر را فعال می‌کند. بایت‌های تصویر برگردانده می‌شوند.

  • enterprise_web_search

    Setting this field enables enterprise web search.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_search_call" .

GoogleSearchResultStep

Google Search result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the Google Search resulted in an error.

result array (GoogleSearchResultItem) (required)

Required. The results of the Google Search.

The result of the Google Search.

فیلدها

search_suggestions string (optional)

Web content snippet that can be embedded in a web page or an app webview.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_search_result" .

McpServerToolCallStep

MCPServer tool call step.

arguments object (required)

Required. The JSON object of arguments for the function.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

name string (required)

Required. The name of the tool which was called.

server_name string (required)

Required. The name of the used MCP server.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "mcp_server_tool_call" .

McpServerToolResultStep

MCPServer tool result step.

call_id string (required)

Required. ID to match the ID from the function call block.

رشته نام (اختیاری)

Name of the tool which is called for this specific tool call.

result array (ImageContent or TextContent) or object or string (required)

Required. The output from the MCP server call. Can be simple text or rich content.

server_name string (optional)

The name of the used MCP server.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "mcp_server_tool_result" .

ModelOutputStep

Output generated by the model.

content array (Content) (optional)

هیچ توضیحی ارائه نشده است.

محتوای پاسخ.

انواع ممکن

محتوای صوتی

یک بلوک محتوای صوتی.

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای سند

یک بلوک محتوای سند.

رشته داده (اختیاری)

محتوای سند.

mime_type enum (رشته) (اختیاری)

نوع MIME سند.

مقادیر ممکن:

  • application/pdf

    فرمت سند PDF

  • text/csv

    فرمت سند CSV

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "document" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) سند.

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

end_offset string (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string (optional)

Optional. Speaker label for this word (eg "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

start_offset string (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string (optional)

The transcribed word.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "word_info" .

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

VideoContent

A video content block.

رشته داده (اختیاری)

The video content.

mime_type enum (رشته) (اختیاری)

The mime type of the video.

مقادیر ممکن:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

processing MediaProcessing or enum (string) (optional)

How the model processes this video for understanding.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

رشته uri (اختیاری)

The URI of the video.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "model_output" .

ThoughtStep

A thought step.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

summary array (ThoughtSummaryContent) (optional)

A summary of the thought.

انواع ممکن

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

end_offset string (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string (optional)

Optional. Speaker label for this word (eg "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

start_offset string (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string (optional)

The transcribed word.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "word_info" .

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "thought" .

UrlContextCallStep

URL context call step.

arguments UrlContextCallArguments (required)

Required. The arguments to pass to the URL context.

The arguments to pass to the URL context.

فیلدها

urls array (string) (optional)

The URLs to fetch.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "url_context_call" .

UrlContextResultStep

URL context result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the URL context resulted in an error.

result array (UrlContextResult) (required)

Required. The results of the URL context.

The result of the URL context.

فیلدها

شمارش وضعیت (رشته) (اختیاری)

The status of the URL retrieval.

مقادیر ممکن:

  • success

    Url retrieval is successful.

  • error

    Url retrieval is failed due to error.

  • paywall

    Url retrieval is failed because the content is behind paywall.

  • unsafe

    Url retrieval is failed because the content is unsafe.

رشته آدرس اینترنتی (اختیاری)

The URL that was fetched.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "url_context_result" .

UserInputStep

Input provided by the user.

content array (Content) (optional)

هیچ توضیحی ارائه نشده است.

محتوای پاسخ.

انواع ممکن

محتوای صوتی

یک بلوک محتوای صوتی.

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای سند

یک بلوک محتوای سند.

رشته داده (اختیاری)

محتوای سند.

mime_type enum (رشته) (اختیاری)

نوع MIME سند.

مقادیر ممکن:

  • application/pdf

    فرمت سند PDF

  • text/csv

    فرمت سند CSV

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "document" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) سند.

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

end_offset string (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string (optional)

Optional. Speaker label for this word (eg "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

start_offset string (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string (optional)

The transcribed word.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "word_info" .

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

VideoContent

A video content block.

رشته داده (اختیاری)

The video content.

mime_type enum (رشته) (اختیاری)

The mime type of the video.

مقادیر ممکن:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

processing MediaProcessing or enum (string) (optional)

How the model processes this video for understanding.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

رشته uri (اختیاری)

The URI of the video.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "user_input" .

رشته system_instruction (اختیاری)

دستورالعمل سیستم برای تعامل.

tools array (Tool) (optional)

فهرستی از اعلان‌های ابزار که مدل ممکن است در طول تعامل فراخوانی کند.

ابزاری که می‌تواند توسط مدل مورد استفاده قرار گیرد.

انواع ممکن

اجرای کد

ابزاری که می‌تواند توسط مدل برای اجرای کد استفاده شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution" تنظیم شود.

ComputerUse

A tool that can be used by the model to interact with the computer.

disabled_safety_policies array (enum (string)) (optional)

Optional. Disabled safety policies for computer use.

مقادیر ممکن:

  • financial_transactions

    Safety policy for financial transactions.

  • sensitive_data_modification

    Safety policy for sensitive data modification.

  • communication_tool

    Safety policy for communication tools (eg Gmail, Chat, Meet).

  • account_creation

    Safety policy for account creation.

  • data_modification

    Safety policy for data modification.

  • user_consent_management

    Safety policy for user consent management.

  • legal_terms_and_agreements

    Safety policy for legal terms and agreements.

enable_prompt_injection_detection boolean (optional)

Whether enable the prompt injection detection check on computer-use request.

environment enum (string) (optional)

The environment being operated.

مقادیر ممکن:

  • browser

    Operates in a web browser.

  • mobile

    Operates in a mobile environment.

  • desktop

    Operates in a desktop environment.

excluded_predefined_functions array (string) (optional)

The list of predefined functions that are excluded from the model call.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "computer_use" .

جستجوی فایل

ابزاری که می‌تواند توسط مدل برای جستجوی فایل‌ها استفاده شود.

آرایه file_search_store_names (رشته‌ای) (اختیاری)

جستجوی فایل، نام‌های فروشگاه را برای جستجو ذخیره می‌کند.

رشته metadata_filter (اختیاری)

فیلتر فراداده برای اعمال روی اسناد و تکه‌های بازیابی معنایی.

عدد صحیح top_k (اختیاری)

تعداد تکه‌های بازیابی معنایی که باید بازیابی شوند.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_search" تنظیم شود.

عملکرد

ابزاری که می‌تواند توسط مدل مورد استفاده قرار گیرد.

رشته توضیحات (اختیاری)

شرحی از تابع.

رشته نام (اختیاری)

نام تابع.

پارامتر شیء (اختیاری)

طرحواره JSON برای پارامترهای تابع.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "function" تنظیم شود.

گوگل مپ

ابزاری که می‌تواند توسط مدل برای فراخوانی نقشه‌های گوگل استفاده شود.

enable_widget بولی (اختیاری)

اینکه آیا در نتیجه فراخوانی ابزار، توکن زمینه ویجت برگردانده شود یا خیر.

شماره عرض جغرافیایی (اختیاری)

عرض جغرافیایی محل کاربر.

شماره طول جغرافیایی (اختیاری)

طول جغرافیایی موقعیت مکانی کاربر.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_maps" تنظیم شود.

جستجوی گوگل

ابزاری که می‌تواند توسط مدل برای جستجو در گوگل استفاده شود.

آرایه search_types (enum (رشته)) (اختیاری)

انواع زمینه‌سازی جستجو برای فعال‌سازی.

مقادیر ممکن:

  • web_search

    تنظیم این فیلد، جستجوی وب را فعال می‌کند. فقط نتایج متنی برگردانده می‌شوند.

  • image_search

    تنظیم این فیلد، جستجوی تصویر را فعال می‌کند. بایت‌های تصویر برگردانده می‌شوند.

  • enterprise_web_search

    Setting this field enables enterprise web search.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_search" تنظیم شود.

McpServer

A MCPServer is a server that can be called by the model to perform actions.

allowed_tools array (AllowedTools) (optional)

The allowed tools.

The configuration for allowed tools.

فیلدها

mode enum (string) (optional)

The mode of the tool choice.

مقادیر ممکن:

  • auto

    انتخاب خودکار ابزار.

  • any

    هر انتخاب ابزاری.

  • none

    بدون انتخاب ابزار.

  • validated

    انتخاب ابزار معتبر.

tools array (string) (optional)

The names of the allowed tools.

headers object (optional)

Optional: Fields for authentication headers, timeouts, etc., if needed.

رشته نام (اختیاری)

The name of the MCPServer.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "mcp_server" .

رشته آدرس اینترنتی (اختیاری)

The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"

بازیابی

A tool that can be used by the model to retrieve files.

exa_ai_search_config ExaAISearchConfig (optional)

Used to specify configuration for ExaAISearch.

Used to specify configuration for ExaAISearch.

فیلدها

api_key string (optional)

Required. The API key for ExaAiSearch.

custom_config object (optional)

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

parallel_ai_search_config ParallelAISearchConfig (optional)

Used to specify configuration for ParallelAISearch.

Used to specify configuration for ParallelAISearch.

فیلدها

api_key string (optional)

Optional. The API key for ParallelAiSearch.

custom_config object (optional)

Optional. Custom configs for ParallelAiSearch.

rag_store_config RagStoreConfig (optional)

Used to specify configuration for RagStore.

Use to specify configuration for RAG Store.

فیلدها

rag_resources array (RagResource) (optional)

Optional. The representation of the rag source.

The definition of the Rag resource.

فیلدها

rag_corpus string (optional)

Optional. RagCorpora resource name.

rag_file_ids array (string) (optional)

Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.

rag_retrieval_config RagRetrievalConfig (optional)

Optional. The retrieval config for the Rag query.

Specifies the context retrieval config.

فیلدها

filter Filter (optional)

Optional. Config for filters.

Config for filters.

فیلدها

رشته metadata_filter (اختیاری)

Optional. String for metadata filtering.

vector_distance_threshold number (optional)

Optional. Only returns contexts with vector distance smaller than the threshold.

vector_similarity_threshold number (optional)

Optional. Only returns contexts with vector similarity larger than the threshold.

hybrid_search HybridSearch (optional)

Optional. Config for Hybrid Search.

Config for Hybrid Search.

فیلدها

alpha number (optional)

Optional. Alpha value controls the weight between dense and sparse vector search results.

ranking Ranking (optional)

Optional. Config for ranking and reranking.

Config for ranking and reranking.

عدد صحیح top_k (اختیاری)

Optional. The number of contexts to retrieve.

retrieval_types array (enum (string)) (optional)

The types of file retrieval to enable.

مقادیر ممکن:

  • rag_store
  • exa_ai_search
  • parallel_ai_search
نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "retrieval" .

متن آدرس

ابزاری که می‌تواند توسط مدل برای دریافت متن URL استفاده شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_context" تنظیم شود.

رشته به‌روزرسانی‌شده (اختیاری)

فقط خروجی. زمانی که پاسخ آخرین بار در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) به‌روزرسانی شده است.

کاربرد (اختیاری )

فقط خروجی. آمار مربوط به میزان استفاده از توکن درخواست تعامل.

آمار مربوط به میزان استفاده از توکن درخواست تعامل.

فیلدها

آرایه cached_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک میزان استفاده از توکن‌های ذخیره‌شده بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه grounding_tool_count (GroundingToolCount) (اختیاری)

تعداد ابزار اتصال به زمین

تعداد ابزار اتصال به زمین مهم است.

فیلدها

شمارش عدد صحیح (اختیاری)

تعداد ابزار اتصال به زمین مهم است.

نوع enum (رشته) (اختیاری)

نوع ابزار اتصال زمین مرتبط با شمارش.

مقادیر ممکن:

  • google_search

    اتصال به زمین با جستجوی وب و جستجوی تصویر گوگل، و اتصال به زمین وب برای سازمان‌ها.

  • google_maps

    اتصال به زمین با نقشه‌های گوگل.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

آرایه input_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک استفاده از توکن ورودی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه output_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک استفاده از توکن خروجی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه tool_use_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک میزان استفاده از توکن‌های ابزار بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

عدد صحیح total_cached_tokens (اختیاری)

تعداد توکن‌ها در بخش ذخیره‌شده‌ی اعلان (محتوای ذخیره‌شده).

عدد صحیح total_input_tokens (اختیاری)

تعداد توکن‌ها در اعلان (زمینه).

total_output_tokens عدد صحیح (اختیاری)

تعداد کل توکن‌ها در تمام پاسخ‌های تولید شده.

total_thought_tokens عدد صحیح (اختیاری)

تعداد توکن‌های افکار برای مدل‌های تفکر.

عدد صحیح total_tokens (اختیاری)

تعداد کل توکن‌ها برای درخواست تعامل (درخواست + پاسخ‌ها + سایر توکن‌های داخلی).

عدد صحیح total_tool_use_tokens (اختیاری)

تعداد توکن‌های موجود در اعلان(های) استفاده از ابزار.

webhook_config WebhookConfig (optional)

Optional. Webhook configuration for receiving notifications when the interaction completes.

Message for configuring webhook events for a request.

فیلدها

uris array (string) (optional)

Optional. If set, these webhook URIs will be used for webhook events instead of the registered webhooks.

user_metadata object (optional)

Optional. The user metadata that will be returned on each event emission to the webhooks.

last_pause_time string (optional)

Output only. The time when the trigger was last paused.

last_resume_time string (optional)

Output only. The time when the trigger was last resumed.

last_run_time string (optional)

Output only. The time when the trigger was last run.

max_consecutive_failures integer (optional)

Optional. The maximum number of consecutive failures allowed before the trigger is automatically paused (status becomes ERROR).

next_run_time string (optional)

Output only. The time when the trigger is scheduled to run next.

رشته‌ی previous_interaction_id (اختیاری)

Output only. The ID of the last interaction created by this trigger.

schedule string (optional)

Required. The cron schedule on which the trigger should run. Standard cron format.

شمارش وضعیت (رشته) (اختیاری)

Output only. The current status of the trigger.

مقادیر ممکن:

  • active

    The trigger is active and will fire on schedule.

  • paused

    The trigger is paused and will not fire.

  • error

    The trigger has entered an error state due to consecutive failures.

time_zone string (optional)

Required. Time zone in which the schedule should be interpreted.

update_time string (optional)

Output only. The time when the trigger was last updated.

مثال

پاسخ نمونه 

{
  "consecutive_failure_count": 0,
  "create_time": "string",
  "display_name": "string",
  "environment_id": "string",
  "execution_timeout_seconds": 0,
  "id": "string",
  "interaction": {
    "created": "2025-12-04T15:01:45Z",
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3.6-flash",
    "object": "interaction",
    "status": "completed",
    "steps": [
      {
        "type": "model_output",
        "content": [
          {
            "type": "text",
            "text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?"
          }
        ]
      }
    ],
    "updated": "2025-12-04T15:01:45Z",
    "usage": {
      "input_tokens_by_modality": [
        {
          "modality": "text",
          "tokens": 7
        }
      ],
      "total_cached_tokens": 0,
      "total_input_tokens": 7,
      "total_output_tokens": 23,
      "total_thought_tokens": 49,
      "total_tokens": 79,
      "total_tool_use_tokens": 0
    }
  },
  "last_pause_time": "string",
  "last_resume_time": "string",
  "last_run_time": "string",
  "max_consecutive_failures": 0,
  "next_run_time": "string",
  "previous_interaction_id": "string",
  "schedule": "string",
  "status": "active",
  "time_zone": "string",
  "update_time": "string"
}

اعدام‌های ListTrigger

get https://generativelanguage.googleapis.com/v1beta/triggers/{trigger_id}/executions

Lists executions for a trigger.

پارامترهای مسیر/پرس‌وجو

page_size integer (optional)

Optional. The maximum number of executions to return per page.

page_token string (optional)

Optional. A page token from a previous ListTriggerExecutions call.

پاسخ

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

next_page_token string (optional)

A page token, received from a previous `ListTriggerExecutions` call. Provide this to retrieve the subsequent page.

trigger_executions array (TriggerExecution) (optional)

The list of trigger executions.

An execution instance of a trigger.

فیلدها

end_time string (optional)

Output only. The time when the execution finished.

environment_id string (optional)

Output only. The environment ID used for the execution.

error string (optional)

Output only. The error message if the execution failed.

رشته شناسه (اختیاری)

Required. Output only. Identifier. The ID of the trigger execution.

interaction_id string (optional)

Output only. The ID of the interaction created by this execution, if any.

scheduled_time string (optional)

Output only. The time when the execution was scheduled to run.

start_time string (optional)

Output only. The time when the execution started.

شمارش وضعیت (رشته) (اختیاری)

Output only. The status of the execution.

مقادیر ممکن:

  • in_progress

    The execution is currently in progress.

  • completed

    The execution completed successfully.

  • failed

    The execution failed.

  • skipped

    The execution was skipped (eg, previous execution still running).

  • timed_out

    The execution timed out.

trigger_id string (optional)

Required. Output only. Identifier. The ID of the trigger that created this execution.

مثال

پاسخ نمونه 

{
  "next_page_token": "string",
  "trigger_executions": [
    {
      "end_time": "string",
      "environment_id": "string",
      "error": "string",
      "id": "string",
      "interaction_id": "string",
      "scheduled_time": "string",
      "start_time": "string",
      "status": "in_progress",
      "trigger_id": "string"
    }
  ]
}

UpdateTrigger

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

Updates a trigger.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

display_name string (optional)

Optional. The display name of the trigger.

شمارش وضعیت (رشته) (اختیاری)

Optional. The status of the trigger.

مقادیر ممکن:

  • active

    The trigger is active and will fire on schedule.

  • paused

    The trigger is paused and will not fire.

  • error

    The trigger has entered an error state due to consecutive failures.

پاسخ

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

consecutive_failure_count integer (optional)

Output only. The number of consecutive failures that have occurred since the last successful execution.

create_time string (optional)

Output only. The time when the trigger was created.

display_name string (optional)

Optional. The display name of the trigger.

environment_id string (optional)

Optional. The environment ID for the trigger execution.

execution_timeout_seconds integer (optional)

Optional. The execution timeout for the triggered interaction.

رشته شناسه (اختیاری)

Required. Output only. Identifier. The ID of the trigger.

interaction Interaction (optional)

Required. The interaction request template to be executed.

منبع تعامل.

فیلدها

گزینه عامل (اختیاری)

نام «عامل» مورد استفاده برای ایجاد تعامل.

عاملی که باید با آن تعامل داشت.

مقادیر ممکن

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

    نماینده تحقیقات عمیق جمینی

  • deep-research-preview-04-2026

    نماینده تحقیقات عمیق جمینی

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

    مامور مکس تحقیقات عمیق جمینی

  • antigravity-preview-05-2026

    از عامل مدیریت‌شده‌ی Antigravity برای انجام وظایف چند مرحله‌ای که نیاز به استدلال، عملیات فایل و استفاده از ابزار دارند، استفاده کنید.

agent_config object (optional)

پارامترهای پیکربندی برای تعامل عامل.

انواع ممکن

Polymorphic discriminator: type

AntigravityAgentConfig

Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration.

رشته‌ی max_total_tokens (اختیاری)

حداکثر مجموع توکن‌ها برای اجرای عامل.

رشته مدل (اختیاری)

The model to use for agent reasoning.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "antigravity" .

CodeMenderAgentConfig

Configuration for the CodeMender agent.

find_request FindRequest (optional)

Parameters for finding vulnerabilities.

Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase.

فیلدها

رشته توضیحات (اختیاری)

Additional context or custom instructions provided by the user to guide the vulnerability analysis.

finding_id string (optional)

The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability.

mode enum (string) (optional)

The mode of the find session.

مقادیر ممکن:

  • scan

    Fast scan using only the initial classifier.

  • verify

    Performs classification followed by detailed investigation.

source_files array (FileContent) (optional)

A list of source files to provide as context for the scan.

Content of a single file in the codebase.

فیلدها

content string (optional)

The UTF-8 encoded text content of the file.

path string (optional)

The relative path of the file from the project root.

fix_request FixRequest (optional)

Parameters for fixing vulnerabilities.

Request parameters specific to FIX sessions, used for generating and validating security patches.

فیلدها

رشته توضیحات (اختیاری)

Additional context or custom instructions provided by the user to guide the patch generation process.

finding_id string (optional)

The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.

source_files array (FileContent) (optional)

A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability.

Content of a single file in the codebase.

فیلدها

content string (optional)

The UTF-8 encoded text content of the file.

path string (optional)

The relative path of the file from the project root.

رشته مدل (اختیاری)

The name of the model to use for the CodeMender agent. One CodeMender session will only use one model.

session_config SessionConfig (optional)

Optional session-specific configurations to override default agent behavior.

The configuration of CodeMender sessions.

فیلدها

max_rounds integer (optional)

The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.

session_id string (optional)

Parameter for grouping multiple interactions that belong to the same CodeMender session.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "code-mender" .

DeepResearchAgentConfig

Configuration for the Deep Research agent.

collaborative_planning boolean (optional)

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.

enable_bigquery_tool boolean (optional)

Enables bigquery tool for the Deep Research agent.

خلاصه‌های تفکر ( اختیاری)

اینکه آیا خلاصه نظرات در پاسخ گنجانده شود یا خیر.

مقادیر ممکن

  • auto

    خلاصه‌های تفکر خودکار

  • none

    بدون خلاصه نویسی فکری.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "deep-research" .

visualization enum (string) (optional)

Whether to include visualizations in the response.

مقادیر ممکن:

  • off

    Do not include visualizations.

  • auto

    Automatically include visualizations.

DynamicAgentConfig

پیکربندی برای عامل‌های پویا

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "dynamic" تنظیم شود.

رشته ایجاد شده (اختیاری)

فقط خروجی. زمانی که پاسخ در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) ایجاد شده است.

environment EnvironmentConfig or string (optional)

The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.

Configuration for a custom environment.

فیلدها

environment_id string (optional)

Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.

network EnvironmentNetworkEgressAllowlist or enum (string) (optional)

Network configuration for the environment.

Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.

انواع ممکن

شیء

Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.

allowlist array (AllowlistEntry) (optional)

List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.

A single domain allowlist rule with optional header injection.

فیلدها

domain string (optional)

Domain to allow outbound requests to. Supports wildcards (eg '*.googleapis.com'). Use '*' to allow all domains.

transform array (object) or object (optional)

Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.

رشته

Turns all network off.

مقادیر ممکن

  • disabled

    Turns all network off.

sources array (Source) (optional)

هیچ توضیحی ارائه نشده است.

A source to be mounted into the environment.

فیلدها

content string (optional)

The inline content if `type` is `INLINE`.

encoding string (optional)

Optional encoding for inline content (eg `base64`).

رشته منبع (اختیاری)

The source of the environment. For Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path.

target string (optional)

Where the source should appear in the environment.

نوع enum (رشته) (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • gcs

    A Cloud Storage bucket.

  • inline

    Inline content.

  • repository

    A generic repository. The protocol prefix in the source URL identifies the provider (eg, github://, gcs://).

  • skill_registry

    A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

Always set to "remote" .

environment_id string (optional)

Output only. The environment ID for the interaction. Only populated if environment config is set in the request.

آرایه خطاها (Error) (اختیاری)

فقط خروجی. خطاهای تشخیصی / خطاهای پلتفرم که در تعامل ثبت شده‌اند.

پیام خطا از یک تعامل.

فیلدها

رشته کد (اختیاری)

یک URI که نوع خطا را مشخص می‌کند.

رشته پیام (اختیاری)

یک پیام خطا که برای انسان قابل خواندن باشد.

رشته شناسه (اختیاری)

الزامی. فقط خروجی. یک شناسه منحصر به فرد برای تکمیل تعامل.

پیش‌فرض‌ها به:

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

ورودی برای تعامل.

شیء برچسب‌ها (اختیاری)

برچسب‌هایی با فراداده‌های تعریف‌شده توسط کاربر برای درخواست.

مدل ModelOption (اختیاری)

نام «مدل» مورد استفاده برای تولید تعامل.

مدلی که اعلان شما را تکمیل می‌کند.\n\nبرای جزئیات بیشتر به [models](https://ai.google.dev/gemini-api/docs/models) مراجعه کنید.

مقادیر ممکن

  • gemini-2.5-flash

    اولین مدل استدلال ترکیبی ما که از یک پنجره زمینه ۱ میلیون توکنی پشتیبانی می‌کند و دارای بودجه‌های تفکر است.

  • gemini-2.5-pro

    Our state-of-the-art multipurpose model, which excels at coding and complex reasoning tasks.

  • gemma-4-26b-a4b-it

    Gemma 4 26B A4B IT

  • gemma-4-31b-it

    Gemma 4 31B IT

  • gemini-flash-latest

    Latest release of Gemini Flash

  • gemini-flash-lite-latest

    Latest release of Gemini Flash-Lite

  • gemini-pro-latest

    Latest release of Gemini Pro

  • gemini-2.5-flash-lite

    کوچکترین و مقرون به صرفه ترین مدل ما، ساخته شده برای استفاده در مقیاس بزرگ.

  • gemini-2.5-flash-image

    مدل تولید تصویر بومی ما، که برای سرعت، انعطاف‌پذیری و درک متنی بهینه شده است. ورودی و خروجی متن با همان قیمت ۲.۵ فلش ارائه می‌شود.

  • gemini-3-flash-preview

    هوشمندترین مدل ما که برای سرعت ساخته شده است، هوش مرزی را با جستجو و ردیابی برتر ترکیب می‌کند.

  • gemini-3.1-pro-preview

    Our latest SOTA reasoning model with unprecedented depth and nuance, and powerful multimodal understanding and coding capabilities.

  • gemini-3.1-pro-preview-customtools

    Gemini 3.1 Pro Preview optimized for custom tool usage

  • gemini-3.1-flash-lite

    مقرون‌به‌صرفه‌ترین مدل ما، بهینه‌شده برای وظایف عامل‌محور با حجم بالا، ترجمه و پردازش داده‌های ساده.

  • gemini-3-pro-image

    Gemini 3 Pro Image

  • nano-banana-pro-preview

    Gemini 3 Pro Image Preview

  • gemini-3.1-flash-image

    Gemini 3.1 Flash Image.

  • gemini-3.5-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • gemini-3.6-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • gemini-3.7-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • lyria-3-clip-preview

    Our low-latency, music generation model optimized for high-fidelity audio clips and precise rhythmic control.

  • lyria-3-pro-preview

    Our advanced, full-song generative model with deep compositional understanding, optimized for precise structural control and complex transitions across diverse musical styles.

  • gemini-robotics-er-1.6-preview

    Gemini Robotics-ER 1.6 Preview

  • gemini-robotics-er-2-preview

    Gemini Robotics Embodied Reasoning 2 Preview

محتوای صوتی output_audio (اختیاری)

آخرین صدای تولید شده توسط مدل در پاسخ به درخواست فعلی. توجه: این توسط SDK اضافه شده است.

یک بلوک محتوای صوتی.

فیلدها

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای تصویر خروجی (اختیاری)

آخرین تصویری که توسط مدل در پاسخ به درخواست فعلی تولید شده است. توجه: این تصویر توسط SDK اضافه شده است.

یک بلوک محتوای تصویر.

فیلدها

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

رشته‌ی output_text (اختیاری)

متن به هم پیوسته از آخرین خروجی مدل در پاسخ به درخواست فعلی. توجه: این توسط SDK اضافه شده است.

output_video VideoContent (optional)

The last video generated by the model in response to the current request. Note: this is added by the SDK.

A video content block.

فیلدها

رشته داده (اختیاری)

The video content.

mime_type enum (رشته) (اختیاری)

The mime type of the video.

مقادیر ممکن:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

processing MediaProcessing or enum (string) (optional)

How the model processes this video for understanding.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

رشته uri (اختیاری)

The URI of the video.

رشته‌ی previous_interaction_id (اختیاری)

شناسه‌ی تعامل قبلی، در صورت وجود.

response_format ResponseFormat or array (ResponseFormat) (optional)

تأکید می‌کند که پاسخ تولید شده یک شیء JSON است که با طرحواره JSON مشخص شده در این فیلد مطابقت دارد.

انواع ممکن

AudioResponseFormat

Configuration for audio output format.

bit_rate integer (optional)

Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).

delivery enum (string) (optional)

The delivery mode for the audio output.

مقادیر ممکن:

  • inline

    Audio data is returned inline in the response.

  • uri

    Audio data is returned as a URI.

mime_type enum (رشته) (اختیاری)

The MIME type of the audio output.

مقادیر ممکن:

  • audio/mp3

    MP3 audio format.

  • audio/ogg_opus

    OGG Opus audio format.

  • audio/l16

    Raw PCM (L16) audio format.

  • audio/wav

    WAV audio format.

  • audio/alaw

    A-law audio format.

  • audio/mulaw

    Mu-law audio format.

عدد صحیح sample_rate (اختیاری)

Sample rate in Hz.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

ImageResponseFormat

Configuration for image output format.

aspect_ratio enum (string) (optional)

The aspect ratio for the image output.

مقادیر ممکن:

  • 1:1

    نسبت تصویر ۱:۱.

  • 2:3

    2:3 aspect ratio.

  • 3:2

    3:2 aspect ratio.

  • 3:4

    3:4 aspect ratio.

  • 4:3

    نسبت تصویر ۴:۳.

  • 4:5

    4:5 aspect ratio.

  • 5:4

    5:4 aspect ratio.

  • 9:16

    نسبت تصویر ۹:۱۶

  • 16:9

    نسبت تصویر ۱۶:۹.

  • 21:9

    21:9 aspect ratio.

  • 1:8

    1:8 aspect ratio.

  • 8:1

    8:1 aspect ratio.

  • 1:4

    1:4 aspect ratio.

  • 4:1

    4:1 aspect ratio.

delivery enum (string) (optional)

The delivery mode for the image output.

مقادیر ممکن:

  • inline

    Image data is returned inline in the response.

  • uri

    Image data is returned as a URI.

image_size enum (string) (optional)

The size of the image output.

مقادیر ممکن:

  • 512

    512px image size.

  • 1K

    1K image size.

  • 2K

    2K image size.

  • 4K

    4K image size.

mime_type enum (رشته) (اختیاری)

The MIME type of the image output.

مقادیر ممکن:

  • image/jpeg

    JPEG image format.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

TextResponseFormat

Configuration for text output format.

mime_type enum (رشته) (اختیاری)

The MIME type of the text output.

مقادیر ممکن:

  • application/json

    JSON output format.

  • text/plain

    Plain text output format.

schema object (optional)

The JSON schema that the output should conform to. Only applicable when mime_type is application/json.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

VideoResponseFormat

Configuration for video output format.

aspect_ratio enum (string) (optional)

The aspect ratio for the video output.

مقادیر ممکن:

  • 16:9

    نسبت تصویر ۱۶:۹.

  • 9:16

    نسبت تصویر ۹:۱۶

delivery enum (string) (optional)

The delivery mode for the video output.

مقادیر ممکن:

  • inline

    Video data is returned inline in the response.

  • uri

    Video data is returned as a URI.

duration string (optional)

The duration for the video output.

gcs_uri string (optional)

The Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.

resolution enum (string) (optional)

The video output resolution. Defaults to 720p.

مقادیر ممکن:

  • 360p

    360p resolution.

  • 720p

    720p resolution.

  • 1080p

    1080p resolution.

  • 4k

    وضوح تصویر 4K.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

آرایه safety_settings (SafetySetting) (اختیاری)

تنظیمات ایمنی برای تعامل.

A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.

فیلدها

method enum (string) (optional)

Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.

مقادیر ممکن:

  • severity

    The harm block method uses both probability and severity scores.

  • probability

    The harm block method uses the probability score.

threshold enum (string) (optional)

Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.

مقادیر ممکن:

  • block_low_and_above

    Block content with a low harm probability or higher.

  • block_medium_and_above

    Block content with a medium harm probability or higher.

  • block_only_high

    Block content with a high harm probability.

  • block_none

    Do not block any content, regardless of its harm probability.

  • off

    Turn off the safety filter entirely.

type HarmCategory (optional)

Required. The type of harm category to be blocked.

مقادیر ممکن

  • hate_speech

    Content that promotes violence or incites hatred against individuals or groups based on certain attributes.

  • dangerous_content

    Content that promotes, facilitates, or enables dangerous activities.

  • harassment

    Abusive, threatening, or content intended to bully, torment, or ridicule.

  • sexually_explicit

    Content that contains sexually explicit material.

  • civic_integrity

    Deprecated: Election filter is not longer supported. The harm category is civic integrity.

  • image_hate

    Images that contain hate speech.

  • image_dangerous_content

    Images that contain dangerous content.

  • image_harassment

    Images that contain harassment.

  • image_sexually_explicit

    Images that contain sexually explicit content.

  • jailbreak

    Prompts designed to bypass safety filters.

service_tier ServiceTier (optional)

The service tier for the interaction.

مقادیر ممکن

  • flex

    Flex service tier.

  • standard

    Standard service tier.

  • priority

    Priority service tier.

  • deferred

    Deferred service tier.

شمارش وضعیت (رشته) (اختیاری)

الزامی. فقط خروجی. وضعیت تعامل.

مقادیر ممکن:

  • in_progress

    تعامل در حال انجام است.

  • requires_action

    این تعامل نیاز به اقدام/ورودی از سوی کاربر دارد.

  • completed

    تعامل تکمیل شده است.

  • failed

    تعامل شکست خورد.

  • cancelled

    تعامل لغو شد.

  • incomplete

    تعامل تکمیل شده است، اما شامل نتایج ناقص است (مثلاً رسیدن به max_tokens).

  • budget_exceeded

    The interaction was halted because the token budget was exceeded.

  • queued

    The interaction is queued, waiting for processing.

steps array (Step) (optional)

فقط خروجی. مراحلی که تعامل را تشکیل می‌دهند، زمانی که در پاسخ گنجانده شوند.

A step in the interaction.

انواع ممکن

CodeExecutionCallStep

Code execution call step.

arguments CodeExecutionCallStepArguments (required)

Required. The arguments to pass to the code execution.

آرگومان‌هایی که باید به اجرای کد ارسال شوند.

فیلدها

رشته کد (اختیاری)

کدی که قرار است اجرا شود.

شمارش زبان (رشته) (اختیاری)

زبان برنامه‌نویسی «کد».

مقادیر ممکن:

  • python

    پایتون >= 3.10، با numpy و simpy در دسترس است.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution_call" تنظیم شود.

CodeExecutionResultStep

Code execution result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the code execution resulted in an error.

رشته نتیجه (الزامی)

Required. The output of the code execution.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution_result" تنظیم شود.

FileSearchCallStep

File Search call step.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "file_search_call" .

FileSearchResultStep

File Search result step.

call_id string (required)

Required. ID to match the ID from the function call block.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "file_search_result" .

FunctionCallStep

A function tool call step.

arguments object (required)

Required. The arguments to pass to the function.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

name string (required)

Required. The name of the tool to call.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "function_call" .

FunctionResultStep

Result of a function tool call.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the tool call resulted in an error.

رشته نام (اختیاری)

The name of the tool that was called.

result array (ImageContent or TextContent) or object or string (required)

Required. The result of the tool call.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "function_result" .

GoogleMapsCallStep

Google Maps call step.

arguments GoogleMapsCallStepArguments (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

فیلدها

queries array (string) (optional)

The queries to be executed.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_maps_call" .

GoogleMapsResultStep

Google Maps result step.

call_id string (required)

Required. ID to match the ID from the function call block.

result array (GoogleMapsResultItem) (required)

هیچ توضیحی ارائه نشده است.

The result of the Google Maps.

فیلدها

places array (GoogleMapsResultPlaces) (optional)

هیچ توضیحی ارائه نشده است.

فیلدها

رشته نام (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته place_id (اختیاری)

هیچ توضیحی ارائه نشده است.

آرایه review_snippets (ReviewSnippet) (اختیاری)

هیچ توضیحی ارائه نشده است.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

رشته آدرس اینترنتی (اختیاری)

هیچ توضیحی ارائه نشده است.

widget_context_token string (optional)

هیچ توضیحی ارائه نشده است.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_maps_result" .

GoogleSearchCallStep

Google Search call step.

arguments GoogleSearchCallStepArguments (required)

Required. The arguments to pass to Google Search.

The arguments to pass to Google Search.

فیلدها

queries array (string) (optional)

Web search queries for the following-up web search.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

search_type enum (string) (optional)

The type of search grounding enabled.

مقادیر ممکن:

  • web_search

    تنظیم این فیلد، جستجوی وب را فعال می‌کند. فقط نتایج متنی برگردانده می‌شوند.

  • image_search

    تنظیم این فیلد، جستجوی تصویر را فعال می‌کند. بایت‌های تصویر برگردانده می‌شوند.

  • enterprise_web_search

    Setting this field enables enterprise web search.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_search_call" .

GoogleSearchResultStep

Google Search result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the Google Search resulted in an error.

result array (GoogleSearchResultItem) (required)

Required. The results of the Google Search.

The result of the Google Search.

فیلدها

search_suggestions string (optional)

Web content snippet that can be embedded in a web page or an app webview.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_search_result" .

McpServerToolCallStep

MCPServer tool call step.

arguments object (required)

Required. The JSON object of arguments for the function.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

name string (required)

Required. The name of the tool which was called.

server_name string (required)

Required. The name of the used MCP server.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "mcp_server_tool_call" .

McpServerToolResultStep

MCPServer tool result step.

call_id string (required)

Required. ID to match the ID from the function call block.

رشته نام (اختیاری)

Name of the tool which is called for this specific tool call.

result array (ImageContent or TextContent) or object or string (required)

Required. The output from the MCP server call. Can be simple text or rich content.

server_name string (optional)

The name of the used MCP server.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "mcp_server_tool_result" .

ModelOutputStep

Output generated by the model.

content array (Content) (optional)

هیچ توضیحی ارائه نشده است.

محتوای پاسخ.

انواع ممکن

محتوای صوتی

یک بلوک محتوای صوتی.

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای سند

یک بلوک محتوای سند.

رشته داده (اختیاری)

محتوای سند.

mime_type enum (رشته) (اختیاری)

نوع MIME سند.

مقادیر ممکن:

  • application/pdf

    فرمت سند PDF

  • text/csv

    فرمت سند CSV

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "document" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) سند.

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

end_offset string (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string (optional)

Optional. Speaker label for this word (eg "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

start_offset string (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string (optional)

The transcribed word.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "word_info" .

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

VideoContent

A video content block.

رشته داده (اختیاری)

The video content.

mime_type enum (رشته) (اختیاری)

The mime type of the video.

مقادیر ممکن:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

processing MediaProcessing or enum (string) (optional)

How the model processes this video for understanding.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

رشته uri (اختیاری)

The URI of the video.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "model_output" .

ThoughtStep

A thought step.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

summary array (ThoughtSummaryContent) (optional)

A summary of the thought.

انواع ممکن

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

end_offset string (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string (optional)

Optional. Speaker label for this word (eg "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

start_offset string (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string (optional)

The transcribed word.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "word_info" .

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "thought" .

UrlContextCallStep

URL context call step.

arguments UrlContextCallArguments (required)

Required. The arguments to pass to the URL context.

The arguments to pass to the URL context.

فیلدها

urls array (string) (optional)

The URLs to fetch.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "url_context_call" .

UrlContextResultStep

URL context result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the URL context resulted in an error.

result array (UrlContextResult) (required)

Required. The results of the URL context.

The result of the URL context.

فیلدها

شمارش وضعیت (رشته) (اختیاری)

The status of the URL retrieval.

مقادیر ممکن:

  • success

    Url retrieval is successful.

  • error

    Url retrieval is failed due to error.

  • paywall

    Url retrieval is failed because the content is behind paywall.

  • unsafe

    Url retrieval is failed because the content is unsafe.

رشته آدرس اینترنتی (اختیاری)

The URL that was fetched.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "url_context_result" .

UserInputStep

Input provided by the user.

content array (Content) (optional)

هیچ توضیحی ارائه نشده است.

محتوای پاسخ.

انواع ممکن

محتوای صوتی

یک بلوک محتوای صوتی.

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای سند

یک بلوک محتوای سند.

رشته داده (اختیاری)

محتوای سند.

mime_type enum (رشته) (اختیاری)

نوع MIME سند.

مقادیر ممکن:

  • application/pdf

    فرمت سند PDF

  • text/csv

    فرمت سند CSV

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "document" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) سند.

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

end_offset string (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string (optional)

Optional. Speaker label for this word (eg "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

start_offset string (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string (optional)

The transcribed word.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "word_info" .

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

VideoContent

A video content block.

رشته داده (اختیاری)

The video content.

mime_type enum (رشته) (اختیاری)

The mime type of the video.

مقادیر ممکن:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

processing MediaProcessing or enum (string) (optional)

How the model processes this video for understanding.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

رشته uri (اختیاری)

The URI of the video.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "user_input" .

رشته system_instruction (اختیاری)

دستورالعمل سیستم برای تعامل.

tools array (Tool) (optional)

فهرستی از اعلان‌های ابزار که مدل ممکن است در طول تعامل فراخوانی کند.

ابزاری که می‌تواند توسط مدل مورد استفاده قرار گیرد.

انواع ممکن

اجرای کد

ابزاری که می‌تواند توسط مدل برای اجرای کد استفاده شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution" تنظیم شود.

ComputerUse

A tool that can be used by the model to interact with the computer.

disabled_safety_policies array (enum (string)) (optional)

Optional. Disabled safety policies for computer use.

مقادیر ممکن:

  • financial_transactions

    Safety policy for financial transactions.

  • sensitive_data_modification

    Safety policy for sensitive data modification.

  • communication_tool

    Safety policy for communication tools (eg Gmail, Chat, Meet).

  • account_creation

    Safety policy for account creation.

  • data_modification

    Safety policy for data modification.

  • user_consent_management

    Safety policy for user consent management.

  • legal_terms_and_agreements

    Safety policy for legal terms and agreements.

enable_prompt_injection_detection boolean (optional)

Whether enable the prompt injection detection check on computer-use request.

environment enum (string) (optional)

The environment being operated.

مقادیر ممکن:

  • browser

    Operates in a web browser.

  • mobile

    Operates in a mobile environment.

  • desktop

    Operates in a desktop environment.

excluded_predefined_functions array (string) (optional)

The list of predefined functions that are excluded from the model call.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "computer_use" .

جستجوی فایل

ابزاری که می‌تواند توسط مدل برای جستجوی فایل‌ها استفاده شود.

آرایه file_search_store_names (رشته‌ای) (اختیاری)

جستجوی فایل، نام‌های فروشگاه را برای جستجو ذخیره می‌کند.

رشته metadata_filter (اختیاری)

فیلتر فراداده برای اعمال روی اسناد و تکه‌های بازیابی معنایی.

عدد صحیح top_k (اختیاری)

تعداد تکه‌های بازیابی معنایی که باید بازیابی شوند.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_search" تنظیم شود.

عملکرد

ابزاری که می‌تواند توسط مدل مورد استفاده قرار گیرد.

رشته توضیحات (اختیاری)

شرحی از تابع.

رشته نام (اختیاری)

نام تابع.

پارامتر شیء (اختیاری)

طرحواره JSON برای پارامترهای تابع.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "function" تنظیم شود.

گوگل مپ

ابزاری که می‌تواند توسط مدل برای فراخوانی نقشه‌های گوگل استفاده شود.

enable_widget بولی (اختیاری)

اینکه آیا در نتیجه فراخوانی ابزار، توکن زمینه ویجت برگردانده شود یا خیر.

شماره عرض جغرافیایی (اختیاری)

عرض جغرافیایی محل کاربر.

شماره طول جغرافیایی (اختیاری)

طول جغرافیایی موقعیت مکانی کاربر.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_maps" تنظیم شود.

جستجوی گوگل

ابزاری که می‌تواند توسط مدل برای جستجو در گوگل استفاده شود.

آرایه search_types (enum (رشته)) (اختیاری)

انواع زمینه‌سازی جستجو برای فعال‌سازی.

مقادیر ممکن:

  • web_search

    تنظیم این فیلد، جستجوی وب را فعال می‌کند. فقط نتایج متنی برگردانده می‌شوند.

  • image_search

    تنظیم این فیلد، جستجوی تصویر را فعال می‌کند. بایت‌های تصویر برگردانده می‌شوند.

  • enterprise_web_search

    Setting this field enables enterprise web search.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_search" تنظیم شود.

McpServer

A MCPServer is a server that can be called by the model to perform actions.

allowed_tools array (AllowedTools) (optional)

The allowed tools.

The configuration for allowed tools.

فیلدها

mode enum (string) (optional)

The mode of the tool choice.

مقادیر ممکن:

  • auto

    انتخاب خودکار ابزار.

  • any

    هر انتخاب ابزاری.

  • none

    بدون انتخاب ابزار.

  • validated

    انتخاب ابزار معتبر.

tools array (string) (optional)

The names of the allowed tools.

headers object (optional)

Optional: Fields for authentication headers, timeouts, etc., if needed.

رشته نام (اختیاری)

The name of the MCPServer.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "mcp_server" .

رشته آدرس اینترنتی (اختیاری)

The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"

بازیابی

A tool that can be used by the model to retrieve files.

exa_ai_search_config ExaAISearchConfig (optional)

Used to specify configuration for ExaAISearch.

Used to specify configuration for ExaAISearch.

فیلدها

api_key string (optional)

Required. The API key for ExaAiSearch.

custom_config object (optional)

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

parallel_ai_search_config ParallelAISearchConfig (optional)

Used to specify configuration for ParallelAISearch.

Used to specify configuration for ParallelAISearch.

فیلدها

api_key string (optional)

Optional. The API key for ParallelAiSearch.

custom_config object (optional)

Optional. Custom configs for ParallelAiSearch.

rag_store_config RagStoreConfig (optional)

Used to specify configuration for RagStore.

Use to specify configuration for RAG Store.

فیلدها

rag_resources array (RagResource) (optional)

Optional. The representation of the rag source.

The definition of the Rag resource.

فیلدها

rag_corpus string (optional)

Optional. RagCorpora resource name.

rag_file_ids array (string) (optional)

Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.

rag_retrieval_config RagRetrievalConfig (optional)

Optional. The retrieval config for the Rag query.

Specifies the context retrieval config.

فیلدها

filter Filter (optional)

Optional. Config for filters.

Config for filters.

فیلدها

رشته metadata_filter (اختیاری)

Optional. String for metadata filtering.

vector_distance_threshold number (optional)

Optional. Only returns contexts with vector distance smaller than the threshold.

vector_similarity_threshold number (optional)

Optional. Only returns contexts with vector similarity larger than the threshold.

hybrid_search HybridSearch (optional)

Optional. Config for Hybrid Search.

Config for Hybrid Search.

فیلدها

alpha number (optional)

Optional. Alpha value controls the weight between dense and sparse vector search results.

ranking Ranking (optional)

Optional. Config for ranking and reranking.

Config for ranking and reranking.

عدد صحیح top_k (اختیاری)

Optional. The number of contexts to retrieve.

retrieval_types array (enum (string)) (optional)

The types of file retrieval to enable.

مقادیر ممکن:

  • rag_store
  • exa_ai_search
  • parallel_ai_search
نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "retrieval" .

متن آدرس

ابزاری که می‌تواند توسط مدل برای دریافت متن URL استفاده شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_context" تنظیم شود.

رشته به‌روزرسانی‌شده (اختیاری)

فقط خروجی. زمانی که پاسخ آخرین بار در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) به‌روزرسانی شده است.

کاربرد (اختیاری )

فقط خروجی. آمار مربوط به میزان استفاده از توکن درخواست تعامل.

آمار مربوط به میزان استفاده از توکن درخواست تعامل.

فیلدها

آرایه cached_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک میزان استفاده از توکن‌های ذخیره‌شده بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه grounding_tool_count (GroundingToolCount) (اختیاری)

تعداد ابزار اتصال به زمین

تعداد ابزار اتصال به زمین مهم است.

فیلدها

شمارش عدد صحیح (اختیاری)

تعداد ابزار اتصال به زمین مهم است.

نوع enum (رشته) (اختیاری)

نوع ابزار اتصال زمین مرتبط با شمارش.

مقادیر ممکن:

  • google_search

    اتصال به زمین با جستجوی وب و جستجوی تصویر گوگل، و اتصال به زمین وب برای سازمان‌ها.

  • google_maps

    اتصال به زمین با نقشه‌های گوگل.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

آرایه input_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک استفاده از توکن ورودی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه output_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک استفاده از توکن خروجی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه tool_use_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک میزان استفاده از توکن‌های ابزار بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

عدد صحیح total_cached_tokens (اختیاری)

تعداد توکن‌ها در بخش ذخیره‌شده‌ی اعلان (محتوای ذخیره‌شده).

عدد صحیح total_input_tokens (اختیاری)

تعداد توکن‌ها در اعلان (زمینه).

total_output_tokens عدد صحیح (اختیاری)

تعداد کل توکن‌ها در تمام پاسخ‌های تولید شده.

total_thought_tokens عدد صحیح (اختیاری)

تعداد توکن‌های افکار برای مدل‌های تفکر.

عدد صحیح total_tokens (اختیاری)

تعداد کل توکن‌ها برای درخواست تعامل (درخواست + پاسخ‌ها + سایر توکن‌های داخلی).

عدد صحیح total_tool_use_tokens (اختیاری)

تعداد توکن‌های موجود در اعلان(های) استفاده از ابزار.

webhook_config WebhookConfig (optional)

Optional. Webhook configuration for receiving notifications when the interaction completes.

Message for configuring webhook events for a request.

فیلدها

uris array (string) (optional)

Optional. If set, these webhook URIs will be used for webhook events instead of the registered webhooks.

user_metadata object (optional)

Optional. The user metadata that will be returned on each event emission to the webhooks.

last_pause_time string (optional)

Output only. The time when the trigger was last paused.

last_resume_time string (optional)

Output only. The time when the trigger was last resumed.

last_run_time string (optional)

Output only. The time when the trigger was last run.

max_consecutive_failures integer (optional)

Optional. The maximum number of consecutive failures allowed before the trigger is automatically paused (status becomes ERROR).

next_run_time string (optional)

Output only. The time when the trigger is scheduled to run next.

رشته‌ی previous_interaction_id (اختیاری)

Output only. The ID of the last interaction created by this trigger.

schedule string (optional)

Required. The cron schedule on which the trigger should run. Standard cron format.

شمارش وضعیت (رشته) (اختیاری)

Output only. The current status of the trigger.

مقادیر ممکن:

  • active

    The trigger is active and will fire on schedule.

  • paused

    The trigger is paused and will not fire.

  • error

    The trigger has entered an error state due to consecutive failures.

time_zone string (optional)

Required. Time zone in which the schedule should be interpreted.

update_time string (optional)

Output only. The time when the trigger was last updated.

مثال

پاسخ نمونه 

{
  "consecutive_failure_count": 0,
  "create_time": "string",
  "display_name": "string",
  "environment_id": "string",
  "execution_timeout_seconds": 0,
  "id": "string",
  "interaction": {
    "created": "2025-12-04T15:01:45Z",
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3.6-flash",
    "object": "interaction",
    "status": "completed",
    "steps": [
      {
        "type": "model_output",
        "content": [
          {
            "type": "text",
            "text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?"
          }
        ]
      }
    ],
    "updated": "2025-12-04T15:01:45Z",
    "usage": {
      "input_tokens_by_modality": [
        {
          "modality": "text",
          "tokens": 7
        }
      ],
      "total_cached_tokens": 0,
      "total_input_tokens": 7,
      "total_output_tokens": 23,
      "total_thought_tokens": 49,
      "total_tokens": 79,
      "total_tool_use_tokens": 0
    }
  },
  "last_pause_time": "string",
  "last_resume_time": "string",
  "last_run_time": "string",
  "max_consecutive_failures": 0,
  "next_run_time": "string",
  "previous_interaction_id": "string",
  "schedule": "string",
  "status": "active",
  "time_zone": "string",
  "update_time": "string"
}

DeleteTrigger

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

Deletes a trigger.

پاسخ

در صورت موفقیت، پاسخ خالی است.

مثال

منابع

ماشه

A trigger configuration that is scheduled to run an agent.

فیلدها

consecutive_failure_count integer (optional)

Output only. The number of consecutive failures that have occurred since the last successful execution.

create_time string (optional)

Output only. The time when the trigger was created.

display_name string (optional)

Optional. The display name of the trigger.

environment_id string (optional)

Optional. The environment ID for the trigger execution.

execution_timeout_seconds integer (optional)

Optional. The execution timeout for the triggered interaction.

رشته شناسه (اختیاری)

Required. Output only. Identifier. The ID of the trigger.

interaction Interaction (optional)

Required. The interaction request template to be executed.

منبع تعامل.

فیلدها

گزینه عامل (اختیاری)

نام «عامل» مورد استفاده برای ایجاد تعامل.

عاملی که باید با آن تعامل داشت.

مقادیر ممکن

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

    نماینده تحقیقات عمیق جمینی

  • deep-research-preview-04-2026

    نماینده تحقیقات عمیق جمینی

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

    مامور مکس تحقیقات عمیق جمینی

  • antigravity-preview-05-2026

    از عامل مدیریت‌شده‌ی Antigravity برای انجام وظایف چند مرحله‌ای که نیاز به استدلال، عملیات فایل و استفاده از ابزار دارند، استفاده کنید.

agent_config object (optional)

پارامترهای پیکربندی برای تعامل عامل.

انواع ممکن

Polymorphic discriminator: type

AntigravityAgentConfig

Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration.

رشته‌ی max_total_tokens (اختیاری)

حداکثر مجموع توکن‌ها برای اجرای عامل.

رشته مدل (اختیاری)

The model to use for agent reasoning.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "antigravity" .

CodeMenderAgentConfig

Configuration for the CodeMender agent.

find_request FindRequest (optional)

Parameters for finding vulnerabilities.

Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase.

فیلدها

رشته توضیحات (اختیاری)

Additional context or custom instructions provided by the user to guide the vulnerability analysis.

finding_id string (optional)

The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability.

mode enum (string) (optional)

The mode of the find session.

مقادیر ممکن:

  • scan

    Fast scan using only the initial classifier.

  • verify

    Performs classification followed by detailed investigation.

source_files array (FileContent) (optional)

A list of source files to provide as context for the scan.

Content of a single file in the codebase.

فیلدها

content string (optional)

The UTF-8 encoded text content of the file.

path string (optional)

The relative path of the file from the project root.

fix_request FixRequest (optional)

Parameters for fixing vulnerabilities.

Request parameters specific to FIX sessions, used for generating and validating security patches.

فیلدها

رشته توضیحات (اختیاری)

Additional context or custom instructions provided by the user to guide the patch generation process.

finding_id string (optional)

The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.

source_files array (FileContent) (optional)

A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability.

Content of a single file in the codebase.

فیلدها

content string (optional)

The UTF-8 encoded text content of the file.

path string (optional)

The relative path of the file from the project root.

رشته مدل (اختیاری)

The name of the model to use for the CodeMender agent. One CodeMender session will only use one model.

session_config SessionConfig (optional)

Optional session-specific configurations to override default agent behavior.

The configuration of CodeMender sessions.

فیلدها

max_rounds integer (optional)

The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.

session_id string (optional)

Parameter for grouping multiple interactions that belong to the same CodeMender session.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "code-mender" .

DeepResearchAgentConfig

Configuration for the Deep Research agent.

collaborative_planning boolean (optional)

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.

enable_bigquery_tool boolean (optional)

Enables bigquery tool for the Deep Research agent.

خلاصه‌های تفکر ( اختیاری)

اینکه آیا خلاصه نظرات در پاسخ گنجانده شود یا خیر.

مقادیر ممکن

  • auto

    خلاصه‌های تفکر خودکار

  • none

    بدون خلاصه نویسی فکری.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "deep-research" .

visualization enum (string) (optional)

Whether to include visualizations in the response.

مقادیر ممکن:

  • off

    Do not include visualizations.

  • auto

    Automatically include visualizations.

DynamicAgentConfig

پیکربندی برای عامل‌های پویا

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "dynamic" تنظیم شود.

رشته ایجاد شده (اختیاری)

فقط خروجی. زمانی که پاسخ در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) ایجاد شده است.

environment EnvironmentConfig or string (optional)

The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.

Configuration for a custom environment.

فیلدها

environment_id string (optional)

Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.

network EnvironmentNetworkEgressAllowlist or enum (string) (optional)

Network configuration for the environment.

Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.

انواع ممکن

شیء

Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.

allowlist array (AllowlistEntry) (optional)

List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.

A single domain allowlist rule with optional header injection.

فیلدها

domain string (optional)

Domain to allow outbound requests to. Supports wildcards (eg '*.googleapis.com'). Use '*' to allow all domains.

transform array (object) or object (optional)

Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.

رشته

Turns all network off.

مقادیر ممکن

  • disabled

    Turns all network off.

sources array (Source) (optional)

هیچ توضیحی ارائه نشده است.

A source to be mounted into the environment.

فیلدها

content string (optional)

The inline content if `type` is `INLINE`.

encoding string (optional)

Optional encoding for inline content (eg `base64`).

رشته منبع (اختیاری)

The source of the environment. For Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path.

target string (optional)

Where the source should appear in the environment.

نوع enum (رشته) (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • gcs

    A Cloud Storage bucket.

  • inline

    Inline content.

  • repository

    A generic repository. The protocol prefix in the source URL identifies the provider (eg, github://, gcs://).

  • skill_registry

    A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

Always set to "remote" .

environment_id string (optional)

Output only. The environment ID for the interaction. Only populated if environment config is set in the request.

آرایه خطاها (Error) (اختیاری)

فقط خروجی. خطاهای تشخیصی / خطاهای پلتفرم که در تعامل ثبت شده‌اند.

پیام خطا از یک تعامل.

فیلدها

رشته کد (اختیاری)

یک URI که نوع خطا را مشخص می‌کند.

رشته پیام (اختیاری)

یک پیام خطا که برای انسان قابل خواندن باشد.

رشته شناسه (اختیاری)

الزامی. فقط خروجی. یک شناسه منحصر به فرد برای تکمیل تعامل.

پیش‌فرض‌ها به:

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

ورودی برای تعامل.

شیء برچسب‌ها (اختیاری)

برچسب‌هایی با فراداده‌های تعریف‌شده توسط کاربر برای درخواست.

مدل ModelOption (اختیاری)

نام «مدل» مورد استفاده برای تولید تعامل.

مدلی که اعلان شما را تکمیل می‌کند.\n\nبرای جزئیات بیشتر به [models](https://ai.google.dev/gemini-api/docs/models) مراجعه کنید.

مقادیر ممکن

  • gemini-2.5-flash

    اولین مدل استدلال ترکیبی ما که از یک پنجره زمینه ۱ میلیون توکنی پشتیبانی می‌کند و دارای بودجه‌های تفکر است.

  • gemini-2.5-pro

    Our state-of-the-art multipurpose model, which excels at coding and complex reasoning tasks.

  • gemma-4-26b-a4b-it

    Gemma 4 26B A4B IT

  • gemma-4-31b-it

    Gemma 4 31B IT

  • gemini-flash-latest

    Latest release of Gemini Flash

  • gemini-flash-lite-latest

    Latest release of Gemini Flash-Lite

  • gemini-pro-latest

    Latest release of Gemini Pro

  • gemini-2.5-flash-lite

    کوچکترین و مقرون به صرفه ترین مدل ما، ساخته شده برای استفاده در مقیاس بزرگ.

  • gemini-2.5-flash-image

    مدل تولید تصویر بومی ما، که برای سرعت، انعطاف‌پذیری و درک متنی بهینه شده است. ورودی و خروجی متن با همان قیمت ۲.۵ فلش ارائه می‌شود.

  • gemini-3-flash-preview

    هوشمندترین مدل ما که برای سرعت ساخته شده است، هوش مرزی را با جستجو و ردیابی برتر ترکیب می‌کند.

  • gemini-3.1-pro-preview

    Our latest SOTA reasoning model with unprecedented depth and nuance, and powerful multimodal understanding and coding capabilities.

  • gemini-3.1-pro-preview-customtools

    Gemini 3.1 Pro Preview optimized for custom tool usage

  • gemini-3.1-flash-lite

    مقرون‌به‌صرفه‌ترین مدل ما، بهینه‌شده برای وظایف عامل‌محور با حجم بالا، ترجمه و پردازش داده‌های ساده.

  • gemini-3-pro-image

    Gemini 3 Pro Image

  • nano-banana-pro-preview

    Gemini 3 Pro Image Preview

  • gemini-3.1-flash-image

    Gemini 3.1 Flash Image.

  • gemini-3.5-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • gemini-3.6-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • gemini-3.7-flash

    هوشمندترین مدل ما برای عملکرد مرزی پایدار در وظایف عامل‌دار و کدنویسی.

  • lyria-3-clip-preview

    Our low-latency, music generation model optimized for high-fidelity audio clips and precise rhythmic control.

  • lyria-3-pro-preview

    Our advanced, full-song generative model with deep compositional understanding, optimized for precise structural control and complex transitions across diverse musical styles.

  • gemini-robotics-er-1.6-preview

    Gemini Robotics-ER 1.6 Preview

  • gemini-robotics-er-2-preview

    Gemini Robotics Embodied Reasoning 2 Preview

محتوای صوتی output_audio (اختیاری)

آخرین صدای تولید شده توسط مدل در پاسخ به درخواست فعلی. توجه: این توسط SDK اضافه شده است.

یک بلوک محتوای صوتی.

فیلدها

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای تصویر خروجی (اختیاری)

آخرین تصویری که توسط مدل در پاسخ به درخواست فعلی تولید شده است. توجه: این تصویر توسط SDK اضافه شده است.

یک بلوک محتوای تصویر.

فیلدها

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

رشته‌ی output_text (اختیاری)

متن به هم پیوسته از آخرین خروجی مدل در پاسخ به درخواست فعلی. توجه: این توسط SDK اضافه شده است.

output_video VideoContent (optional)

The last video generated by the model in response to the current request. Note: this is added by the SDK.

A video content block.

فیلدها

رشته داده (اختیاری)

The video content.

mime_type enum (رشته) (اختیاری)

The mime type of the video.

مقادیر ممکن:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

processing MediaProcessing or enum (string) (optional)

How the model processes this video for understanding.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (اختیاری)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

رشته uri (اختیاری)

The URI of the video.

رشته‌ی previous_interaction_id (اختیاری)

شناسه‌ی تعامل قبلی، در صورت وجود.

response_format ResponseFormat or array (ResponseFormat) (optional)

تأکید می‌کند که پاسخ تولید شده یک شیء JSON است که با طرحواره JSON مشخص شده در این فیلد مطابقت دارد.

انواع ممکن

AudioResponseFormat

Configuration for audio output format.

bit_rate integer (optional)

Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).

delivery enum (string) (optional)

The delivery mode for the audio output.

مقادیر ممکن:

  • inline

    Audio data is returned inline in the response.

  • uri

    Audio data is returned as a URI.

mime_type enum (رشته) (اختیاری)

The MIME type of the audio output.

مقادیر ممکن:

  • audio/mp3

    MP3 audio format.

  • audio/ogg_opus

    OGG Opus audio format.

  • audio/l16

    Raw PCM (L16) audio format.

  • audio/wav

    WAV audio format.

  • audio/alaw

    A-law audio format.

  • audio/mulaw

    Mu-law audio format.

عدد صحیح sample_rate (اختیاری)

Sample rate in Hz.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

ImageResponseFormat

Configuration for image output format.

aspect_ratio enum (string) (optional)

The aspect ratio for the image output.

مقادیر ممکن:

  • 1:1

    نسبت تصویر ۱:۱.

  • 2:3

    2:3 aspect ratio.

  • 3:2

    3:2 aspect ratio.

  • 3:4

    3:4 aspect ratio.

  • 4:3

    نسبت تصویر ۴:۳.

  • 4:5

    4:5 aspect ratio.

  • 5:4

    5:4 aspect ratio.

  • 9:16

    نسبت تصویر ۹:۱۶

  • 16:9

    نسبت تصویر ۱۶:۹.

  • 21:9

    21:9 aspect ratio.

  • 1:8

    1:8 aspect ratio.

  • 8:1

    8:1 aspect ratio.

  • 1:4

    1:4 aspect ratio.

  • 4:1

    4:1 aspect ratio.

delivery enum (string) (optional)

The delivery mode for the image output.

مقادیر ممکن:

  • inline

    Image data is returned inline in the response.

  • uri

    Image data is returned as a URI.

image_size enum (string) (optional)

The size of the image output.

مقادیر ممکن:

  • 512

    512px image size.

  • 1K

    1K image size.

  • 2K

    2K image size.

  • 4K

    4K image size.

mime_type enum (رشته) (اختیاری)

The MIME type of the image output.

مقادیر ممکن:

  • image/jpeg

    JPEG image format.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

TextResponseFormat

Configuration for text output format.

mime_type enum (رشته) (اختیاری)

The MIME type of the text output.

مقادیر ممکن:

  • application/json

    JSON output format.

  • text/plain

    Plain text output format.

schema object (optional)

The JSON schema that the output should conform to. Only applicable when mime_type is application/json.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

VideoResponseFormat

Configuration for video output format.

aspect_ratio enum (string) (optional)

The aspect ratio for the video output.

مقادیر ممکن:

  • 16:9

    نسبت تصویر ۱۶:۹.

  • 9:16

    نسبت تصویر ۹:۱۶

delivery enum (string) (optional)

The delivery mode for the video output.

مقادیر ممکن:

  • inline

    Video data is returned inline in the response.

  • uri

    Video data is returned as a URI.

duration string (optional)

The duration for the video output.

gcs_uri string (optional)

The Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.

resolution enum (string) (optional)

The video output resolution. Defaults to 720p.

مقادیر ممکن:

  • 360p

    360p resolution.

  • 720p

    720p resolution.

  • 1080p

    1080p resolution.

  • 4k

    وضوح تصویر 4K.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

آرایه safety_settings (SafetySetting) (اختیاری)

تنظیمات ایمنی برای تعامل.

A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.

فیلدها

method enum (string) (optional)

Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.

مقادیر ممکن:

  • severity

    The harm block method uses both probability and severity scores.

  • probability

    The harm block method uses the probability score.

threshold enum (string) (optional)

Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.

مقادیر ممکن:

  • block_low_and_above

    Block content with a low harm probability or higher.

  • block_medium_and_above

    Block content with a medium harm probability or higher.

  • block_only_high

    Block content with a high harm probability.

  • block_none

    Do not block any content, regardless of its harm probability.

  • off

    Turn off the safety filter entirely.

type HarmCategory (optional)

Required. The type of harm category to be blocked.

مقادیر ممکن

  • hate_speech

    Content that promotes violence or incites hatred against individuals or groups based on certain attributes.

  • dangerous_content

    Content that promotes, facilitates, or enables dangerous activities.

  • harassment

    Abusive, threatening, or content intended to bully, torment, or ridicule.

  • sexually_explicit

    Content that contains sexually explicit material.

  • civic_integrity

    Deprecated: Election filter is not longer supported. The harm category is civic integrity.

  • image_hate

    Images that contain hate speech.

  • image_dangerous_content

    Images that contain dangerous content.

  • image_harassment

    Images that contain harassment.

  • image_sexually_explicit

    Images that contain sexually explicit content.

  • jailbreak

    Prompts designed to bypass safety filters.

service_tier ServiceTier (optional)

The service tier for the interaction.

مقادیر ممکن

  • flex

    Flex service tier.

  • standard

    Standard service tier.

  • priority

    Priority service tier.

  • deferred

    Deferred service tier.

شمارش وضعیت (رشته) (اختیاری)

الزامی. فقط خروجی. وضعیت تعامل.

مقادیر ممکن:

  • in_progress

    تعامل در حال انجام است.

  • requires_action

    این تعامل نیاز به اقدام/ورودی از سوی کاربر دارد.

  • completed

    تعامل تکمیل شده است.

  • failed

    تعامل شکست خورد.

  • cancelled

    تعامل لغو شد.

  • incomplete

    تعامل تکمیل شده است، اما شامل نتایج ناقص است (مثلاً رسیدن به max_tokens).

  • budget_exceeded

    The interaction was halted because the token budget was exceeded.

  • queued

    The interaction is queued, waiting for processing.

steps array (Step) (optional)

فقط خروجی. مراحلی که تعامل را تشکیل می‌دهند، زمانی که در پاسخ گنجانده شوند.

A step in the interaction.

انواع ممکن

CodeExecutionCallStep

Code execution call step.

arguments CodeExecutionCallStepArguments (required)

Required. The arguments to pass to the code execution.

آرگومان‌هایی که باید به اجرای کد ارسال شوند.

فیلدها

رشته کد (اختیاری)

کدی که قرار است اجرا شود.

شمارش زبان (رشته) (اختیاری)

زبان برنامه‌نویسی «کد».

مقادیر ممکن:

  • python

    پایتون >= 3.10، با numpy و simpy در دسترس است.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution_call" تنظیم شود.

CodeExecutionResultStep

Code execution result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the code execution resulted in an error.

رشته نتیجه (الزامی)

Required. The output of the code execution.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution_result" تنظیم شود.

FileSearchCallStep

File Search call step.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "file_search_call" .

FileSearchResultStep

File Search result step.

call_id string (required)

Required. ID to match the ID from the function call block.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "file_search_result" .

FunctionCallStep

A function tool call step.

arguments object (required)

Required. The arguments to pass to the function.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

name string (required)

Required. The name of the tool to call.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "function_call" .

FunctionResultStep

Result of a function tool call.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the tool call resulted in an error.

رشته نام (اختیاری)

The name of the tool that was called.

result array (ImageContent or TextContent) or object or string (required)

Required. The result of the tool call.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "function_result" .

GoogleMapsCallStep

Google Maps call step.

arguments GoogleMapsCallStepArguments (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

فیلدها

queries array (string) (optional)

The queries to be executed.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_maps_call" .

GoogleMapsResultStep

Google Maps result step.

call_id string (required)

Required. ID to match the ID from the function call block.

result array (GoogleMapsResultItem) (required)

هیچ توضیحی ارائه نشده است.

The result of the Google Maps.

فیلدها

places array (GoogleMapsResultPlaces) (optional)

هیچ توضیحی ارائه نشده است.

فیلدها

رشته نام (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته place_id (اختیاری)

هیچ توضیحی ارائه نشده است.

آرایه review_snippets (ReviewSnippet) (اختیاری)

هیچ توضیحی ارائه نشده است.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

رشته آدرس اینترنتی (اختیاری)

هیچ توضیحی ارائه نشده است.

widget_context_token string (optional)

هیچ توضیحی ارائه نشده است.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_maps_result" .

GoogleSearchCallStep

Google Search call step.

arguments GoogleSearchCallStepArguments (required)

Required. The arguments to pass to Google Search.

The arguments to pass to Google Search.

فیلدها

queries array (string) (optional)

Web search queries for the following-up web search.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

search_type enum (string) (optional)

The type of search grounding enabled.

مقادیر ممکن:

  • web_search

    تنظیم این فیلد، جستجوی وب را فعال می‌کند. فقط نتایج متنی برگردانده می‌شوند.

  • image_search

    تنظیم این فیلد، جستجوی تصویر را فعال می‌کند. بایت‌های تصویر برگردانده می‌شوند.

  • enterprise_web_search

    Setting this field enables enterprise web search.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_search_call" .

GoogleSearchResultStep

Google Search result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the Google Search resulted in an error.

result array (GoogleSearchResultItem) (required)

Required. The results of the Google Search.

The result of the Google Search.

فیلدها

search_suggestions string (optional)

Web content snippet that can be embedded in a web page or an app webview.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "google_search_result" .

McpServerToolCallStep

MCPServer tool call step.

arguments object (required)

Required. The JSON object of arguments for the function.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

name string (required)

Required. The name of the tool which was called.

server_name string (required)

Required. The name of the used MCP server.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "mcp_server_tool_call" .

McpServerToolResultStep

MCPServer tool result step.

call_id string (required)

Required. ID to match the ID from the function call block.

رشته نام (اختیاری)

Name of the tool which is called for this specific tool call.

result array (ImageContent or TextContent) or object or string (required)

Required. The output from the MCP server call. Can be simple text or rich content.

server_name string (optional)

The name of the used MCP server.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "mcp_server_tool_result" .

ModelOutputStep

Output generated by the model.

content array (Content) (optional)

هیچ توضیحی ارائه نشده است.

محتوای پاسخ.

انواع ممکن

محتوای صوتی

یک بلوک محتوای صوتی.

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای سند

یک بلوک محتوای سند.

رشته داده (اختیاری)

محتوای سند.

mime_type enum (رشته) (اختیاری)

نوع MIME سند.

مقادیر ممکن:

  • application/pdf

    فرمت سند PDF

  • text/csv

    فرمت سند CSV

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "document" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) سند.

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

end_offset string (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string (optional)

Optional. Speaker label for this word (eg "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

start_offset string (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string (optional)

The transcribed word.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "word_info" .

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

VideoContent

A video content block.

رشته داده (اختیاری)

The video content.

mime_type enum (رشته) (اختیاری)

The mime type of the video.

مقادیر ممکن:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

processing MediaProcessing or enum (string) (optional)

How the model processes this video for understanding.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

رشته uri (اختیاری)

The URI of the video.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "model_output" .

ThoughtStep

A thought step.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

summary array (ThoughtSummaryContent) (optional)

A summary of the thought.

انواع ممکن

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

end_offset string (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string (optional)

Optional. Speaker label for this word (eg "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

start_offset string (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string (optional)

The transcribed word.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "word_info" .

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "thought" .

UrlContextCallStep

URL context call step.

arguments UrlContextCallArguments (required)

Required. The arguments to pass to the URL context.

The arguments to pass to the URL context.

فیلدها

urls array (string) (optional)

The URLs to fetch.

رشته شناسه (الزامی)

Required. A unique ID for this specific tool call.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "url_context_call" .

UrlContextResultStep

URL context result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error نوع داده بولی (اختیاری)

Whether the URL context resulted in an error.

result array (UrlContextResult) (required)

Required. The results of the URL context.

The result of the URL context.

فیلدها

شمارش وضعیت (رشته) (اختیاری)

The status of the URL retrieval.

مقادیر ممکن:

  • success

    Url retrieval is successful.

  • error

    Url retrieval is failed due to error.

  • paywall

    Url retrieval is failed because the content is behind paywall.

  • unsafe

    Url retrieval is failed because the content is unsafe.

رشته آدرس اینترنتی (اختیاری)

The URL that was fetched.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "url_context_result" .

UserInputStep

Input provided by the user.

content array (Content) (optional)

هیچ توضیحی ارائه نشده است.

محتوای پاسخ.

انواع ممکن

محتوای صوتی

یک بلوک محتوای صوتی.

عدد صحیح کانال‌ها (اختیاری)

تعداد کانال‌های صوتی

رشته داده (اختیاری)

محتوای صوتی.

mime_type enum (رشته) (اختیاری)

نوع مایم صدا.

مقادیر ممکن:

  • audio/wav

    فرمت صوتی WAV

  • audio/mp3

    فرمت صوتی MP3

  • audio/aiff

    فرمت صوتی AIFF

  • audio/aac

    فرمت صوتی AAC

  • audio/ogg

    فرمت صوتی OGG

  • audio/flac

    فرمت صوتی FLAC

  • audio/mpeg

    فرمت صوتی MPEG

  • audio/m4a

    فرمت صوتی M4A

  • audio/l16

    فرمت صوتی L16

  • audio/opus

    فرمت صوتی OPUS

  • audio/alaw

    فرمت صوتی ALAW

  • audio/mulaw

    فرمت صوتی MULAW

عدد صحیح sample_rate (اختیاری)

نرخ نمونه‌برداری صدا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "audio" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) فایل صوتی.

محتوای سند

یک بلوک محتوای سند.

رشته داده (اختیاری)

محتوای سند.

mime_type enum (رشته) (اختیاری)

نوع MIME سند.

مقادیر ممکن:

  • application/pdf

    فرمت سند PDF

  • text/csv

    فرمت سند CSV

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "document" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) سند.

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

محتوای تصویر.

mime_type enum (رشته) (اختیاری)

نوع مایم تصویر.

مقادیر ممکن:

  • image/png

    فرمت تصویر PNG

  • image/jpeg

    فرمت تصویر JPEG

  • image/webp

    فرمت تصویر WebP

  • image/heic

    فرمت تصویر HEIC

  • image/heif

    فرمت تصویر HEIF

  • image/gif

    فرمت تصویر GIF

  • image/bmp

    فرمت تصویر BMP

  • image/tiff

    فرمت تصویر TIFF

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "image" تنظیم شود.

رشته uri (اختیاری)

آدرس اینترنتی (URI) تصویر.

محتوای متن

یک بلوک محتوای متنی.

آرایه حاشیه‌نویسی‌ها (Annotation) (اختیاری)

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

انواع ممکن

استناد به فایل

حاشیه‌نویسی استناد به فایل.

شیء custom_metadata (اختیاری)

فراداده‌های ارائه شده توسط کاربر در مورد متن بازیابی شده.

رشته document_uri (اختیاری)

آدرس اینترنتی (URI) فایل.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام فایل (اختیاری)

نام فایل.

رشته media_id (اختیاری)

شناسه رسانه در صورت استناد به تصویر، در صورت لزوم.

عدد صحیح شماره صفحه (اختیاری)

شماره صفحه سند ذکر شده، در صورت وجود.

رشته منبع (اختیاری)

منبع برای بخشی از متن ذکر شده است.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_citation" تنظیم شود.

استناد به مکان

حاشیه‌نویسی برای استناد به مکان.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته نام (اختیاری)

عنوان مکان.

رشته place_id (اختیاری)

شناسه مکان، با فرمت `places/{place_id}`.

آرایه review_snippets (ReviewSnippet) (اختیاری)

گزیده‌هایی از نظرات که برای تولید پاسخ در مورد ویژگی‌های یک مکان مشخص در نقشه‌های گوگل استفاده می‌شوند.

بخشی از نقد کاربر را که به سوالی در مورد ویژگی‌های یک مکان خاص در نقشه‌های گوگل پاسخ می‌دهد، در بر می‌گیرد.

فیلدها

رشته review_id (اختیاری)

شناسه‌ی قطعه نقد و بررسی.

رشته عنوان (اختیاری)

عنوان نقد.

رشته آدرس اینترنتی (اختیاری)

لینکی که مربوط به نظر کاربر در نقشه گوگل باشد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "place_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

مرجع URI آن مکان.

استناد به آدرس اینترنتی

حاشیه‌نویسی استناد URL.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

رشته عنوان (اختیاری)

عنوان URL.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_citation" تنظیم شود.

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL).

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

end_offset string (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string (optional)

Optional. Speaker label for this word (eg "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

عدد صحیح start_index (اختیاری)

شروع بخش پاسخی که به این منبع نسبت داده می‌شود. اندیس، شروع بخش را نشان می‌دهد که بر حسب بایت اندازه‌گیری می‌شود.

start_offset string (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string (optional)

The transcribed word.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "word_info" .

رشته متن (الزامی)

محتوای متن الزامی است.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "text" تنظیم شود.

VideoContent

A video content block.

رشته داده (اختیاری)

The video content.

mime_type enum (رشته) (اختیاری)

The mime type of the video.

مقادیر ممکن:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

processing MediaProcessing or enum (string) (optional)

How the model processes this video for understanding.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن

  • low

    وضوح پایین.

  • medium

    وضوح متوسط.

  • high

    وضوح بالا.

  • ultra_high

    وضوح فوق العاده بالا.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "video" .

رشته uri (اختیاری)

The URI of the video.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "user_input" .

رشته system_instruction (اختیاری)

دستورالعمل سیستم برای تعامل.

tools array (Tool) (optional)

فهرستی از اعلان‌های ابزار که مدل ممکن است در طول تعامل فراخوانی کند.

ابزاری که می‌تواند توسط مدل مورد استفاده قرار گیرد.

انواع ممکن

اجرای کد

ابزاری که می‌تواند توسط مدل برای اجرای کد استفاده شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution" تنظیم شود.

ComputerUse

A tool that can be used by the model to interact with the computer.

disabled_safety_policies array (enum (string)) (optional)

Optional. Disabled safety policies for computer use.

مقادیر ممکن:

  • financial_transactions

    Safety policy for financial transactions.

  • sensitive_data_modification

    Safety policy for sensitive data modification.

  • communication_tool

    Safety policy for communication tools (eg Gmail, Chat, Meet).

  • account_creation

    Safety policy for account creation.

  • data_modification

    Safety policy for data modification.

  • user_consent_management

    Safety policy for user consent management.

  • legal_terms_and_agreements

    Safety policy for legal terms and agreements.

enable_prompt_injection_detection boolean (optional)

Whether enable the prompt injection detection check on computer-use request.

environment enum (string) (optional)

The environment being operated.

مقادیر ممکن:

  • browser

    Operates in a web browser.

  • mobile

    Operates in a mobile environment.

  • desktop

    Operates in a desktop environment.

excluded_predefined_functions array (string) (optional)

The list of predefined functions that are excluded from the model call.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "computer_use" .

جستجوی فایل

ابزاری که می‌تواند توسط مدل برای جستجوی فایل‌ها استفاده شود.

آرایه file_search_store_names (رشته‌ای) (اختیاری)

جستجوی فایل، نام‌های فروشگاه را برای جستجو ذخیره می‌کند.

رشته metadata_filter (اختیاری)

فیلتر فراداده برای اعمال روی اسناد و تکه‌های بازیابی معنایی.

عدد صحیح top_k (اختیاری)

تعداد تکه‌های بازیابی معنایی که باید بازیابی شوند.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_search" تنظیم شود.

عملکرد

ابزاری که می‌تواند توسط مدل مورد استفاده قرار گیرد.

رشته توضیحات (اختیاری)

شرحی از تابع.

رشته نام (اختیاری)

نام تابع.

پارامتر شیء (اختیاری)

طرحواره JSON برای پارامترهای تابع.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "function" تنظیم شود.

گوگل مپ

ابزاری که می‌تواند توسط مدل برای فراخوانی نقشه‌های گوگل استفاده شود.

enable_widget بولی (اختیاری)

اینکه آیا در نتیجه فراخوانی ابزار، توکن زمینه ویجت برگردانده شود یا خیر.

شماره عرض جغرافیایی (اختیاری)

عرض جغرافیایی محل کاربر.

شماره طول جغرافیایی (اختیاری)

طول جغرافیایی موقعیت مکانی کاربر.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_maps" تنظیم شود.

جستجوی گوگل

ابزاری که می‌تواند توسط مدل برای جستجو در گوگل استفاده شود.

آرایه search_types (enum (رشته)) (اختیاری)

انواع زمینه‌سازی جستجو برای فعال‌سازی.

مقادیر ممکن:

  • web_search

    تنظیم این فیلد، جستجوی وب را فعال می‌کند. فقط نتایج متنی برگردانده می‌شوند.

  • image_search

    تنظیم این فیلد، جستجوی تصویر را فعال می‌کند. بایت‌های تصویر برگردانده می‌شوند.

  • enterprise_web_search

    Setting this field enables enterprise web search.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_search" تنظیم شود.

McpServer

A MCPServer is a server that can be called by the model to perform actions.

allowed_tools array (AllowedTools) (optional)

The allowed tools.

The configuration for allowed tools.

فیلدها

mode enum (string) (optional)

The mode of the tool choice.

مقادیر ممکن:

  • auto

    انتخاب خودکار ابزار.

  • any

    هر انتخاب ابزاری.

  • none

    بدون انتخاب ابزار.

  • validated

    انتخاب ابزار معتبر.

tools array (string) (optional)

The names of the allowed tools.

headers object (optional)

Optional: Fields for authentication headers, timeouts, etc., if needed.

رشته نام (اختیاری)

The name of the MCPServer.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "mcp_server" .

رشته آدرس اینترنتی (اختیاری)

The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"

بازیابی

A tool that can be used by the model to retrieve files.

exa_ai_search_config ExaAISearchConfig (optional)

Used to specify configuration for ExaAISearch.

Used to specify configuration for ExaAISearch.

فیلدها

api_key string (optional)

Required. The API key for ExaAiSearch.

custom_config object (optional)

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

parallel_ai_search_config ParallelAISearchConfig (optional)

Used to specify configuration for ParallelAISearch.

Used to specify configuration for ParallelAISearch.

فیلدها

api_key string (optional)

Optional. The API key for ParallelAiSearch.

custom_config object (optional)

Optional. Custom configs for ParallelAiSearch.

rag_store_config RagStoreConfig (optional)

Used to specify configuration for RagStore.

Use to specify configuration for RAG Store.

فیلدها

rag_resources array (RagResource) (optional)

Optional. The representation of the rag source.

The definition of the Rag resource.

فیلدها

rag_corpus string (optional)

Optional. RagCorpora resource name.

rag_file_ids array (string) (optional)

Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.

rag_retrieval_config RagRetrievalConfig (optional)

Optional. The retrieval config for the Rag query.

Specifies the context retrieval config.

فیلدها

filter Filter (optional)

Optional. Config for filters.

Config for filters.

فیلدها

رشته metadata_filter (اختیاری)

Optional. String for metadata filtering.

vector_distance_threshold number (optional)

Optional. Only returns contexts with vector distance smaller than the threshold.

vector_similarity_threshold number (optional)

Optional. Only returns contexts with vector similarity larger than the threshold.

hybrid_search HybridSearch (optional)

Optional. Config for Hybrid Search.

Config for Hybrid Search.

فیلدها

alpha number (optional)

Optional. Alpha value controls the weight between dense and sparse vector search results.

ranking Ranking (optional)

Optional. Config for ranking and reranking.

Config for ranking and reranking.

عدد صحیح top_k (اختیاری)

Optional. The number of contexts to retrieve.

retrieval_types array (enum (string)) (optional)

The types of file retrieval to enable.

مقادیر ممکن:

  • rag_store
  • exa_ai_search
  • parallel_ai_search
نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

Always set to "retrieval" .

متن آدرس

ابزاری که می‌تواند توسط مدل برای دریافت متن URL استفاده شود.

نوع شیء (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_context" تنظیم شود.

رشته به‌روزرسانی‌شده (اختیاری)

فقط خروجی. زمانی که پاسخ آخرین بار در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) به‌روزرسانی شده است.

کاربرد (اختیاری )

فقط خروجی. آمار مربوط به میزان استفاده از توکن درخواست تعامل.

آمار مربوط به میزان استفاده از توکن درخواست تعامل.

فیلدها

آرایه cached_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک میزان استفاده از توکن‌های ذخیره‌شده بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه grounding_tool_count (GroundingToolCount) (اختیاری)

تعداد ابزار اتصال به زمین

تعداد ابزار اتصال به زمین مهم است.

فیلدها

شمارش عدد صحیح (اختیاری)

تعداد ابزار اتصال به زمین مهم است.

نوع enum (رشته) (اختیاری)

نوع ابزار اتصال زمین مرتبط با شمارش.

مقادیر ممکن:

  • google_search

    اتصال به زمین با جستجوی وب و جستجوی تصویر گوگل، و اتصال به زمین وب برای سازمان‌ها.

  • google_maps

    اتصال به زمین با نقشه‌های گوگل.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

آرایه input_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک استفاده از توکن ورودی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه output_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک استفاده از توکن خروجی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

آرایه tool_use_tokens_by_modality (ModalityTokens) (اختیاری)

تفکیک میزان استفاده از توکن‌های ابزار بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن

  • text

    نشان می‌دهد که مدل باید متن را برگرداند.

  • image

    نشان می‌دهد که مدل باید تصاویر را برگرداند.

  • audio

    نشان می‌دهد که مدل باید صدا را برگرداند.

  • video

    نشان می‌دهد که مدل باید ویدیو برگرداند.

  • document

    نشان می‌دهد که مدل باید اسناد را برگرداند.

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

عدد صحیح total_cached_tokens (اختیاری)

تعداد توکن‌ها در بخش ذخیره‌شده‌ی اعلان (محتوای ذخیره‌شده).

عدد صحیح total_input_tokens (اختیاری)

تعداد توکن‌ها در اعلان (زمینه).

total_output_tokens عدد صحیح (اختیاری)

تعداد کل توکن‌ها در تمام پاسخ‌های تولید شده.

total_thought_tokens عدد صحیح (اختیاری)

تعداد توکن‌های افکار برای مدل‌های تفکر.

عدد صحیح total_tokens (اختیاری)

تعداد کل توکن‌ها برای درخواست تعامل (درخواست + پاسخ‌ها + سایر توکن‌های داخلی).

عدد صحیح total_tool_use_tokens (اختیاری)

تعداد توکن‌های موجود در اعلان(های) استفاده از ابزار.

webhook_config WebhookConfig (optional)

Optional. Webhook configuration for receiving notifications when the interaction completes.

Message for configuring webhook events for a request.

فیلدها

uris array (string) (optional)

Optional. If set, these webhook URIs will be used for webhook events instead of the registered webhooks.

user_metadata object (optional)

Optional. The user metadata that will be returned on each event emission to the webhooks.

last_pause_time string (optional)

Output only. The time when the trigger was last paused.

last_resume_time string (optional)

Output only. The time when the trigger was last resumed.

last_run_time string (optional)

Output only. The time when the trigger was last run.

max_consecutive_failures integer (optional)

Optional. The maximum number of consecutive failures allowed before the trigger is automatically paused (status becomes ERROR).

next_run_time string (optional)

Output only. The time when the trigger is scheduled to run next.

رشته‌ی previous_interaction_id (اختیاری)

Output only. The ID of the last interaction created by this trigger.

schedule string (optional)

Required. The cron schedule on which the trigger should run. Standard cron format.

شمارش وضعیت (رشته) (اختیاری)

Output only. The current status of the trigger.

مقادیر ممکن:

  • active

    The trigger is active and will fire on schedule.

  • paused

    The trigger is paused and will not fire.

  • error

    The trigger has entered an error state due to consecutive failures.

time_zone string (optional)

Required. Time zone in which the schedule should be interpreted.

update_time string (optional)

Output only. The time when the trigger was last updated.