رابط برنامهنویسی کاربردی (API) جمینی (Gemini) از تولید محتوا با تصاویر، صدا، کد، ابزارها و موارد دیگر پشتیبانی میکند. برای جزئیات بیشتر در مورد هر یک از این ویژگیها، ادامه مطلب را بخوانید و نمونه کد متمرکز بر وظیفه را بررسی کنید، یا راهنماهای جامع را بخوانید.
- تولید متن
- چشم انداز
- صوتی
- جاسازیها
- زمینه طولانی
- اجرای کد
- حالت JSON
- فراخوانی تابع
- دستورالعملهای سیستم
روش: models.generateContent
با دریافت ورودی GenerateContentRequest ، یک پاسخ مدل تولید میکند. برای اطلاعات دقیق در مورد نحوهی استفاده، به راهنمای تولید متن مراجعه کنید. قابلیتهای ورودی بین مدلها، از جمله مدلهای تنظیمشده، متفاوت است. برای جزئیات بیشتر به راهنمای مدل و راهنمای تنظیم مراجعه کنید.
نقطه پایانی
پستhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContentپارامترهای مسیر
string model الزامی. نام Model که برای تولید تکمیل استفاده میشود.
قالب: models/{model} . این قالب به صورت models/{model} است.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
tools[]object ( Tool ) اختیاری. فهرستی از Tools Model ممکن است برای تولید پاسخ بعدی استفاده کند.
یک Tool ، قطعه کدی است که سیستم را قادر میسازد تا با سیستمهای خارجی تعامل داشته باشد تا یک یا مجموعهای از اقدامات را خارج از دانش و محدوده Model انجام دهد. Tool پشتیبانی شده عبارتند از Function و codeExecution . برای کسب اطلاعات بیشتر به راهنماهای فراخوانی تابع (Function calling) و اجرای کد (Code execution) مراجعه کنید.
toolConfigobject ( ToolConfig ) اختیاری. پیکربندی ابزار برای هر Tool که در درخواست مشخص شده است. برای مثال استفاده به راهنمای فراخوانی تابع مراجعه کنید.
safetySettings[]object ( SafetySetting ) اختیاری. فهرستی از نمونههای منحصر به فرد SafetySetting برای مسدود کردن محتوای ناامن.
این مورد روی GenerateContentRequest.contents و GenerateContentResponse.candidates اعمال خواهد شد. برای هر نوع SafetyCategory نباید بیش از یک تنظیم وجود داشته باشد. API هر محتوا و پاسخی را که آستانههای تعیینشده توسط این تنظیمات را برآورده نکند، مسدود میکند. این لیست، تنظیمات پیشفرض برای هر SafetyCategory مشخصشده در safetySettings را لغو میکند. اگر هیچ SafetySetting برای یک SafetyCategory مشخصشده در لیست وجود نداشته باشد، API از تنظیم ایمنی پیشفرض برای آن دسته استفاده خواهد کرد. دستههای آسیب HARM_CATEGORY_HATE_SPEECH، HARM_CATEGORY_SEXUALLY_EXPLICIT، HARM_CATEGORY_DANGEROUS_CONTENT، HARM_CATEGORY_HARASSMENT، HARM_CATEGORY_CIVIC_INTEGRITY، HARM_CATEGORY_JAILBREAK پشتیبانی میشوند. برای اطلاعات دقیق در مورد تنظیمات ایمنی موجود، به راهنما مراجعه کنید. همچنین برای یادگیری نحوه لحاظ کردن ملاحظات ایمنی در برنامههای هوش مصنوعی خود، به راهنمای ایمنی مراجعه کنید.
systemInstructionobject ( Content )اختیاری. دستورالعمل(های) سیستم توسط توسعهدهنده تنظیم میشود. در حال حاضر، فقط متن.
generationConfigobject ( GenerationConfig )اختیاری. گزینههای پیکربندی برای تولید مدل و خروجیها.
string cachedContent اختیاری. نام محتوای ذخیره شده برای استفاده به عنوان زمینه برای ارائه پیشبینی. قالب: cachedContents/{cachedContent}
serviceTierenum ( ServiceTier )اختیاری. سطح سرویس درخواست.
storebooleanاختیاری. رفتار ثبت وقایع را برای یک درخواست مشخص پیکربندی میکند. در صورت تنظیم، بر پیکربندی ثبت وقایع در سطح پروژه اولویت دارد.
درخواست نمونه
متن
پایتون
نود جی اس
برو
پوسته
جاوا
تصویر
پایتون
نود جی اس
برو
پوسته
جاوا
صوتی
پایتون
نود جی اس
برو
پوسته
ویدئو
پایتون
نود جی اس
برو
پوسته
پی دی اف
پایتون
برو
پوسته
چت
پایتون
نود جی اس
برو
پوسته
جاوا
حافظه پنهان
پایتون
نود جی اس
برو
مدل تنظیمشده
پایتون
حالت JSON
پایتون
نود جی اس
برو
پوسته
جاوا
اجرای کد
پایتون
برو
جاوا
فراخوانی تابع
پایتون
برو
نود جی اس
پوسته
جاوا
پیکربندی نسل
پایتون
نود جی اس
برو
پوسته
جاوا
تنظیمات ایمنی
پایتون
نود جی اس
برو
پوسته
جاوا
دستورالعمل سیستم
پایتون
نود جی اس
برو
پوسته
جاوا
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ شامل نمونهای از GenerateContentResponse است.
روش: models.streamGenerateContent
با دریافت ورودی GenerateContentRequest یک پاسخ استریمشده از مدل تولید میکند.
نقطه پایانی
پستhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContentپارامترهای مسیر
string model الزامی. نام Model که برای تولید تکمیل استفاده میشود.
قالب: models/{model} . این قالب به صورت models/{model} است.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
tools[]object ( Tool ) اختیاری. فهرستی از Tools Model ممکن است برای تولید پاسخ بعدی استفاده کند.
یک Tool ، قطعه کدی است که سیستم را قادر میسازد تا با سیستمهای خارجی تعامل داشته باشد تا یک یا مجموعهای از اقدامات را خارج از دانش و محدوده Model انجام دهد. Tool پشتیبانی شده عبارتند از Function و codeExecution . برای کسب اطلاعات بیشتر به راهنماهای فراخوانی تابع (Function calling) و اجرای کد (Code execution) مراجعه کنید.
toolConfigobject ( ToolConfig ) اختیاری. پیکربندی ابزار برای هر Tool که در درخواست مشخص شده است. برای مثال استفاده به راهنمای فراخوانی تابع مراجعه کنید.
safetySettings[]object ( SafetySetting ) اختیاری. فهرستی از نمونههای منحصر به فرد SafetySetting برای مسدود کردن محتوای ناامن.
این مورد روی GenerateContentRequest.contents و GenerateContentResponse.candidates اعمال خواهد شد. برای هر نوع SafetyCategory نباید بیش از یک تنظیم وجود داشته باشد. API هر محتوا و پاسخی را که آستانههای تعیینشده توسط این تنظیمات را برآورده نکند، مسدود میکند. این لیست، تنظیمات پیشفرض برای هر SafetyCategory مشخصشده در safetySettings را لغو میکند. اگر هیچ SafetySetting برای یک SafetyCategory مشخصشده در لیست وجود نداشته باشد، API از تنظیم ایمنی پیشفرض برای آن دسته استفاده خواهد کرد. دستههای آسیب HARM_CATEGORY_HATE_SPEECH، HARM_CATEGORY_SEXUALLY_EXPLICIT، HARM_CATEGORY_DANGEROUS_CONTENT، HARM_CATEGORY_HARASSMENT، HARM_CATEGORY_CIVIC_INTEGRITY، HARM_CATEGORY_JAILBREAK پشتیبانی میشوند. برای اطلاعات دقیق در مورد تنظیمات ایمنی موجود، به راهنما مراجعه کنید. همچنین برای یادگیری نحوه لحاظ کردن ملاحظات ایمنی در برنامههای هوش مصنوعی خود، به راهنمای ایمنی مراجعه کنید.
systemInstructionobject ( Content )اختیاری. دستورالعمل(های) سیستم توسط توسعهدهنده تنظیم میشود. در حال حاضر، فقط متن.
generationConfigobject ( GenerationConfig )اختیاری. گزینههای پیکربندی برای تولید مدل و خروجیها.
string cachedContent اختیاری. نام محتوای ذخیره شده برای استفاده به عنوان زمینه برای ارائه پیشبینی. قالب: cachedContents/{cachedContent}
serviceTierenum ( ServiceTier )اختیاری. سطح سرویس درخواست.
storebooleanاختیاری. رفتار ثبت وقایع را برای یک درخواست مشخص پیکربندی میکند. در صورت تنظیم، بر پیکربندی ثبت وقایع در سطح پروژه اولویت دارد.
درخواست نمونه
متن
پایتون
نود جی اس
برو
پوسته
جاوا
تصویر
پایتون
نود جی اس
برو
پوسته
جاوا
صوتی
پایتون
برو
پوسته
ویدئو
پایتون
نود جی اس
برو
پوسته
پی دی اف
پایتون
برو
پوسته
چت
پایتون
نود جی اس
برو
پوسته
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ شامل جریانی از نمونههای GenerateContentResponse است.
تولید پاسخ محتوا
پاسخ از مدلی که از پاسخهای کاندید چندگانه پشتیبانی میکند.
رتبهبندیهای ایمنی و فیلترینگ محتوا برای هر دو مورد در GenerateContentResponse.prompt_feedback و برای هر کاندید در finishReason و safetyRatings گزارش میشوند. API: - یا همه کاندیدهای درخواستی یا هیچکدام از آنها را برمیگرداند. - فقط در صورتی که مشکلی در اعلان وجود داشته باشد، هیچ کاندیدی را برنمیگرداند ( promptFeedback بررسی کنید). - بازخورد مربوط به هر کاندید را در finishReason و safetyRatings گزارش میدهد.
candidates[]object ( Candidate )پاسخهای کاندیداها از مدل.
promptFeedbackobject ( PromptFeedback )بازخورد مربوط به فیلترهای محتوا را برمیگرداند.
usageMetadataobject ( UsageMetadata )فقط خروجی. فراداده در مورد استفاده از توکن در درخواستهای تولید.
string modelVersionفقط خروجی. نسخه مدل مورد استفاده برای تولید پاسخ.
string responseIdفقط خروجی. responseId برای شناسایی هر پاسخ استفاده میشود.
modelStatusobject ( ModelStatus )فقط خروجی. وضعیت فعلی مدل این مدل.
| نمایش JSON |
|---|
{ "candidates": [ { object ( |
بازخورد سریع
مجموعهای از فرادادههای بازخورد که در اعلان GenerateContentRequest.content مشخص شدهاند.
blockReasonenum ( BlockReason )اختیاری. در صورت تنظیم، اعلان مسدود شده و هیچ نامزدی بازگردانده نمیشود. اعلان را به صورت دیگری بنویسید.
safetyRatings[]object ( SafetyRating )رتبهبندیها برای ایمنی سوال. حداکثر یک رتبهبندی برای هر دسته وجود دارد.
| نمایش JSON |
|---|
{ "blockReason": enum ( |
بلاکریجن
دلیل مسدود شدن اعلان را مشخص میکند.
| انومها | |
|---|---|
BLOCK_REASON_UNSPECIFIED | مقدار پیشفرض. این مقدار استفاده نشده است. |
SAFETY | به دلایل ایمنی، درخواست مسدود شد. برای فهمیدن اینکه کدام دسته از دستهبندیهای ایمنی آن را مسدود کرده است، safetyRatings بررسی کنید. |
OTHER | به دلایل نامعلومی، پیام رسان مسدود شد. |
BLOCKLIST | به دلیل وجود اصطلاحاتی که در فهرست اصطلاحات مسدود شده وجود دارند، درخواست مسدود شد. |
PROHIBITED_CONTENT | به دلیل محتوای ممنوعه، اعلان مسدود شد. |
IMAGE_SAFETY | کاندیداها به دلیل محتوای تولید تصویر ناامن مسدود شدند. |
کاربردفراداده
فراداده در مورد استفاده از توکن درخواست تولید.
integer promptTokenCount تعداد توکنهای موجود در اعلان. وقتی cachedContent تنظیم شده باشد، این مقدار همچنان اندازه کل مؤثر اعلان است، به این معنی که شامل تعداد توکنهای موجود در محتوای ذخیره شده نیز میشود.
integer cachedContentTokenCountتعداد توکنها در بخش ذخیرهشدهی اعلان (محتوای ذخیرهشده)
integer candidatesTokenCountتعداد کل توکنها در بین تمام کاندیدهای پاسخ تولید شده.
toolUsePromptTokenCountintegerفقط خروجی. تعداد توکنهای موجود در اعلان(های) استفاده از ابزار.
integer thoughtsTokenCountفقط خروجی. تعداد توکنهای افکار برای مدلهای تفکر.
integer totalTokenCountتعداد کل توکنها برای درخواست تولید (درخواست + افکار + نامزدهای پاسخ).
promptTokensDetails[]object ( ModalityTokenCount )فقط خروجی. فهرست روشهایی که در ورودی درخواست پردازش شدهاند.
cacheTokensDetails[]object ( ModalityTokenCount )فقط خروجی. فهرستی از روشهای محتوای ذخیرهشده در ورودی درخواست.
candidatesTokensDetails[]object ( ModalityTokenCount )فقط خروجی. فهرست روشهایی که در پاسخ برگردانده شدهاند.
toolUsePromptTokensDetails[]object ( ModalityTokenCount )فقط خروجی. فهرست روشهایی که برای ورودیهای درخواست استفاده از ابزار پردازش شدهاند.
serviceTierenum ( ServiceTier )فقط خروجی. سطح سرویس درخواست.
| نمایش JSON |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
وضعیت مدل
وضعیت مدل زیربنایی. این مورد برای نشان دادن مرحله مدل زیربنایی و در صورت لزوم، زمان کنار گذاشتن مدل استفاده میشود.
modelStageenum ( ModelStage )مرحله مدل زیربنایی.
retirementTimestring ( Timestamp format)زمانی که مدل بازنشسته خواهد شد.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
string messageپیامی که وضعیت مدل را توضیح میدهد.
| نمایش JSON |
|---|
{
"modelStage": enum ( |
مدل استیج
مرحله مدل زیربنایی را تعریف میکند.
| انومها | |
|---|---|
MODEL_STAGE_UNSPECIFIED | مرحله مدل نامشخص. |
UNSTABLE_EXPERIMENTAL | مدل زیربنایی دستخوش تغییرات زیادی شده است. |
EXPERIMENTAL | مدلهای این مرحله فقط برای اهداف آزمایشی هستند. |
PREVIEW | مدلهای این مرحله، بالغتر از مدلهای آزمایشی هستند. |
STABLE | مدلهای موجود در این مرحله پایدار و آماده برای استفاده در تولید در نظر گرفته میشوند. |
LEGACY | اگر مدل در این مرحله باشد، به این معنی است که این مدل در آینده نزدیک در مسیر منسوخ شدن است. فقط مشتریان فعلی میتوانند از این مدل استفاده کنند. |
DEPRECATED | مدلهای این مرحله منسوخ شدهاند. این مدلها قابل استفاده نیستند. |
RETIRED | مدلهای این مرحله از رده خارج میشوند. این مدلها قابل استفاده نیستند. |
نامزد
- نمایش JSON
- دلیل پایان
- انتساب زمینی
- شناسه منبع انتساب
- شناسه گذرگاه زمین
- SemanticRetrieverChunk
- فراداده زمینی
- جستجوی ورودی
- گراندینگ چانک
- وب
- تصویر
- بازیابیشدهزمینه
- متاداده سفارشی
- لیست رشتهای
- نقشهها
- منابع PlaceAnswer
- نقد و بررسی قطعه کد
- پشتیبانی اتصال به زمین
- بخش
- بازیابیفراداده
- نتیجهی لاگپروبز
- کاندیداهای برتر
- نامزد
- فرادادهی UrlContext
- آدرس فراداده
- وضعیت بازیابی آدرس
یک کاندید پاسخ که از مدل تولید شده است.
contentobject ( Content )فقط خروجی. محتوای تولید شده از مدل برگردانده میشود.
finishReasonenum ( FinishReason )اختیاری. فقط خروجی. دلیل اینکه مدل تولید توکنها را متوقف کرد.
اگر خالی باشد، مدل تولید توکنها را متوقف نکرده است.
safetyRatings[]object ( SafetyRating )فهرست رتبهبندیها برای ایمنی یک کاندیدای پاسخ.
حداکثر یک رتبهبندی برای هر دسته وجود دارد.
citationMetadataobject ( CitationMetadata )فقط خروجی. اطلاعات استناد برای کاندیدای تولید شده توسط مدل.
این فیلد میتواند با اطلاعات تلاوت برای هر متنی که در content وجود دارد، پر شود. اینها قطعاتی هستند که از مطالب دارای حق چاپ در دادههای آموزشی LLM پایه "تلاوت" میشوند.
integer tokenCountفقط خروجی. تعداد توکنها برای این نامزد.
groundingAttributions[]object ( GroundingAttribution )فقط خروجی. اطلاعات انتساب منابعی که در ارائه پاسخی مستدل نقش داشتهاند.
این فیلد برای فراخوانیهای GenerateAnswer پر میشود.
groundingMetadataobject ( GroundingMetadata )فقط خروجی. ابرداده پایه برای کاندیدا.
این فیلد برای فراخوانیهای GenerateContent پر میشود.
number avgLogprobsفقط خروجی. میانگین لگاریتم نمره احتمال داوطلب.
logprobsResultobject ( LogprobsResult )فقط خروجی. نمرات لگاریتم درستنمایی برای توکنهای پاسخ و توکنهای برتر
urlContextMetadataobject ( UrlContextMetadata )فقط خروجی. فراداده مربوط به ابزار بازیابی متن url.
integer indexفقط خروجی. فهرست کاندیدا در فهرست کاندیداهای پاسخ.
string finishMessage اختیاری. فقط خروجی. دلیل توقف تولید توکنها توسط مدل را شرح میدهد. این مقدار فقط زمانی پر میشود که finishReason تنظیم شده باشد.
| نمایش JSON |
|---|
{ "content": { object ( |
دلیل پایان
دلیل توقف تولید توکنها توسط مدل را تعریف میکند.
| انومها | |
|---|---|
FINISH_REASON_UNSPECIFIED | مقدار پیشفرض. این مقدار استفاده نشده است. |
STOP | نقطه توقف طبیعی مدل یا توالی توقف ارائه شده. |
MAX_TOKENS | حداکثر تعداد توکنها همانطور که در درخواست مشخص شده بود، حاصل شد. |
SAFETY | محتوای کاندید پاسخ به دلایل ایمنی علامتگذاری شد. |
RECITATION | محتوای کاندید پاسخ به دلایل تکرار علامتگذاری شد. |
LANGUAGE | محتوای کاندید پاسخ به دلیل استفاده از زبانی که پشتیبانی نمیشود، علامتگذاری شد. |
OTHER | دلیل نامعلوم. |
BLOCKLIST | تولید توکن متوقف شد زیرا محتوا حاوی عبارات ممنوعه است. |
PROHIBITED_CONTENT | تولید توکن به دلیل احتمال وجود محتوای ممنوعه متوقف شد. |
SPII | تولید توکن متوقف شد زیرا محتوا احتمالاً حاوی اطلاعات حساس قابل شناسایی شخصی (SPII) است. |
MALFORMED_FUNCTION_CALL | فراخوانی تابع تولید شده توسط مدل نامعتبر است. |
IMAGE_SAFETY | تولید توکن متوقف شد زیرا تصاویر تولید شده حاوی موارد نقض ایمنی بودند. |
IMAGE_PROHIBITED_CONTENT | تولید تصویر متوقف شد زیرا تصاویر تولید شده حاوی محتوای ممنوعه دیگری بودند. |
IMAGE_OTHER | تولید تصویر به دلیل مشکلات متفرقه دیگر متوقف شد. |
NO_IMAGE | انتظار میرفت که این مدل یک تصویر ایجاد کند، اما هیچ تصویری ایجاد نشد. |
IMAGE_RECITATION | تولید تصویر به دلیل تلاوت متوقف شد. |
UNEXPECTED_TOOL_CALL | مدل یک فراخوانی ابزار ایجاد کرد اما هیچ ابزاری در درخواست فعال نشد. |
TOO_MANY_TOOL_CALLS | مدل، ابزارهای زیادی را پشت سر هم فراخوانی کرد، بنابراین سیستم از اجرا خارج شد. |
MISSING_THOUGHT_SIGNATURE | درخواست حداقل یک امضای فکری ندارد. |
MALFORMED_RESPONSE | به دلیل پاسخ ناقص، تکمیل شد. |
ESCALATION | درخواست توسط یک قانون تشدید فیلتر شد. |
انتساب زمینی
انتساب منبعی که در پاسخ به یک سوال نقش داشته است.
sourceIdobject ( AttributionSourceId )فقط خروجی. شناسه منبعی که در این انتساب مشارکت داشته است.
contentobject ( Content )محتوای منبع پایه که این انتساب را تشکیل میدهد.
| نمایش JSON |
|---|
{ "sourceId": { object ( |
شناسه منبع انتساب
شناسه منبعی که در این انتساب مشارکت داشته است.
sourceUnion typesource میتواند فقط یکی از موارد زیر باشد: groundingPassageobject ( GroundingPassageId )شناسه برای یک متن درونخطی.
semanticRetrieverChunkobject ( SemanticRetrieverChunk ) شناسهای برای یک Chunk که از طریق بازیابی معنایی واکشی شده است.
| نمایش JSON |
|---|
{ // source "groundingPassage": { object ( |
شناسه گذرگاه زمین
شناسهای برای یک قطعه درون یک GroundingPassage .
string passageId فقط خروجی. شناسهی متنی که با GroundingPassage.id مربوط به GenerateAnswerRequest مطابقت دارد.
integer partIndex فقط خروجی. اندیس قطعه درون GroundingPassage.content مربوط به GenerateAnswerRequest .
| نمایش JSON |
|---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
شناسهای برای یک Chunk بازیابی شده از طریق Semantic Retriever که در GenerateAnswerRequest با استفاده از SemanticRetrieverConfig مشخص شده است.
string source فقط خروجی. نام منبعی که با SemanticRetrieverConfig.source درخواست مطابقت دارد. مثال: corpora/123 یا corpora/123/documents/abc
string chunk فقط خروجی. نام Chunk که شامل متن نسبت داده شده است. مثال: corpora/123/documents/abc/chunks/xyz
| نمایش JSON |
|---|
{ "source": string, "chunk": string } |
فراداده زمینی
هنگام فعال شدن اتصال به زمین، فراداده به کلاینت بازگردانده میشود.
groundingChunks[]object ( GroundingChunk )فهرست منابع پشتیبان بازیابیشده از منبع اتصال به زمین مشخصشده. هنگام پخش، این فهرست فقط شامل بخشهای اتصال به زمین است که در فرادادههای اتصال به زمین پاسخهای قبلی گنجانده نشدهاند.
groundingSupports[]object ( GroundingSupport )فهرست پشتیبانی زمینی.
string webSearchQueries[]عبارتهای جستجوی وب برای جستجوی وب بعدی.
string imageSearchQueries[]پرسوجوهای جستجوی تصویر که برای اتصال به زمین استفاده میشوند.
searchEntryPointobject ( SearchEntryPoint )اختیاری. ورودی جستجوی گوگل برای جستجوهای وب بعدی.
retrievalMetadataobject ( RetrievalMetadata )فراداده مربوط به بازیابی در جریان اتصال به زمین.
string googleMapsWidgetContextTokenاختیاری. نام منبع توکن زمینه ویجت نقشههای گوگل که میتواند با ویجت PlacesContextElement برای رندر کردن دادههای زمینهای استفاده شود. فقط در صورتی که اتصال به زمین با نقشههای گوگل فعال باشد، مقداردهی میشود.
| نمایش JSON |
|---|
{ "groundingChunks": [ { object ( |
جستجوی ورودی
نقطه ورود جستجوی گوگل.
string renderedContentاختیاری. قطعه محتوای وب که میتواند در یک صفحه وب یا نمای وب یک برنامه جاسازی شود.
sdkBlobstring ( bytes format)اختیاری. JSON کدگذاری شده با Base64 که آرایهای از تاپلهای <search term, search url> را نشان میدهد.
یک رشته کدگذاری شده با base64.
| نمایش JSON |
|---|
{ "renderedContent": string, "sdkBlob": string } |
گراندینگ چانک
یک GroundingChunk بخشی از شواهد پشتیبان را نشان میدهد که پاسخ مدل را توجیه میکند. این میتواند یک تکه از وب، یک زمینه بازیابی شده از یک فایل یا اطلاعات از Google Maps باشد.
chunk_typeUnion typechunk_type فقط میتواند یکی از موارد زیر باشد:webobject ( Web )تکهای از تار عنکبوت که به زمین وصل میشود.
imageobject ( Image )اختیاری. قطعه اتصال به زمین از جستجوی تصویر.
retrievedContextobject ( RetrievedContext )اختیاری. تکه زمین از متن بازیابی شده توسط ابزار جستجوی فایل.
mapsobject ( Maps )اختیاری. قطعه اتصال به زمین از نقشههای گوگل.
| نمایش JSON |
|---|
{ // chunk_type "web": { object ( |
وب
تکهای از وب.
string uriفقط خروجی. مرجع URI مربوط به آن تکه داده.
string titleفقط خروجی. عنوان قطعه.
| نمایش JSON |
|---|
{ "uri": string, "title": string } |
تصویر
بخشی از جستجوی تصویر.
string sourceUriآدرس اینترنتی (URI) صفحه وب برای انتساب.
string imageUriآدرس اینترنتی (URL) تصویر.
string titleعنوان صفحه وبی که تصویر از آن گرفته شده است.
string domainدامنه اصلی صفحه وبی که تصویر از آن است، مثلاً "example.com".
| نمایش JSON |
|---|
{ "sourceUri": string, "imageUri": string, "title": string, "domain": string } |
بازیابیشدهزمینه
تکهای از متن که توسط ابزار جستجوی فایل بازیابی شده است.
customMetadata[]object ( CustomMetadata )اختیاری. فرادادههای ارائه شده توسط کاربر در مورد زمینه بازیابی شده.
string uriاختیاری. مرجع URI سند بازیابی معنایی.
string titleاختیاری. عنوان سند.
string textاختیاری. متن قطعه کد.
string fileSearchStore اختیاری. نام FileSearchStore که سند در آن قرار دارد. مثال: fileSearchStores/123
integer pageNumberاختیاری. شماره صفحه متن بازیابی شده، در صورت وجود.
string mediaIdاختیاری. نام منبع media blob برای نتایج جستجوی فایل چندوجهی. فرمت: fileSearchStores/{file_search_store_id}/media/{blobId}
| نمایش JSON |
|---|
{
"customMetadata": [
{
object ( |
متاداده سفارشی
کاربر فرادادهای در مورد GroundingFact ارائه داد.
string keyکلید فراداده.
Union type valuevalue میتواند فقط یکی از موارد زیر باشد: string stringValueاختیاری. مقدار رشتهایِ فراداده.
stringListValueobject ( StringList )اختیاری. فهرستی از مقادیر رشتهای برای فراداده.
number numericValue اختیاری. مقدار عددی فراداده. محدوده مورد انتظار برای این مقدار به key خاص مورد استفاده بستگی دارد.
| نمایش JSON |
|---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
لیست رشتهای
فهرستی از مقادیر رشتهای.
values[]stringمقادیر رشتهای لیست.
| نمایش JSON |
|---|
{ "values": [ string ] } |
نقشهها
یک قطعه زمین از نقشههای گوگل. یک قطعه نقشه مربوط به یک مکان واحد است.
string uriمرجع URI آن مکان.
string titleعنوان مکان.
string textپاسخ توضیحات متنی مکان.
string placeId شناسه مکان، در قالب places/{placeId} . کاربر میتواند از این شناسه برای جستجوی آن مکان استفاده کند.
placeAnswerSourcesobject ( PlaceAnswerSources )منابعی که پاسخهایی در مورد ویژگیهای یک مکان مشخص در نقشههای گوگل ارائه میدهند.
| نمایش JSON |
|---|
{
"uri": string,
"title": string,
"text": string,
"placeId": string,
"placeAnswerSources": {
object ( |
منابع PlaceAnswer
مجموعهای از منابع که پاسخهایی در مورد ویژگیهای یک مکان مشخص در نقشههای گوگل ارائه میدهند. هر پیام PlaceAnswerSources مربوط به یک مکان خاص در نقشههای گوگل است. ابزار نقشههای گوگل از این منابع برای پاسخ به سوالاتی در مورد ویژگیهای مکان استفاده کرده است (مثلاً: "آیا بار فو وایفای دارد" یا "آیا بار فو برای ویلچر قابل دسترسی است؟"). در حال حاضر ما فقط از گزیدههای نقد و بررسی به عنوان منبع پشتیبانی میکنیم.
reviewSnippets[]object ( ReviewSnippet )گزیدههایی از نظرات که برای تولید پاسخ در مورد ویژگیهای یک مکان مشخص در نقشههای گوگل استفاده میشوند.
| نمایش JSON |
|---|
{
"reviewSnippets": [
{
object ( |
نقد و بررسی قطعه کد
بخشی از نقد کاربر را که به سوالی در مورد ویژگیهای یک مکان خاص در نقشههای گوگل پاسخ میدهد، در بر میگیرد.
string reviewIdشناسهی قطعه نقد و بررسی.
string googleMapsUriلینکی که مربوط به نظر کاربر در نقشه گوگل باشد.
string titleعنوان نقد.
| نمایش JSON |
|---|
{ "reviewId": string, "googleMapsUri": string, "title": string } |
پشتیبانی اتصال به زمین
پشتیبانی زمینی.
groundingChunkIndices[]integer اختیاری. فهرستی از شاخصها (در 'grounding_chunk' در response.candidate.grounding_metadata ) که استنادهای مرتبط با ادعا را مشخص میکند. به عنوان مثال [1،3،4] به این معنی است که grounding_chunk[1]، grounding_chunk[3]، grounding_chunk[4] محتوای بازیابی شده نسبت داده شده به ادعا هستند. اگر پاسخ در حال پخش باشد، groundingChunkIndices به شاخصهای همه پاسخها اشاره دارد. این مسئولیت کلاینت است که تکههای پایه را از همه پاسخها جمعآوری کند (با حفظ همان ترتیب).
number confidenceScores[]اختیاری. امتیاز اطمینان مراجع پشتیبانی. از ۰ تا ۱ متغیر است. ۱ مطمئنترین است. این لیست باید اندازهای برابر با groundingChunkIndices داشته باشد.
integer renderedParts[] فقط خروجی. اندیسهایی در فیلد parts محتوای کاندید قرار میدهند. این اندیسها مشخص میکنند که کدام بخشهای رندر شده با این منبع پشتیبانی مرتبط هستند.
segmentobject ( Segment )بخشی از محتوایی که این پشتیبانی به آن تعلق دارد.
| نمایش JSON |
|---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"renderedParts": [
integer
],
"segment": {
object ( |
بخش
بخش بندی محتوا.
integer partIndexاندیس یک شیء Part درون شیء Content والد آن.
integer startIndexاندیس شروع در قطعه داده شده، که بر حسب بایت اندازهگیری میشود. فاصله از ابتدای قطعه، شامل همه اجزا، و از صفر شروع میشود.
integer endIndexاندیس پایان در قطعه داده شده، که بر حسب بایت اندازهگیری میشود. فاصله از ابتدای قطعه، منحصراً، از صفر شروع میشود.
string textمتن مربوط به بخش مربوط به پاسخ.
| نمایش JSON |
|---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
بازیابیفراداده
فراداده مربوط به بازیابی در جریان اتصال به زمین.
number googleSearchDynamicRetrievalScoreاختیاری. امتیازی که نشان میدهد اطلاعات حاصل از جستجوی گوگل چقدر میتواند به پاسخ سوال کمک کند. امتیاز در محدوده [0، 1] است، که در آن 0 کمترین احتمال و 1 بیشترین احتمال را دارد. این امتیاز فقط زمانی پر میشود که جستجوی گوگل مبتنی بر جستجو و بازیابی پویا فعال باشد. این امتیاز با آستانه مقایسه میشود تا مشخص شود که آیا جستجوی گوگل فعال شود یا خیر.
| نمایش JSON |
|---|
{ "googleSearchDynamicRetrievalScore": number } |
نتیجهی لاگپروبز
نتیجه لاگپروبز
topCandidates[]object ( TopCandidates )طول = تعداد کل مراحل رمزگشایی.
chosenCandidates[]object ( Candidate )طول = تعداد کل مراحل رمزگشایی. کاندیداهای انتخاب شده ممکن است در topCandidates باشند یا نباشند.
number logProbabilitySumمجموع احتمالات لگاریتمی برای همه توکنها.
| نمایش JSON |
|---|
{ "topCandidates": [ { object ( |
کاندیداهای برتر
کاندیداهایی با احتمال لگاریتمی بالا در هر مرحله رمزگشایی.
candidates[]object ( Candidate )بر اساس احتمال لگاریتمی به ترتیب نزولی مرتب شدهاند.
| نمایش JSON |
|---|
{
"candidates": [
{
object ( |
نامزد
کاندید برای توکن logprobs و امتیاز.
string tokenمقدار رشته توکن کاندیدا.
integer tokenIdمقدار شناسه توکن کاندیدا.
number logProbabilityلگاریتم احتمال کاندیدا.
| نمایش JSON |
|---|
{ "token": string, "tokenId": integer, "logProbability": number } |
فرادادهی UrlContext
فراداده مربوط به ابزار بازیابی متن url.
urlMetadata[]object ( UrlMetadata )فهرست زمینه آدرس اینترنتی.
| نمایش JSON |
|---|
{
"urlMetadata": [
{
object ( |
آدرس فراداده
زمینه بازیابی یک آدرس اینترنتی واحد.
string retrievedUrlآدرس اینترنتی (url) توسط ابزار بازیابی شد.
urlRetrievalStatusenum ( UrlRetrievalStatus )وضعیت بازیابی آدرس اینترنتی (URL).
| نمایش JSON |
|---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
وضعیت بازیابی آدرس
وضعیت بازیابی آدرس اینترنتی (URL).
| انومها | |
|---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED | مقدار پیشفرض. این مقدار استفاده نشده است. |
URL_RETRIEVAL_STATUS_SUCCESS | بازیابی آدرس اینترنتی (URL) با موفقیت انجام شد. |
URL_RETRIEVAL_STATUS_ERROR | بازیابی آدرس اینترنتی (URL) به دلیل خطا با شکست مواجه شد. |
URL_RETRIEVAL_STATUS_PAYWALL | بازیابی آدرس اینترنتی (URL) ناموفق است زیرا محتوا پشت دیوار پرداخت (paywall) قرار دارد. |
URL_RETRIEVAL_STATUS_UNSAFE | بازیابی آدرس اینترنتی (URL) به دلیل ناامن بودن محتوا با شکست مواجه شد. |
فراداده استناد
مجموعهای از منابع ارجاعدهنده به یک محتوا.
citationSources[]object ( CitationSource )استناد به منابع برای یک پاسخ خاص.
| نمایش JSON |
|---|
{
"citationSources": [
{
object ( |
منبع استناد
استناد به یک منبع برای بخشی از یک پاسخ خاص.
integer startIndexاختیاری. شروع بخشی از پاسخ که به این منبع نسبت داده میشود.
اندیس، شروع سگمنت را نشان میدهد که بر حسب بایت اندازهگیری میشود.
integer endIndexاختیاری. پایان بخش نسبت داده شده، منحصر به فرد.
string uriاختیاری. آدرس اینترنتی (URI) که به عنوان منبع بخشی از متن نسبت داده شده است.
string licenseاختیاری. مجوز پروژه گیتهاب که به عنوان منبعی برای بخش اختصاص داده شده است.
اطلاعات مجوز برای استناد به کد مورد نیاز است.
| نمایش JSON |
|---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
دسته بندی آسیب
دسته بندی یک رتبه بندی.
این دستهها انواع مختلفی از آسیبها را پوشش میدهند که توسعهدهندگان ممکن است بخواهند آنها را تعدیل کنند.
| انومها | |
|---|---|
HARM_CATEGORY_UNSPECIFIED | دسته بندی مشخص نشده است. |
HARM_CATEGORY_DEROGATORY | PaLM - نظرات منفی یا مضر که هویت و/یا ویژگی محافظتشده را هدف قرار میدهند. |
HARM_CATEGORY_TOXICITY | PaLM - محتوایی که بیادبانه، بیاحترامیآمیز یا کفرآمیز است. |
HARM_CATEGORY_VIOLENCE | PaLM - سناریوهایی را توصیف میکند که خشونت علیه یک فرد یا گروه را به تصویر میکشند، یا توصیفهای کلی از خونریزی را ارائه میدهد. |
HARM_CATEGORY_SEXUAL | PaLM - حاوی اشاراتی به اعمال جنسی یا سایر محتوای مستهجن است. |
HARM_CATEGORY_MEDICAL | PaLM - توصیههای پزشکی بدون بررسی دقیق را ترویج میدهد. |
HARM_CATEGORY_DANGEROUS | PaLM - محتوای خطرناکی که اعمال مضر را ترویج، تسهیل یا تشویق میکند. |
HARM_CATEGORY_HARASSMENT | جوزا - محتوای آزار و اذیت. |
HARM_CATEGORY_HATE_SPEECH | جوزا - سخنان و محتوای نفرتپراکن. |
HARM_CATEGORY_SEXUALLY_EXPLICIT | جوزا - محتوای صریح جنسی. |
HARM_CATEGORY_DANGEROUS_CONTENT | جوزا - محتوای خطرناک. |
HARM_CATEGORY_CIVIC_INTEGRITY | Gemini - محتوایی که ممکن است برای آسیب رساندن به تمامیت مدنی استفاده شود. منسوخ شده: به جای آن از enableEnhancedCivicAnswers استفاده کنید. |
HARM_CATEGORY_JAILBREAK | Gemini - تلاش برای دور زدن یا نقض دستورالعملهای ایمنی مدل (تلاش برای فرار از زندان) را نشان میدهد. |
تعداد توکنها (TokenCount)
اطلاعات شمارش توکن را برای یک روش واحد نشان میدهد.
modalityenum ( Modality )روش مرتبط با این تعداد توکن.
integer tokenCountتعداد توکنها.
| نمایش JSON |
|---|
{
"modality": enum ( |
روش
روش بخش محتوا
| انومها | |
|---|---|
MODALITY_UNSPECIFIED | روش نامشخص. |
TEXT | متن ساده. |
IMAGE | تصویر. |
VIDEO | ویدئو. |
AUDIO | صوتی. |
DOCUMENT | سند، مثلاً PDF. |
رتبهبندی ایمنی
رتبهبندی ایمنی برای یک محتوا.
رتبهبندی ایمنی شامل دسته آسیب و سطح احتمال آسیب در آن دسته برای یک محتوا است. محتوا از نظر ایمنی در چندین دسته آسیب طبقهبندی میشود و احتمال طبقهبندی آسیب در اینجا گنجانده شده است.
categoryenum ( HarmCategory )الزامی. دستهبندی برای این رتبهبندی.
probabilityenum ( HarmProbability )الزامی. احتمال آسیب برای این محتوا.
boolean blockedآیا این محتوا به دلیل این رتبهبندی مسدود شده است؟
| نمایش JSON |
|---|
{ "category": enum ( |
احتمال آسیب
احتمال اینکه یک محتوا مضر باشد.
سیستم طبقهبندی احتمال ناامن بودن محتوا را ارائه میدهد. این موضوع شدت آسیب برای یک محتوا را نشان نمیدهد.
| انومها | |
|---|---|
HARM_PROBABILITY_UNSPECIFIED | احتمال نامشخص است. |
NEGLIGIBLE | احتمال ناامن بودن محتوا بسیار کم است. |
LOW | احتمال ناامن بودن محتوا کم است. |
MEDIUM | احتمال ناامن بودن محتوا متوسط است. |
HIGH | احتمال ناامن بودن محتوا زیاد است. |
تنظیمات ایمنی
تنظیمات ایمنی، که بر رفتار مسدود کردن ایمنی تأثیر میگذارد.
ارسال تنظیمات امنیتی برای یک دسته، احتمال مجاز مسدود شدن محتوا را تغییر میدهد.
categoryenum ( HarmCategory )الزامی. دستهبندی برای این تنظیم.
thresholdenum ( HarmBlockThreshold )الزامی. آستانه احتمالی که در آن آسیب مسدود میشود را کنترل میکند.
| نمایش JSON |
|---|
{ "category": enum ( |
آستانهی مسدودسازی آسیب
مسدود کردن در سطح و فراتر از احتمال آسیب مشخص شده.
| انومها | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED | آستانه نامشخص است. |
BLOCK_LOW_AND_ABOVE | محتوای دارای «ناچیز» مجاز خواهد بود. |
BLOCK_MEDIUM_AND_ABOVE | محتوایی با عبارات «ناچیز» و «کم» مجاز خواهد بود. |
BLOCK_ONLY_HIGH | محتوایی با کلمات «ناچیز»، «کم» و «متوسط» مجاز خواهد بود. |
BLOCK_NONE | تمام محتوا مجاز خواهد بود. |
OFF | فیلتر ایمنی را خاموش کنید. |
سرویسلایه
سطح سرویس درخواست.
| انومها | |
|---|---|
unspecified | سطح سرویس پیشفرض، که استاندارد است. |
standard | سطح خدمات استاندارد. |
flex | سطح خدمات انعطافپذیر. |
priority | ردیف خدمات اولویتدار. |
محتوا
- نمایش JSON
- قسمت
- لکه
- فراخوانی تابع
- تابع پاسخ
- بخش پاسخ تابع
- تابعپاسخBlob
- زمانبندی
- فایل دیتا
- کد اجرایی
- زبان
- نتیجه اجرای کد
- نتیجه
- ابزار تماس
- نوع ابزار
- ابزارپاسخ
- ویدئوفراداده
- وضوح رسانه
- سطح
- پردازش رسانه
نوع داده ساختاریافته پایه که شامل محتوای چندبخشی یک پیام است.
یک Content شامل یک فیلد role است که تولیدکننده Content را مشخص میکند و یک فیلد parts که شامل دادههای چندبخشی است که محتوای نوبت پیام را در بر میگیرد.
parts[]object ( Part ) Parts مرتبشدهای که یک پیام واحد را تشکیل میدهند. بخشها ممکن است انواع MIME متفاوتی داشته باشند.
string roleاختیاری. تولیدکننده محتوا. باید «کاربر» یا «مدل» باشد.
برای تنظیم مکالمات چند نوبتی مفید است، در غیر این صورت میتوان آن را خالی گذاشت یا تنظیم نکرد.
| نمایش JSON |
|---|
{
"parts": [
{
object ( |
قسمت
نوع دادهای که شامل رسانهای است که بخشی از یک پیام Content است.
یک Part شامل دادههایی است که یک نوع داده مرتبط دارند. یک Part فقط میتواند شامل یکی از انواع پذیرفته شده در Part.data باشد.
اگر فیلد inlineData با بایتهای خام پر شده باشد، یک Part باید یک نوع MIME IANA ثابت داشته باشد که نوع و زیرنوع رسانه را مشخص کند.
thoughtbooleanاختیاری. نشان میدهد که آیا قطعه از روی مدل ساخته شده است یا خیر.
thoughtSignaturestring ( bytes format)اختیاری. یک امضای غیرشفاف برای فکر تا بتوان در درخواستهای بعدی از آن استفاده مجدد کرد.
یک رشته کدگذاری شده با base64.
partMetadataobject ( Struct format)فرادادههای سفارشی مرتبط با قطعه. عاملهایی که از genai.Part به عنوان نمایش محتوا استفاده میکنند، ممکن است نیاز به پیگیری اطلاعات اضافی داشته باشند. به عنوان مثال، میتواند نام فایل/منبعی باشد که قطعه از آن سرچشمه میگیرد یا راهی برای مالتیپلکس کردن چندین جریان قطعه.
mediaResolutionobject ( MediaResolution )اختیاری. وضوح رسانه برای رسانه ورودی.
mediaProcessingenum ( MediaProcessing ) Optional. How the model processes this part's media for understanding. Only meaningful for video parts ( inlineData or fileData with video mime). Non-video parts ignore this field.
dataUnion typedata can be only one of the following:textstringInline text.
inlineDataobject ( Blob )Inline media bytes.
functionCallobject ( FunctionCall ) A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name with the arguments and their values.
functionResponseobject ( FunctionResponse ) The result output of a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model.
fileDataobject ( FileData )URI based data.
executableCodeobject ( ExecutableCode )Code generated by the model that is meant to be executed.
codeExecutionResultobject ( CodeExecutionResult ) Result of executing the ExecutableCode .
toolCallobject ( ToolCall )Server-side tool call. This field is populated when the model predicts a tool invocation that should be executed on the server. The client is expected to echo this message back to the API.
toolResponseobject ( ToolResponse ) The output from a server-side ToolCall execution. This field is populated by the client with the results of executing the corresponding ToolCall .
metadataUnion typemetadata can be only one of the following:videoMetadataobject ( VideoMetadata )Optional. Video metadata. The metadata should only be specified while the video data is presented in inlineData or fileData.
| JSON representation |
|---|
{ "thought": boolean, "thoughtSignature": string, "partMetadata": { object }, "mediaResolution": { object ( |
Blob
Raw media bytes.
Text should not be sent as raw bytes, use the 'text' field.
mimeTypestringThe IANA standard MIME type of the source data. Examples of supported types: - Images: image/png, image/jpeg, image/jpg, image/webp, image/heic, image/heif, image/gif, image/avif - Audio: audio/*, video/audio/s16le, video/audio/wav - Video: video/* - Text: text/plain, text/html, text/css, text/javascript, text/x-typescript, text/csv, text/markdown, text/x-python, text/xml, text/rtf, video/text/timestamp - Applications: application/x-javascript, application/x-typescript, application/x-python-code, application/json, application/x-ipynb+json, application/rtf, application/pdf For additional context, see Supported file formats . //
datastring ( bytes format)Raw bytes for media formats.
A base64-encoded string.
| JSON representation |
|---|
{ "mimeType": string, "data": string } |
FunctionCall
A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name with the arguments and their values.
idstring Optional. Unique identifier of the function call. If populated, the client to execute the functionCall and return the response with the matching id .
namestringRequired. The name of the function to call. Must be az, AZ, 0-9, or contain underscores and dashes, with a maximum length of 128.
argsobject ( Struct format)Optional. The function parameters and values in JSON object format.
| JSON representation |
|---|
{ "id": string, "name": string, "args": { object } } |
FunctionResponse
The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a FunctionCall made based on model prediction.
idstring Optional. The identifier of the function call this response is for. Populated by the client to match the corresponding function call id .
namestringRequired. The name of the function to call. Must be az, AZ, 0-9, or contain underscores and dashes, with a maximum length of 128.
responseobject ( Struct format)Required. The function response in JSON object format. Callers can use any keys of their choice that fit the function's syntax to return the function output, eg "output", "result", etc. In particular, if the function call failed to execute, the response can have an "error" key to return error details to the model.
Multimedia can be included by using a subobject containing a single "$ref" key whose value is the inlineData.display_name of a FunctionResponsePart holding the multimedia. See https://ai.google.dev/gemini-api/docs/function-calling#multimodal .
parts[]object ( FunctionResponsePart ) Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.
willContinueboolean Optional. Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty response with willContinue=False to signal that the function call is finished. This may still trigger the model generation. To avoid triggering the generation and finish the function call, additionally set scheduling to SILENT .
schedulingenum ( Scheduling )Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
| JSON representation |
|---|
{ "id": string, "name": string, "response": { object }, "parts": [ { object ( |
FunctionResponsePart
A datatype containing media that is part of a FunctionResponse message.
A FunctionResponsePart consists of data which has an associated datatype. A FunctionResponsePart can only contain one of the accepted types in FunctionResponsePart.data .
A FunctionResponsePart must have a fixed IANA MIME type identifying the type and subtype of the media if the inlineData field is filled with raw bytes.
dataUnion typedata can be only one of the following: inlineDataobject ( FunctionResponseBlob )Inline media bytes.
| JSON representation |
|---|
{
// data
"inlineData": {
object ( |
FunctionResponseBlob
Raw media bytes for function response.
Text should not be sent as raw bytes, use the 'FunctionResponse.response' field.
mimeTypestringThe IANA standard MIME type of the source data. Examples: - image/png - image/jpeg If an unsupported MIME type is provided, an error will be returned. For a complete list of supported types, see Supported file formats .
datastring ( bytes format)Raw bytes for media formats.
A base64-encoded string.
| JSON representation |
|---|
{ "mimeType": string, "data": string } |
زمانبندی
Specifies how the response should be scheduled in the conversation.
| Enums | |
|---|---|
SCHEDULING_UNSPECIFIED | This value is unused. |
SILENT | Only add the result to the conversation context, do not interrupt or trigger generation. |
WHEN_IDLE | Add the result to the conversation context, and prompt to generate output without interrupting ongoing generation. |
INTERRUPT | Add the result to the conversation context, interrupt ongoing generation and prompt to generate output. |
FileData
URI based data.
mimeTypestringOptional. The IANA standard MIME type of the source data.
fileUristringRequired. URI.
| JSON representation |
|---|
{ "mimeType": string, "fileUri": string } |
ExecutableCode
Code generated by the model that is meant to be executed, and the result returned to the model.
Only generated when using the CodeExecution tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated.
idstring Optional. Unique identifier of the ExecutableCode part. The server returns the CodeExecutionResult with the matching id .
languageenum ( Language ) Required. Programming language of the code .
codestringRequired. The code to be executed.
| JSON representation |
|---|
{
"id": string,
"language": enum ( |
زبان
Supported programming languages for the generated code.
| Enums | |
|---|---|
LANGUAGE_UNSPECIFIED | Unspecified language. This value should not be used. |
PYTHON | Python >= 3.10, with numpy and simpy available. Python is the default language. |
CodeExecutionResult
Result of executing the ExecutableCode .
Generated only when the CodeExecution tool is used.
idstring Optional. The identifier of the ExecutableCode part this result is for. Only populated if the corresponding ExecutableCode has an id.
outcomeenum ( Outcome )Required. Outcome of the code execution.
outputstringOptional. Contains stdout when code execution is successful, stderr or other description otherwise.
| JSON representation |
|---|
{
"id": string,
"outcome": enum ( |
Outcome
Enumeration of possible outcomes of the code execution.
| Enums | |
|---|---|
OUTCOME_UNSPECIFIED | Unspecified status. This value should not be used. |
OUTCOME_OK | Code execution completed successfully. output contains the stdout, if any. |
OUTCOME_FAILED | Code execution failed. output contains the stderr and stdout, if any. |
OUTCOME_DEADLINE_EXCEEDED | Code execution ran for too long, and was cancelled. There may or may not be a partial output present. |
ToolCall
A predicted server-side ToolCall returned from the model. This message contains information about a tool that the model wants to invoke. The client is NOT expected to execute this ToolCall . Instead, the client should pass this ToolCall back to the API in a subsequent turn within a Content message, along with the corresponding ToolResponse .
idstring Optional. Unique identifier of the tool call. The server returns the tool response with the matching id .
toolNamestringOptional. The name of the tool that was called.
toolTypeenum ( ToolType )Required. The type of tool that was called.
argsobject ( Struct format)Optional. The tool call arguments. Example: {"arg1" : "value1", "arg2" : "value2" , ...}
| JSON representation |
|---|
{
"id": string,
"toolName": string,
"toolType": enum ( |
ToolType
The type of tool in the function call.
| Enums | |
|---|---|
TOOL_TYPE_UNSPECIFIED | Unspecified tool type. |
GOOGLE_SEARCH_WEB | Google search tool, maps to Tool.google_search.search_types.web_search. |
GOOGLE_SEARCH_IMAGE | Image search tool, maps to Tool.google_search.search_types.image_search. |
URL_CONTEXT | URL context tool, maps to Tool.url_context. |
GOOGLE_MAPS | Google maps tool, maps to Tool.google_maps. |
FILE_SEARCH | File search tool, maps to Tool.file_search. |
ToolResponse
The output from a server-side ToolCall execution. This message contains the results of a tool invocation that was initiated by a ToolCall from the model. The client should pass this ToolResponse back to the API in a subsequent turn within a Content message, along with the corresponding ToolCall .
idstringOptional. The identifier of the tool call this response is for.
toolTypeenum ( ToolType ) Required. The type of tool that was called, matching the toolType in the corresponding ToolCall .
responseobject ( Struct format)Optional. The tool response.
| JSON representation |
|---|
{
"id": string,
"toolType": enum ( |
VideoMetadata
Deprecated: Use GenerateContentRequest.processing_options instead. Metadata describes the input video content.
startOffsetstring ( Duration format)Optional. The start offset of the video.
A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
endOffsetstring ( Duration format)Optional. The end offset of the video.
A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
fpsnumberOptional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
| JSON representation |
|---|
{ "startOffset": string, "endOffset": string, "fps": number } |
وضوح رسانه
Media resolution for tokenization.
valueUnion typevalue can be only one of the following:levelenum ( Level ) The tokenization quality used for given media.
| JSON representation |
|---|
{
// value
"level": enum ( |
سطح
The media resolution level.
| Enums | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED | Media resolution has not been set. |
MEDIA_RESOLUTION_LOW | Media resolution set to low. |
MEDIA_RESOLUTION_MEDIUM | Media resolution set to medium. |
MEDIA_RESOLUTION_HIGH | Media resolution set to high. |
MEDIA_RESOLUTION_ULTRA_HIGH | Media resolution set to ultra high. |
MediaProcessing
How the model processes input media for understanding.
| Enums | |
|---|---|
MEDIA_PROCESSING_UNSPECIFIED | Default. Uses model-specific processing (3.5 Pro+ -> AGENTIC , older models -> STATIC ). |
STATIC | Fixed-rate frame extraction. All frames placed in context. |
AGENTIC | Model-driven dynamic navigation. Recommended for most use cases. |
محیط زیست
An execution environment for an agent.
idstringRequired. Output only. The ID of the environment.
sources[]object ( Source )Sources to be mounted into the environment.
createdstringOutput only. The time at which the environment was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
updatedstringOutput only. The time at which the environment was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
lastAccessedstringOutput only. The time at which the environment was last accessed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
statusenum ( Status )Output only. The status of the environment container.
fileCountstring ( int64 format)Output only. The number of files in the environment, output only.
sizeBytesstring ( int64 format)Output only. The total size of the environment files in bytes, output only.
networkUnion typenetwork can be only one of the following:networkAllowlistobject ( EnvironmentNetworkEgressAllowlist )Allow only specific domains.
networkModeenum ( NetworkMode )Network egress mode.
| JSON representation |
|---|
{ "id": string, "sources": [ { object ( |
وضعیت
Status of the environment.
| Enums | |
|---|---|
STATUS_UNSPECIFIED | |
ACTIVE | |
EXPIRED | |
NetworkMode
Network egress mode for non-allowlist configurations.
| Enums | |
|---|---|
NETWORK_MODE_UNSPECIFIED | Default value. Unused. |
DISABLED | All network egress is blocked. |
طرحواره
The Schema object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an OpenAPI 3.0 schema object .
typeenum ( Type )Required. Data type.
formatstringOptional. The format of the data. Any value is allowed, but most do not trigger any special functionality.
titlestringOptional. The title of the schema.
descriptionstringOptional. A brief description of the parameter. This could contain examples of use. Parameter description may be formatted as Markdown.
nullablebooleanOptional. Indicates if the value may be null.
enum[]stringOptional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
maxItemsstring ( int64 format)Optional. Maximum number of the elements for Type.ARRAY.
minItemsstring ( int64 format)Optional. Minimum number of the elements for Type.ARRAY.
propertiesmap (key: string, value: object ( Schema ))Optional. Properties of Type.OBJECT.
An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
required[]stringOptional. Required properties of Type.OBJECT.
minPropertiesstring ( int64 format)Optional. Minimum number of the properties for Type.OBJECT.
maxPropertiesstring ( int64 format)Optional. Maximum number of the properties for Type.OBJECT.
minLengthstring ( int64 format)Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
maxLengthstring ( int64 format)Optional. Maximum length of the Type.STRING
patternstringOptional. Pattern of the Type.STRING to restrict a string to a regular expression.
examplevalue ( Value format)Optional. Example of the object. Will only populated when the object is the root.
anyOf[]object ( Schema )Optional. The value should be validated against any (one or more) of the subschemas in the list.
propertyOrdering[]stringOptional. The order of the properties. Not a standard field in open api spec. Used to determine the order of the properties in the response.
defaultvalue ( Value format) Optional. Default value of the field. Per JSON Schema, this field is intended for documentation generators and doesn't affect validation. Thus it's included here and ignored so that developers who send schemas with a default field don't get unknown-field errors.
itemsobject ( Schema )Optional. Schema of the elements of Type.ARRAY.
minimumnumberOptional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
maximumnumberOptional. Maximum value of the Type.INTEGER and Type.NUMBER
| JSON representation |
|---|
{ "type": enum ( |
نوع
Type contains the list of OpenAPI data types as defined by https://spec.openapis.org/oas/v3.0.3#data-types
| Enums | |
|---|---|
TYPE_UNSPECIFIED | Not specified, should not be used. |
STRING | String type. |
NUMBER | Number type. |
INTEGER | Integer type. |
BOOLEAN | Boolean type. |
ARRAY | Array type. |
OBJECT | Object type. |
NULL | Null type. |
ابزار
- JSON representation
- FunctionDeclaration
- رفتار
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- حالت
- CodeExecution
- GoogleSearch
- فاصله
- SearchTypes
- WebSearch
- ImageSearch
- ComputerUse
- محیط زیست
- SafetyPolicy
- UrlContext
- FileSearch
- McpServer
- StreamableHttpTransport
- GoogleMaps
Tool details that the model may use to generate response.
A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
Next ID: 17
functionDeclarations[]object ( FunctionDeclaration ) Optional. A list of FunctionDeclarations available to the model that can be used for function calling.
The model or system does not execute the function. Instead the defined function may be returned as a FunctionCall with arguments to the client side for execution. The model may decide to call a subset of these functions by populating FunctionCall in the response. The next conversation turn may contain a FunctionResponse with the Content.role "function" generation context for the next model turn.
googleSearchRetrievalobject ( GoogleSearchRetrieval )Optional. Retrieval tool that is powered by Google search.
codeExecutionobject ( CodeExecution )Optional. Enables the model to execute code as part of generation.
googleSearchobject ( GoogleSearch )Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
computerUseobject ( ComputerUse )Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
urlContextobject ( UrlContext )Optional. Tool to support URL context retrieval.
fileSearchobject ( FileSearch )Optional. FileSearch tool type. Tool to retrieve knowledge from Semantic Retrieval corpora.
mcpServers[]object ( McpServer )Optional. MCP Servers to connect to.
googleMapsobject ( GoogleMaps )Optional. Tool that allows grounding the model's response with geospatial context related to the user's query.
| JSON representation |
|---|
{ "functionDeclarations": [ { object ( |
FunctionDeclaration
Structured representation of a function declaration as defined by the OpenAPI 3.03 specification . Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.
namestringRequired. The name of the function. Must be az, AZ, 0-9, or contain underscores, colons, dots, and dashes, with a maximum length of 128.
descriptionstringRequired. A brief description of the function.
behaviorenum ( Behavior )Optional. Specifies the function Behavior. Currently only supported by the BidiGenerateContent method.
parametersobject ( Schema )Optional. Describes the parameters to this function. Reflects the Open API 3.03 Parameter Object string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter.
parametersJsonSchemavalue ( Value format)Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
This field is mutually exclusive with parameters .
responseobject ( Schema )Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
responseJsonSchemavalue ( Value format)Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function.
This field is mutually exclusive with response .
رفتار
Defines the function behavior. Defaults to BLOCKING .
| Enums | |
|---|---|
UNSPECIFIED | This value is unused. |
BLOCKING | If set, the system will wait to receive the function response before continuing the conversation. |
NON_BLOCKING | If set, the system will not wait to receive the function response. Instead, it will attempt to handle function responses as they become available while maintaining the conversation between the user and the model. |
GoogleSearchRetrieval
Tool to retrieve public web data for grounding, powered by Google.
dynamicRetrievalConfigobject ( DynamicRetrievalConfig )Specifies the dynamic retrieval configuration for the given source.
| JSON representation |
|---|
{
"dynamicRetrievalConfig": {
object ( |
DynamicRetrievalConfig
Describes the options to customize dynamic retrieval.
modeenum ( Mode )The mode of the predictor to be used in dynamic retrieval.
dynamicThresholdnumberThe threshold to be used in dynamic retrieval. If not set, a system default value is used.
| JSON representation |
|---|
{
"mode": enum ( |
حالت
The mode of the predictor to be used in dynamic retrieval.
| Enums | |
|---|---|
MODE_UNSPECIFIED | Always trigger retrieval. |
MODE_DYNAMIC | Run retrieval only when system decides it is necessary. |
CodeExecution
This type has no fields.
Tool that executes code generated by the model, and automatically returns the result to the model.
See also ExecutableCode and CodeExecutionResult which are only generated when using this tool.
GoogleSearch
GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
timeRangeFilterobject ( Interval )Optional. Filter search results to a specific time range. If customers set a start time, they must set an end time (and vice versa).
searchTypesobject ( SearchTypes )Optional. The set of search types to enable. If not set, web search is enabled by default.
| JSON representation |
|---|
{ "timeRangeFilter": { object ( |
فاصله
Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).
The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
startTimestring ( Timestamp format)Optional. Inclusive start of the interval.
If specified, a Timestamp matching this interval will have to be the same or after the start.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
endTimestring ( Timestamp format)Optional. Exclusive end of the interval.
If specified, a Timestamp matching this interval will have to be before the end.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
| JSON representation |
|---|
{ "startTime": string, "endTime": string } |
SearchTypes
Different types of search that can be enabled on the GoogleSearch tool.
webSearchobject ( WebSearch )Optional. Enables web search. Only text results are returned.
imageSearchobject ( ImageSearch )Optional. Enables image search. Image bytes are returned.
| JSON representation |
|---|
{ "webSearch": { object ( |
WebSearch
This type has no fields.
Standard web search for grounding and related configurations.
ImageSearch
This type has no fields.
Image search for grounding and related configurations.
ComputerUse
Computer Use tool type.
environmentenum ( Environment )Required. The environment being operated.
excludedPredefinedFunctions[]stringOptional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
enablePromptInjectionDetectionbooleanOptional. Whether enable the prompt injection detection check on computer-use request.
disabledSafetyPolicies[]enum ( SafetyPolicy )Optional. Disabled safety policies for computer use.
| JSON representation |
|---|
{ "environment": enum ( |
محیط زیست
Represents the environment being operated, such as a web browser.
| Enums | |
|---|---|
ENVIRONMENT_UNSPECIFIED | Defaults to browser. |
ENVIRONMENT_BROWSER | Operates in a web browser. |
ENVIRONMENT_MOBILE | Operates in a mobile environment. |
ENVIRONMENT_DESKTOP | Operates in a desktop environment. |
SafetyPolicy
Predefined safety policies for computer use.
| Enums | |
|---|---|
SAFETY_POLICY_UNSPECIFIED | Unspecified safety policy. |
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. |
UrlContext
This type has no fields.
Tool to support URL context retrieval.
FileSearch
The FileSearch tool that retrieves knowledge from Semantic Retrieval corpora. Files are imported to Semantic Retrieval corpora using the ImportFile API.
fileSearchStoreNames[]string Required. The names of the fileSearchStores to retrieve from. Example: fileSearchStores/my-file-search-store-123
metadataFilterstringOptional. Metadata filter to apply to the semantic retrieval documents and chunks.
topKintegerOptional. The number of semantic retrieval chunks to retrieve.
| JSON representation |
|---|
{ "fileSearchStoreNames": [ string ], "metadataFilter": string, "topK": integer } |
McpServer
A MCPServer is a server that can be called by the model to perform actions. It is a server that implements the MCP protocol. Next ID: 6
namestringThe name of the MCPServer.
transportUnion typetransport can be only one of the following: streamableHttpTransportobject ( StreamableHttpTransport )A transport that can stream HTTP requests and responses.
| JSON representation |
|---|
{
"name": string,
// transport
"streamableHttpTransport": {
object ( |
StreamableHttpTransport
A transport that can stream HTTP requests and responses. Next ID: 6
urlstringThe full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"
headersmap (key: string, value: string)Optional: Fields for authentication headers, timeouts, etc., if needed.
An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
timeoutstring ( Duration format)HTTP timeout for regular operations.
A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
sseReadTimeoutstring ( Duration format)Timeout for SSE read operations.
A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
terminateOnClosebooleanWhether to close the client session when the transport closes.
| JSON representation |
|---|
{ "url": string, "headers": { string: string, ... }, "timeout": string, "sseReadTimeout": string, "terminateOnClose": boolean } |
GoogleMaps
The GoogleMaps Tool that provides geospatial context for the user's query.
enableWidgetbooleanOptional. Whether to return a widget context token in the GroundingMetadata of the response. Developers can use the widget context token to render a Google Maps widget with geospatial context related to the places that the model references in the response.
| JSON representation |
|---|
{ "enableWidget": boolean } |
REST Resource: auth_tokens
- Resource: AuthToken
- BidiGenerateContentSetup
- GenerationConfig
- Modality
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- سطح تفکر
- ImageConfig
- وضوح رسانه
- ResponseFormatConfig
- TextResponseFormat
- نوع مایم
- AudioResponseFormat
- نوع مایم
- تحویل
- ImageResponseFormat
- نوع مایم
- تحویل
- AspectRatio
- اندازه تصویر
- TranslationConfig
- AudioTranscriptionConfig
- LanguageAuto
- LanguageHints
- RealtimeInputConfig
- AutomaticActivityDetection
- StartSensitivity
- EndSensitivity
- ActivityHandling
- TurnCoverage
- SessionResumptionConfig
- ContextWindowCompressionConfig
- SlidingWindow
- HistoryConfig
- روشها
Resource: AuthToken
A request to create an ephemeral authentication token.
namestringOutput only. Identifier. The token itself.
expireTimestring ( Timestamp format)Optional. Input only. Immutable. An optional time after which, when using the resulting token, messages in BidiGenerateContent sessions will be rejected. (Gemini may preemptively close the session after this time.)
If not set then this defaults to 30 minutes in the future. If set, this value must be less than 20 hours in the future.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
newSessionExpireTimestring ( Timestamp format)Optional. Input only. Immutable. The time after which new Live API sessions using the token resulting from this request will be rejected.
If not set this defaults to 60 seconds in the future. If set, this value must be less than 20 hours in the future.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
fieldMaskstring ( FieldMask format) Optional. Input only. Immutable. If fieldMask is empty, and bidiGenerateContentSetup is not present, then the effective BidiGenerateContentSetup message is taken from the Live API connection.
If fieldMask is empty, and bidiGenerateContentSetup is present, then the effective BidiGenerateContentSetup message is taken entirely from bidiGenerateContentSetup in this request. The setup message from the Live API connection is ignored.
If fieldMask is not empty, then the corresponding fields from bidiGenerateContentSetup will overwrite the fields from the setup message in the Live API connection.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .
configUnion typeconfig can be only one of the following: bidiGenerateContentSetupobject ( BidiGenerateContentSetup ) Optional. Input only. Immutable. Configuration specific to BidiGenerateContent .
usesintegerOptional. Input only. Immutable. The number of times the token can be used. If this value is zero then no limit is applied. Resuming a Live API session does not count as a use. If unspecified, the default is 1.
| JSON representation |
|---|
{
"name": string,
"expireTime": string,
"newSessionExpireTime": string,
"fieldMask": string,
// config
"bidiGenerateContentSetup": {
object ( |
BidiGenerateContentSetup
Message to be sent in the first (and only in the first) BidiGenerateContentClientMessage . Contains configuration that will apply for the duration of the streaming RPC.
Clients should wait for a BidiGenerateContentSetupComplete message before sending any additional messages.
modelstringRequired. The model's resource name. This serves as an ID for the Model to use.
Format: models/{model}
generationConfigobject ( GenerationConfig )Optional. Generation config.
The following fields are not supported:
-
responseLogprobs -
responseMimeType -
logprobs -
responseSchema -
responseJsonSchema -
stop_sequence -
skipResponseCache -
routing_config -
audio_timestamp
systemInstructionobject ( Content )Optional. The user provided system instructions for the model.
Note: Only text should be used in parts and content in each part will be in a separate paragraph.
tools[]object ( Tool ) Optional. A list of Tools the model may use to generate the next response.
A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
realtimeInputConfigobject ( RealtimeInputConfig )Optional. Configures the handling of realtime input.
sessionResumptionobject ( SessionResumptionConfig )Optional. Configures session resumption mechanism.
If included, the server will send SessionResumptionUpdate messages.
contextWindowCompressionobject ( ContextWindowCompressionConfig )Optional. Configures a context window compression mechanism.
If included, the server will automatically reduce the size of the context when it exceeds the configured length.
inputAudioTranscriptionobject ( AudioTranscriptionConfig )Optional. If set, enables transcription of voice input. The transcription aligns with the input audio language, if configured.
outputAudioTranscriptionobject ( AudioTranscriptionConfig )Optional. If set, enables transcription of the model's audio output. The transcription aligns with the language code specified for the output audio, if configured.
historyConfigobject ( HistoryConfig )Optional. Configures the exchange of history between the client and the server.
| JSON representation |
|---|
{ "model": string, "generationConfig": { object ( |
GenerationConfig
Configuration options for model generation and outputs. Not all parameters are configurable for every model.
stopSequences[]string Optional. The set of character sequences (up to 5) that will stop output generation. If specified, the API will stop at the first appearance of a stop_sequence . The stop sequence will not be included as part of the response.
responseMimeTypestring Optional. MIME type of the generated candidate text. Supported MIME types are: text/plain : (default) Text output. application/json : JSON response in the response candidates. text/x.enum : ENUM as a string response in the response candidates. Refer to the docs for a list of all supported text MIME types.
responseSchema
(deprecated)object ( Schema )Optional. Output schema of the generated candidate text. Schemas must be a subset of the OpenAPI schema and can be objects, primitives or arrays.
If set, a compatible responseMimeType must also be set. Compatible MIME types: application/json : Schema for JSON response. Refer to the JSON text generation guide for more details.
_responseJsonSchema
(deprecated)value ( Value format) Optional. Output schema of the generated response. This is an alternative to responseSchema that accepts JSON Schema .
If set, responseSchema must be omitted, but responseMimeType is required.
While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported:
-
$id -
$defs -
$ref -
$anchor -
type -
format -
title -
description -
enum(for strings and numbers) -
items -
prefixItems -
minItems -
maxItems -
minimum -
maximum -
anyOf -
oneOf(interpreted the same asanyOf) -
properties -
additionalProperties -
required
The non-standard propertyOrdering property may also be set.
Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $ , may be set.
responseJsonSchemavalue ( Value format) Optional. An internal detail. Use responseJsonSchema rather than this field.
responseModalities[]enum ( Modality )Optional. The requested modalities of the response. Represents the set of modalities that the model can return, and should be expected in the response. This is an exact match to the modalities of the response.
A model may have multiple combinations of supported modalities. If the requested modalities do not match any of the supported combinations, an error will be returned.
An empty list is equivalent to requesting only text.
candidateCountintegerOptional. Number of generated responses to return. If unset, this will default to 1. Please note that this doesn't work for previous generation models (Gemini 1.0 family)
maxOutputTokensintegerOptional. The maximum number of tokens to include in a response candidate.
Note: The default value varies by model, see the Model.output_token_limit attribute of the Model returned from the getModel function.
temperaturenumberOptional. Controls the randomness of the output.
Note: The default value varies by model, see the Model.temperature attribute of the Model returned from the getModel function.
Values can range from [0.0, 2.0].
topPnumberOptional. The maximum cumulative probability of tokens to consider when sampling.
The model uses combined Top-k and Top-p (nucleus) sampling.
Tokens are sorted based on their assigned probabilities so that only the most likely tokens are considered. Top-k sampling directly limits the maximum number of tokens to consider, while Nucleus sampling limits the number of tokens based on the cumulative probability.
Note: The default value varies by Model and is specified by the Model.top_p attribute returned from the getModel function. An empty topK attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting topK on requests.
topKintegerOptional. The maximum number of tokens to consider when sampling.
Gemini models use Top-p (nucleus) sampling or a combination of Top-k and nucleus sampling. Top-k sampling considers the set of topK most probable tokens. Models running with nucleus sampling don't allow topK setting.
Note: The default value varies by Model and is specified by the Model.top_p attribute returned from the getModel function. An empty topK attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting topK on requests.
seedintegerOptional. Seed used in decoding. If not set, the request uses a randomly generated seed.
presencePenaltynumberOptional. Presence penalty applied to the next token's logprobs if the token has already been seen in the response.
This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use frequencyPenalty for a penalty that increases with each use.
A positive penalty will discourage the use of tokens that have already been used in the response, increasing the vocabulary.
A negative penalty will encourage the use of tokens that have already been used in the response, decreasing the vocabulary.
frequencyPenaltynumberOptional. Frequency penalty applied to the next token's logprobs, multiplied by the number of times each token has been seen in the respponse so far.
A positive penalty will discourage the use of tokens that have already been used, proportional to the number of times the token has been used: The more a token is used, the more difficult it is for the model to use that token again increasing the vocabulary of responses.
Caution: A negative penalty will encourage the model to reuse tokens proportional to the number of times the token has been used. Small negative values will reduce the vocabulary of a response. Larger negative values will cause the model to start repeating a common token until it hits the maxOutputTokens limit.
responseLogprobsbooleanOptional. If true, export the logprobs results in response.
logprobsinteger Optional. Only valid if responseLogprobs=True . This sets the number of top logprobs, including the chosen candidate, to return at each decoding step in the Candidate.logprobs_result . The number must be in the range of [0, 20].
enableEnhancedCivicAnswersbooleanOptional. Enables enhanced civic answers. It may not be available for all models.
speechConfigobject ( SpeechConfig )Optional. The speech generation config.
thinkingConfigobject ( ThinkingConfig )Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
imageConfigobject ( ImageConfig )Optional. Config for image generation. An error will be returned if this field is set for models that don't support these config options.
mediaResolutionenum ( MediaResolution )Optional. If specified, the media resolution specified will be used.
enableAffectiveDialogbooleanOptional. If enabled, the model will detect emotions and adapt its responses accordingly.
responseFormatobject ( ResponseFormatConfig )Optional. Configuration for the response output format. Allows specifying output configuration per modality (text, audio, image) in a flat structure.
translationConfigobject ( TranslationConfig )Optional. Config for translation.
audioTranscriptionConfigobject ( AudioTranscriptionConfig )Optional. Config for audio transcription (speech recognition).
| JSON representation |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
Modality
Supported modalities of the response.
| Enums | |
|---|---|
MODALITY_UNSPECIFIED | Default value. |
TEXT | Indicates the model should return text. |
IMAGE | Indicates the model should return images. |
AUDIO | Indicates the model should return audio. |
SpeechConfig
Config for speech generation and transcription.
voiceConfigobject ( VoiceConfig )The configuration in case of single-voice output.
multiSpeakerVoiceConfigobject ( MultiSpeakerVoiceConfig )Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voiceConfig field.
languageCodestringOptional. The IETF BCP-47 language code that the user configured the app to use. Used for speech recognition and synthesis.
Valid values are: de-DE , en-AU , en-GB , en-IN , en-US , es-US , fr-FR , hi-IN , pt-BR , ar-XA , es-ES , fr-CA , id-ID , it-IT , ja-JP , tr-TR , vi-VN , bn-IN , gu-IN , kn-IN , ml-IN , mr-IN , ta-IN , te-IN , nl-NL , ko-KR , cmn-CN , pl-PL , ru-RU , and th-TH .
| JSON representation |
|---|
{ "voiceConfig": { object ( |
VoiceConfig
The configuration for the voice to use.
voice_configUnion typevoice_config can be only one of the following: prebuiltVoiceConfigobject ( PrebuiltVoiceConfig )The configuration for the prebuilt voice to use.
| JSON representation |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
The configuration for the prebuilt speaker to use.
voiceNamestringThe name of the preset voice to use.
| JSON representation |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
The configuration for the multi-speaker setup.
speakerVoiceConfigs[]object ( SpeakerVoiceConfig )Required. All the enabled speaker voices.
| JSON representation |
|---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
The configuration for a single speaker in a multi speaker setup.
speakerstringRequired. The name of the speaker to use. Should be the same as in the prompt.
voiceConfigobject ( VoiceConfig )Required. The configuration for the voice to use.
| JSON representation |
|---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
Config for thinking features.
includeThoughtsbooleanIndicates whether to include thoughts in the response. If true, thoughts are returned only when available.
thinkingBudgetintegerThe number of thoughts tokens that the model should generate.
thinkingLevelenum ( ThinkingLevel )Optional. Controls the maximum depth of the model's internal reasoning process before it produces a response. The default value is model-dependent. Refer to the Thinking levels guide for more details. Recommended for Gemini 3 or later models. Use with earlier models results in an error.
| JSON representation |
|---|
{
"includeThoughts": boolean,
"thinkingBudget": integer,
"thinkingLevel": enum ( |
سطح تفکر
Allow user to specify how much to think using enum instead of integer budget.
| Enums | |
|---|---|
THINKING_LEVEL_UNSPECIFIED | Default value. |
MINIMAL | Little to no thinking. |
LOW | Low thinking level. |
MEDIUM | Medium thinking level. |
HIGH | High thinking level. |
ImageConfig
Config for image generation features.
aspectRatiostring Optional. The aspect ratio of the image to generate. Supported aspect ratios: 1:1 , 1:4 , 4:1 , 1:8 , 8:1 , 2:3 , 3:2 , 3:4 , 4:3 , 4:5 , 5:4 , 9:16 , 16:9 , or 21:9 .
If not specified, the model will choose a default aspect ratio based on any reference images provided.
imageSizestring Optional. Specifies the size of generated images. Supported values are 512 , 1K , 2K , 4K . If not specified, the model will use default value 1K .
| JSON representation |
|---|
{ "aspectRatio": string, "imageSize": string } |
وضوح رسانه
Media resolution for the input media.
| Enums | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED | Media resolution has not been set. |
MEDIA_RESOLUTION_LOW | Media resolution set to low (64 tokens). |
MEDIA_RESOLUTION_MEDIUM | Media resolution set to medium (256 tokens). |
MEDIA_RESOLUTION_HIGH | Media resolution set to high (zoomed reframing with 256 tokens). |
ResponseFormatConfig
Configuration for the response output format. This is a flat object where each optional sub-field configures a specific output modality.
textobject ( TextResponseFormat )Optional. Text output format configuration.
audioobject ( AudioResponseFormat )Optional. Audio output format configuration.
imageobject ( ImageResponseFormat )Optional. Image output format configuration.
| JSON representation |
|---|
{ "text": { object ( |
TextResponseFormat
Configuration for text output format.
mimeTypeenum ( MimeType )Optional. The MIME type of the text output.
schemavalue ( Value format)Optional. The JSON schema that the output should conform to. Only applicable when mimeType is APPLICATION_JSON.
| JSON representation |
|---|
{
"mimeType": enum ( |
نوع مایم
Supported MIME types for text output.
| Enums | |
|---|---|
MIME_TYPE_UNSPECIFIED | Default value. This value is unused. |
APPLICATION_JSON | JSON output format. |
TEXT_PLAIN | Plain text output format. |
AudioResponseFormat
Configuration for audio output format.
mimeTypeenum ( MimeType )Optional. The MIME type of the audio output.
deliveryenum ( Delivery )Optional. The delivery mode for the audio output.
sampleRateintegerOptional. Sample rate in Hz.
bitRateintegerOptional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
نوع مایم
Supported MIME types for audio output.
| Enums | |
|---|---|
MIME_TYPE_UNSPECIFIED | Default value. This value is unused. |
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. |
تحویل
Delivery mode for audio output.
| Enums | |
|---|---|
DELIVERY_UNSPECIFIED | Default value. This value is unused. |
INLINE | Audio data is returned inline in the response. |
URI | Audio data is returned as a URI. |
ImageResponseFormat
Configuration for image output format.
mimeTypeenum ( MimeType )Optional. The MIME type of the image output.
deliveryenum ( Delivery )Optional. The delivery mode for the image output.
aspectRatioenum ( AspectRatio )Optional. The aspect ratio for the image output.
imageSizeenum ( ImageSize )Optional. The size of the image output.
| JSON representation |
|---|
{ "mimeType": enum ( |
نوع مایم
Supported MIME types for image output.
| Enums | |
|---|---|
MIME_TYPE_UNSPECIFIED | Default value. This value is unused. |
IMAGE_JPEG | JPEG image format. |
تحویل
Delivery mode for image output.
| Enums | |
|---|---|
DELIVERY_UNSPECIFIED | Default value. This value is unused. |
INLINE | Image data is returned inline in the response. |
URI | Image data is returned as a URI. |
AspectRatio
Supported aspect ratios for image output.
| Enums | |
|---|---|
ASPECT_RATIO_UNSPECIFIED | Default value. This value is unused. |
ASPECT_RATIO_ONE_BY_ONE | نسبت تصویر ۱:۱. |
ASPECT_RATIO_TWO_BY_THREE | 2:3 aspect ratio. |
ASPECT_RATIO_THREE_BY_TWO | 3:2 aspect ratio. |
ASPECT_RATIO_THREE_BY_FOUR | 3:4 aspect ratio. |
ASPECT_RATIO_FOUR_BY_THREE | 4:3 aspect ratio. |
ASPECT_RATIO_FOUR_BY_FIVE | 4:5 aspect ratio. |
ASPECT_RATIO_FIVE_BY_FOUR | 5:4 aspect ratio. |
ASPECT_RATIO_NINE_BY_SIXTEEN | 9:16 aspect ratio. |
ASPECT_RATIO_SIXTEEN_BY_NINE | 16:9 aspect ratio. |
ASPECT_RATIO_TWENTY_ONE_BY_NINE | 21:9 aspect ratio. |
ASPECT_RATIO_ONE_BY_EIGHT | 1:8 aspect ratio. |
ASPECT_RATIO_EIGHT_BY_ONE | 8:1 aspect ratio. |
ASPECT_RATIO_ONE_BY_FOUR | 1:4 aspect ratio. |
ASPECT_RATIO_FOUR_BY_ONE | 4:1 aspect ratio. |
اندازه تصویر
Supported image sizes for image output.
| Enums | |
|---|---|
IMAGE_SIZE_UNSPECIFIED | Default value. This value is unused. |
IMAGE_SIZE_FIVE_TWELVE | 512px image size. |
IMAGE_SIZE_ONE_K | 1K image size. |
IMAGE_SIZE_TWO_K | 2K image size. |
IMAGE_SIZE_FOUR_K | 4K image size. |
TranslationConfig
Config for translation features.
targetLanguageCodestringRequired. The target language for translation. Supported values are BCP-47 language codes (eg "en", "es", "fr").
echoTargetLanguagebooleanOptional. If true, the model will generate audio when the target language is spoken, essentially it will parrot the input. If false, we will not produce audio for the target language.
| JSON representation |
|---|
{ "targetLanguageCode": string, "echoTargetLanguage": boolean } |
AudioTranscriptionConfig
The audio transcription configuration.
languageCodes[]stringOptional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection.
adaptationPhrases[]
(deprecated)stringOptional. A list of phrases used for speech adaptation, which biases the ASR model to improve recognition of these specific terms.
customVocabulary[]stringOptional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms (product names, proper nouns, jargon).
wordTimestampbooleanOptional. Configures word-level timestamp generation.
diarizationbooleanOptional. Configures speaker diarization.
language_configUnion typelanguage_codes instead. language_config can be only one of the following: languageAuto
(deprecated)object ( LanguageAuto )Optional. The model will detect the language automatically.
languageHints
(deprecated)object ( LanguageHints )Optional. Specifies one or more languages in the audio.
| JSON representation |
|---|
{ "languageCodes": [ string ], "adaptationPhrases": [ string ], "customVocabulary": [ string ], "wordTimestamp": boolean, "diarization": boolean, // language_config "languageAuto": { object ( |
LanguageAuto
This type has no fields.
Indicates the language of the audio should be automatically detected.
LanguageHints
Provides hints to the model about possible languages present in the audio.
languageCodes[]
(deprecated)stringRequired. BCP-47 language codes.
| JSON representation |
|---|
{ "languageCodes": [ string ] } |
RealtimeInputConfig
Configures the realtime input behavior in BidiGenerateContent .
automaticActivityDetectionobject ( AutomaticActivityDetection )Optional. If not set, automatic activity detection is enabled by default. If automatic voice detection is disabled, the client must send activity signals.
activityHandlingenum ( ActivityHandling )Optional. Defines what effect activity has.
turnCoverageenum ( TurnCoverage )Optional. Defines which input is included in the user's turn.
| JSON representation |
|---|
{ "automaticActivityDetection": { object ( |
AutomaticActivityDetection
Configures automatic detection of activity.
disabledbooleanOptional. If enabled (the default), detected voice and text input count as activity. If disabled, the client must send activity signals.
startOfSpeechSensitivityenum ( StartSensitivity )Optional. Determines how likely speech is to be detected.
prefixPaddingMsintegerOptional. The required duration of detected speech before start-of-speech is committed. The lower this value, the more sensitive the start-of-speech detection is and shorter speech can be recognized. However, this also increases the probability of false positives.
endOfSpeechSensitivityenum ( EndSensitivity )Optional. Determines how likely detected speech is ended.
silenceDurationMsintegerOptional. The required duration of detected non-speech (eg silence) before end-of-speech is committed. The larger this value, the longer speech gaps can be without interrupting the user's activity but this will increase the model's latency.
| JSON representation |
|---|
{ "disabled": boolean, "startOfSpeechSensitivity": enum ( |
StartSensitivity
Determines how start of speech is detected.
| Enums | |
|---|---|
START_SENSITIVITY_UNSPECIFIED | The default is START_SENSITIVITY_HIGH. |
START_SENSITIVITY_HIGH | Automatic detection will detect the start of speech more often. |
START_SENSITIVITY_LOW | Automatic detection will detect the start of speech less often. |
EndSensitivity
Determines how end of speech is detected.
| Enums | |
|---|---|
END_SENSITIVITY_UNSPECIFIED | The default is END_SENSITIVITY_HIGH. |
END_SENSITIVITY_HIGH | Automatic detection ends speech more often. |
END_SENSITIVITY_LOW | Automatic detection ends speech less often. |
ActivityHandling
The different ways of handling user activity.
| Enums | |
|---|---|
ACTIVITY_HANDLING_UNSPECIFIED | If unspecified, the default behavior is START_OF_ACTIVITY_INTERRUPTS . |
START_OF_ACTIVITY_INTERRUPTS | If true, start of activity will interrupt the model's response (also called "barge in"). The model's current response will be cut-off in the moment of the interruption. This is the default behavior. |
NO_INTERRUPTION | The model's response will not be interrupted. |
TurnCoverage
Options about which input is included in the user's turn.
| Enums | |
|---|---|
TURN_COVERAGE_UNSPECIFIED | If unspecified, a default behavior is selected based on the model. Eg, for Gemini 2.5, the default is TURN_INCLUDES_ONLY_ACTIVITY , while for Gemini 3.1 and onwards, it's TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO . |
TURN_INCLUDES_ONLY_ACTIVITY | Includes activity since the last turn, excluding inactivity (eg silence on the audio stream). |
TURN_INCLUDES_ALL_INPUT | Includes all realtime input since the last turn, including inactivity (eg silence on the audio stream). |
TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO | Includes audio activity and all video since the last turn. With automatic activity detection, audio activity means speech and excludes silence. |
SessionResumptionConfig
Session resumption configuration.
This message is included in the session configuration as BidiGenerateContentSetup.session_resumption . If configured, the server will send SessionResumptionUpdate messages.
handlestringThe handle of a previous session. If not present then a new session is created.
Session handles come from SessionResumptionUpdate.token values in previous connections.
| JSON representation |
|---|
{ "handle": string } |
ContextWindowCompressionConfig
Enables context window compression — a mechanism for managing the model's context window so that it does not exceed a given length.
compression_mechanismUnion typecompression_mechanism can be only one of the following: slidingWindowobject ( SlidingWindow )A sliding-window mechanism.
triggerTokensstring ( int64 format)The number of tokens (before running a turn) required to trigger a context window compression.
This can be used to balance quality against latency as shorter context windows may result in faster model responses. However, any compression operation will cause a temporary latency increase, so they should not be triggered frequently.
If not set, the default is 80% of the model's context window limit. This leaves 20% for the next user request/model response.
| JSON representation |
|---|
{
// compression_mechanism
"slidingWindow": {
object ( |
SlidingWindow
The SlidingWindow method operates by discarding content at the beginning of the context window. The resulting context will always begin at the start of a USER role turn. System instructions and any BidiGenerateContentSetup.prefix_turns will always remain at the beginning of the result.
targetTokensstring ( int64 format)The target number of tokens to keep. The default value is triggerTokens/2.
Discarding parts of the context window causes a temporary latency increase so this value should be calibrated to avoid frequent compression operations.
| JSON representation |
|---|
{ "targetTokens": string } |
HistoryConfig
History configuration.
This message is included in the session configuration as BidiGenerateContentSetup.history_config . Configures the exchange of history messages.
initialHistoryInClientContentboolean Optional. If true, after sending setupComplete , the server will wait and at first process clientContent messages until turnComplete is true . This initial history will not trigger a model call and may end with role MODEL . After turnComplete is true , the client can start the realtime conversation via realtimeInput .
| JSON representation |
|---|
{ "initialHistoryInClientContent": boolean } |
Method: auth_tokens.create
Creates a token that can be used to constrain the behavior of a BidiGenerateContent session.
نقطه پایانی
posthttps: / /generativelanguage.googleapis.com /v1beta /auth_tokensدرخواست بدنه
The request body contains an instance of AuthToken .
expireTimestring ( Timestamp format)Optional. Input only. Immutable. An optional time after which, when using the resulting token, messages in BidiGenerateContent sessions will be rejected. (Gemini may preemptively close the session after this time.)
If not set then this defaults to 30 minutes in the future. If set, this value must be less than 20 hours in the future.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
newSessionExpireTimestring ( Timestamp format)Optional. Input only. Immutable. The time after which new Live API sessions using the token resulting from this request will be rejected.
If not set this defaults to 60 seconds in the future. If set, this value must be less than 20 hours in the future.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
fieldMaskstring ( FieldMask format) Optional. Input only. Immutable. If fieldMask is empty, and bidiGenerateContentSetup is not present, then the effective BidiGenerateContentSetup message is taken from the Live API connection.
If fieldMask is empty, and bidiGenerateContentSetup is present, then the effective BidiGenerateContentSetup message is taken entirely from bidiGenerateContentSetup in this request. The setup message from the Live API connection is ignored.
If fieldMask is not empty, then the corresponding fields from bidiGenerateContentSetup will overwrite the fields from the setup message in the Live API connection.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .
configUnion typeconfig can be only one of the following: bidiGenerateContentSetupobject ( BidiGenerateContentSetup ) Optional. Input only. Immutable. Configuration specific to BidiGenerateContent .
usesintegerOptional. Input only. Immutable. The number of times the token can be used. If this value is zero then no limit is applied. Resuming a Live API session does not count as a use. If unspecified, the default is 1.
Response body
If successful, the response body contains a newly created instance of AuthToken .