رابط برنامهنویسی کاربردی (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 پشتیبانی میشوند. برای اطلاعات دقیق در مورد تنظیمات ایمنی موجود، به راهنما مراجعه کنید. همچنین برای یادگیری نحوه لحاظ کردن ملاحظات ایمنی در برنامههای هوش مصنوعی خود، به راهنمای ایمنی مراجعه کنید.
systemInstructionobject ( Content )اختیاری. دستورالعمل(های) سیستم توسط توسعهدهنده تنظیم میشود. در حال حاضر، فقط متن.
generationConfigobject ( GenerationConfig )اختیاری. گزینههای پیکربندی برای تولید مدل و خروجیها.
string cachedContent اختیاری. نام محتوای ذخیره شده برای استفاده به عنوان زمینه برای ارائه پیشبینی. قالب: cachedContents/{cachedContent}
درخواست نمونه
متن
پایتون
نود جی اس
برو
پوسته
جاوا
تصویر
پایتون
نود جی اس
برو
پوسته
جاوا
صوتی
پایتون
نود جی اس
برو
پوسته
ویدئو
پایتون
نود جی اس
برو
پوسته
پی دی اف
پایتون
برو
پوسته
چت
پایتون
نود جی اس
برو
پوسته
جاوا
حافظه پنهان
پایتون
نود جی اس
برو
مدل تنظیمشده
پایتون
حالت 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 پشتیبانی میشوند. برای اطلاعات دقیق در مورد تنظیمات ایمنی موجود، به راهنما مراجعه کنید. همچنین برای یادگیری نحوه لحاظ کردن ملاحظات ایمنی در برنامههای هوش مصنوعی خود، به راهنمای ایمنی مراجعه کنید.
systemInstructionobject ( Content )اختیاری. دستورالعمل(های) سیستم توسط توسعهدهنده تنظیم میشود. در حال حاضر، فقط متن.
generationConfigobject ( GenerationConfig )اختیاری. گزینههای پیکربندی برای تولید مدل و خروجیها.
string cachedContent اختیاری. نام محتوای ذخیره شده برای استفاده به عنوان زمینه برای ارائه پیشبینی. قالب: cachedContents/{cachedContent}
درخواست نمونه
متن
پایتون
نود جی اس
برو
پوسته
جاوا
تصویر
پایتون
نود جی اس
برو
پوسته
جاوا
صوتی
پایتون
برو
پوسته
ویدئو
پایتون
نود جی اس
برو
پوسته
پی دی اف
پایتون
برو
پوسته
چت
پایتون
نود جی اس
برو
پوسته
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ شامل جریانی از نمونههای GenerateContentResponse است.
تولید پاسخ محتوا
پاسخ از مدلی که از پاسخهای کاندید چندگانه پشتیبانی میکند.
رتبهبندیهای ایمنی و فیلترینگ محتوا برای هر دو مورد در GenerateContentResponse.prompt_feedback و برای هر کاندید در finishReason و safetyRatings گزارش میشوند. API: - یا همه کاندیدهای درخواستی یا هیچکدام از آنها را برمیگرداند. - فقط در صورتی که مشکلی در اعلان وجود داشته باشد، هیچ کاندیدی را برنمیگرداند ( promptFeedback را بررسی کنید). - بازخورد مربوط به هر کاندید را در finishReason و safetyRatings گزارش میدهد.
candidates[]object ( Candidate )پاسخهای کاندیداها از مدل.
promptFeedbackobject ( PromptFeedback )بازخورد مربوط به فیلترهای محتوا را برمیگرداند.
usageMetadataobject ( UsageMetadata )فقط خروجی. فراداده در مورد استفاده از توکن در درخواستهای تولید.
string modelVersionفقط خروجی. نسخه مدل مورد استفاده برای تولید پاسخ.
string responseIdفقط خروجی. responseId برای شناسایی هر پاسخ استفاده میشود.
| نمایش 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 )فقط خروجی. فهرست روشهایی که برای ورودیهای درخواست استفاده از ابزار پردازش شدهاند.
| نمایش JSON |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
نامزد
- نمایش 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 | مدل، ابزارهای زیادی را پشت سر هم فراخوانی کرد، بنابراین سیستم از اجرا خارج شد. |
انتساب زمینی
انتساب منبعی که در پاسخ به یک سوال نقش داشته است.
sourceIdobject ( AttributionSourceId )فقط خروجی. شناسه منبعی که در این انتساب مشارکت داشته است.
contentobject ( Content )محتوای منبع پایه که این انتساب را تشکیل میدهد.
| نمایش JSON |
|---|
{ "sourceId": { object ( |
شناسه منبع انتساب
شناسه منبعی که در این انتساب مشارکت داشته است.
sourceUnion typesource میتواند فقط یکی از موارد زیر باشد: object ( GroundingPassageId ) groundingPassageشناسه برای یک متن درونخطی.
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[]عبارتهای جستجوی وب برای جستجوی وب بعدی.
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 } |
گراندینگ چانک
قطعه اتصال به زمین.
chunk_typeUnion typechunk_type فقط میتواند یکی از موارد زیر باشد:webobject ( Web )تکهای از تار عنکبوت که به زمین وصل میشود.
retrievedContextobject ( RetrievedContext )اختیاری. تکه زمین از متن بازیابی شده توسط ابزار جستجوی فایل.
mapsobject ( Maps )اختیاری. قطعه اتصال به زمین از نقشههای گوگل.
| نمایش JSON |
|---|
{ // chunk_type "web": { object ( |
وب
تکهای از وب.
string uriمرجع URI مربوط به آن قطعه داده.
string titleعنوان قطعه.
| نمایش JSON |
|---|
{ "uri": string, "title": string } |
بازیابیشدهزمینه
تکهای از متن که توسط ابزار جستجوی فایل بازیابی شده است.
string uriاختیاری. مرجع URI سند بازیابی معنایی.
string titleاختیاری. عنوان سند.
string textاختیاری. متن قطعه کد.
| نمایش JSON |
|---|
{ "uri": string, "title": string, "text": 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') که استنادهای مرتبط با ادعا را مشخص میکند. برای مثال [1،3،4] به این معنی است که grounding_chunk[1]، grounding_chunk[3]، grounding_chunk[4] محتوای بازیابی شده منتسب به ادعا هستند.
number confidenceScores[]امتیاز اطمینان مراجع پشتیبانی. از ۰ تا ۱ متغیر است. ۱ مطمئنترین است. این لیست باید اندازهای برابر با groundingChunkIndices داشته باشد.
segmentobject ( Segment )بخشی از محتوایی که این پشتیبانی به آن تعلق دارد.
| نمایش JSON |
|---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"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 } |
پیکربندی نسل
- نمایش JSON
- روش
- پیکربندی گفتار
- پیکربندی صوتی
- پیکربندی صدای از پیش ساخته شده
- پیکربندی صدای چند بلندگو
- پیکربندی بلندگو
- ThinkingConfig
- پیکربندی تصویر
- وضوح رسانهای
گزینههای پیکربندی برای تولید مدل و خروجیها. همه پارامترها برای هر مدلی قابل تنظیم نیستند.
string stopSequences[] اختیاری. مجموعهای از توالیهای کاراکتری (تا ۵) که تولید خروجی را متوقف میکنند. در صورت مشخص شدن، API با اولین ظهور stop_sequence متوقف میشود. توالی توقف به عنوان بخشی از پاسخ لحاظ نخواهد شد.
string responseMimeType اختیاری. نوع MIME متن کاندید تولید شده. انواع MIME پشتیبانی شده عبارتند از: text/plain : (پیش فرض) خروجی متن. application/json : پاسخ JSON در کاندیدهای پاسخ. text/x.enum : پاسخ ENUM به عنوان رشته در کاندیدهای پاسخ. برای لیستی از تمام انواع MIME متنی پشتیبانی شده به اسناد مراجعه کنید.
responseSchemaobject ( Schema )اختیاری. طرحواره خروجی متن کاندید تولید شده. طرحوارهها باید زیرمجموعهای از طرحواره OpenAPI باشند و میتوانند اشیاء، مقادیر اولیه یا آرایهها باشند.
در صورت تنظیم، یک responseMimeType سازگار نیز باید تنظیم شود. انواع MIME سازگار: application/json : طرحواره برای پاسخ JSON. برای جزئیات بیشتر به راهنمای تولید متن JSON مراجعه کنید.
_responseJsonSchemavalue ( Value format) اختیاری. طرحواره خروجی پاسخ تولید شده. این جایگزینی برای responseSchema است که JSON Schema را میپذیرد.
در صورت تنظیم، responseSchema باید حذف شود، اما responseMimeType الزامی است.
اگرچه میتوان کل JSON Schema را ارسال کرد، اما همه ویژگیها پشتیبانی نمیشوند. به طور خاص، فقط ویژگیهای زیر پشتیبانی میشوند:
-
$id -
$defs -
$ref -
$anchor -
type -
format -
title -
description -
enum(برای رشتهها و اعداد) -
items -
prefixItems -
minItems -
maxItems -
minimum -
maximum -
anyOf -
oneOf(به همان صورتanyOfتفسیر میشود) -
properties -
additionalProperties -
required
همچنین میتوان ویژگی غیر استاندارد propertyOrdering را تنظیم کرد.
ارجاعات چرخهای تا حد محدودی باز میشوند و به همین دلیل، فقط میتوانند در ویژگیهای غیرضروری استفاده شوند. (ویژگیهای Nullable کافی نیستند.) اگر $ref روی یک زیر-طرح تنظیم شود، هیچ ویژگی دیگری، به جز آنهایی که با $ شروع میشوند، نمیتواند تنظیم شود.
responseJsonSchemavalue ( Value format) اختیاری. یک جزئیات داخلی. به جای این فیلد از responseJsonSchema استفاده کنید.
responseModalities[]enum ( Modality )اختیاری. روشهای درخواستی پاسخ. نشاندهندهی مجموعهای از روشهایی است که مدل میتواند برگرداند و باید در پاسخ انتظار داشته باشد. این دقیقاً مطابق با روشهای پاسخ است.
یک مدل ممکن است چندین ترکیب از روشهای پشتیبانیشده داشته باشد. اگر روشهای درخواستی با هیچ یک از ترکیبات پشتیبانیشده مطابقت نداشته باشند، یک خطا برگردانده میشود.
یک لیست خالی معادل درخواست فقط متن است.
integer candidateCountاختیاری. تعداد پاسخهای تولید شده برای بازگشت. در صورت عدم تنظیم، این مقدار به طور پیشفرض ۱ خواهد بود. لطفاً توجه داشته باشید که این مقدار برای مدلهای نسل قبلی (خانواده Gemini 1.0) کار نمیکند.
integer maxOutputTokensاختیاری. حداکثر تعداد توکنهایی که باید در یک کاندید پاسخ گنجانده شود.
نکته: مقدار پیشفرض بر اساس مدل متفاوت است، به ویژگی Model.output_token_limit Model که از تابع getModel برگردانده میشود، مراجعه کنید.
number temperatureاختیاری. تصادفی بودن خروجی را کنترل میکند.
نکته: مقدار پیشفرض بر اساس مدل متفاوت است، به ویژگی Model.temperature Model برگردانده شده از تابع getModel مراجعه کنید.
مقادیر میتوانند از [0.0، 2.0] متغیر باشند.
number topPاختیاری. حداکثر احتمال تجمعی توکنها که هنگام نمونهبرداری در نظر گرفته میشود.
این مدل از نمونهبرداری ترکیبی Top-k و Top-p (هسته) استفاده میکند.
توکنها بر اساس احتمالات اختصاص داده شده به آنها مرتب میشوند، به طوری که فقط محتملترین توکنها در نظر گرفته میشوند. نمونهگیری Top-k مستقیماً حداکثر تعداد توکنهای مورد بررسی را محدود میکند، در حالی که نمونهگیری Nucleus تعداد توکنها را بر اساس احتمال تجمعی محدود میکند.
نکته: مقدار پیشفرض بسته به Model متفاوت است و توسط ویژگی Model.top_p که از تابع getModel برگردانده میشود، مشخص میشود. یک ویژگی topK خالی نشان میدهد که مدل نمونهگیری top-k را اعمال نمیکند و اجازه تنظیم topK را در درخواستها نمیدهد.
integer topKاختیاری. حداکثر تعداد توکنهایی که هنگام نمونهبرداری باید در نظر گرفته شوند.
مدلهای جمینی از نمونهبرداری Top-p (هستهای) یا ترکیبی از نمونهبرداری Top-k و هسته استفاده میکنند. نمونهبرداری Top-k مجموعهای از محتملترین توکنهای topK را در نظر میگیرد. مدلهایی که با نمونهبرداری هسته اجرا میشوند، امکان تنظیم topK را ندارند.
نکته: مقدار پیشفرض بسته به Model متفاوت است و توسط ویژگی Model.top_p که از تابع getModel برگردانده میشود، مشخص میشود. یک ویژگی topK خالی نشان میدهد که مدل نمونهگیری top-k را اعمال نمیکند و اجازه تنظیم topK را در درخواستها نمیدهد.
integer seedاختیاری. Seed مورد استفاده در رمزگشایی. اگر تنظیم نشود، درخواست از یک Seed تولید شده به صورت تصادفی استفاده میکند.
number presencePenaltyاختیاری. جریمهی حضور (presence penalty) در صورتی که توکن قبلاً در پاسخ مشاهده شده باشد، به لاگپروبهای توکن بعدی اعمال میشود.
این جریمه به صورت دودویی روشن/خاموش است و به تعداد دفعات استفاده از توکن (بعد از اولین استفاده) بستگی ندارد. برای جریمهای که با هر بار استفاده افزایش مییابد، از frequencyPenalty استفاده کنید.
جریمه مثبت، استفاده از توکنهایی که قبلاً در پاسخ استفاده شدهاند را منصرف میکند و باعث افزایش دایره لغات میشود.
جریمه منفی، استفاده از توکنهایی را که قبلاً در پاسخ استفاده شدهاند، تشویق میکند و باعث کاهش واژگان میشود.
number frequencyPenaltyOptional. 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 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 )اختیاری. پیکربندی برای ویژگیهای تفکر. اگر این فیلد برای مدلهایی که از تفکر پشتیبانی نمیکنند تنظیم شود، خطا برگردانده میشود.
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.
| نمایش JSON |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
روش
Supported modalities of the response.
| انومها | |
|---|---|
MODALITY_UNSPECIFIED | مقدار پیشفرض. |
TEXT | Indicates the model should return text. |
IMAGE | Indicates the model should return images. |
AUDIO | Indicates the model should return audio. |
SpeechConfig
The speech generation config.
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. Language code (in BCP 47 format, eg "en-US") for speech 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 |
|---|
{ "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 |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
The configuration for the prebuilt speaker to use.
voiceNamestringThe name of the preset voice to use.
| نمایش JSON |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
The configuration for the multi-speaker setup.
speakerVoiceConfigs[]object ( SpeakerVoiceConfig )Required. All the enabled speaker voices.
| نمایش JSON |
|---|
{
"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 |
|---|
{
"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.
| نمایش JSON |
|---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
ImageConfig
Config for image generation features.
aspectRatiostringOptional. The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9.
If not specified, the model will choose a default aspect ratio based on any reference images provided.
| نمایش JSON |
|---|
{ "aspectRatio": string } |
MediaResolution
Media resolution for the input media.
| انومها | |
|---|---|
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). |
HarmCategory
The category of a rating.
These categories cover various kinds of harms that developers may wish to adjust.
| انومها | |
|---|---|
HARM_CATEGORY_UNSPECIFIED | Category is unspecified. |
HARM_CATEGORY_DEROGATORY | PaLM - Negative or harmful comments targeting identity and/or protected attribute. |
HARM_CATEGORY_TOXICITY | PaLM - Content that is rude, disrespectful, or profane. |
HARM_CATEGORY_VIOLENCE | PaLM - Describes scenarios depicting violence against an individual or group, or general descriptions of gore. |
HARM_CATEGORY_SEXUAL | PaLM - Contains references to sexual acts or other lewd content. |
HARM_CATEGORY_MEDICAL | PaLM - Promotes unchecked medical advice. |
HARM_CATEGORY_DANGEROUS | PaLM - Dangerous content that promotes, facilitates, or encourages harmful acts. |
HARM_CATEGORY_HARASSMENT | Gemini - Harassment content. |
HARM_CATEGORY_HATE_SPEECH | Gemini - Hate speech and content. |
HARM_CATEGORY_SEXUALLY_EXPLICIT | Gemini - Sexually explicit content. |
HARM_CATEGORY_DANGEROUS_CONTENT | Gemini - Dangerous content. |
HARM_CATEGORY_CIVIC_INTEGRITY | Gemini - Content that may be used to harm civic integrity. DEPRECATED: use enableEnhancedCivicAnswers instead. |
ModalityTokenCount
Represents token counting info for a single modality.
modalityenum ( Modality )The modality associated with this token count.
tokenCountintegerNumber of tokens.
| نمایش JSON |
|---|
{
"modality": enum ( |
روش
Content Part modality
| انومها | |
|---|---|
MODALITY_UNSPECIFIED | Unspecified modality. |
TEXT | Plain text. |
IMAGE | تصویر. |
VIDEO | Video. |
AUDIO | صوتی. |
DOCUMENT | Document, eg PDF. |
SafetyRating
Safety rating for a piece of content.
The safety rating contains the category of harm and the harm probability level in that category for a piece of content. Content is classified for safety across a number of harm categories and the probability of the harm classification is included here.
categoryenum ( HarmCategory )Required. The category for this rating.
probabilityenum ( HarmProbability )Required. The probability of harm for this content.
blockedbooleanWas this content blocked because of this rating?
| نمایش JSON |
|---|
{ "category": enum ( |
HarmProbability
The probability that a piece of content is harmful.
The classification system gives the probability of the content being unsafe. This does not indicate the severity of harm for a piece of content.
| انومها | |
|---|---|
HARM_PROBABILITY_UNSPECIFIED | Probability is unspecified. |
NEGLIGIBLE | Content has a negligible chance of being unsafe. |
LOW | Content has a low chance of being unsafe. |
MEDIUM | Content has a medium chance of being unsafe. |
HIGH | Content has a high chance of being unsafe. |
SafetySetting
Safety setting, affecting the safety-blocking behavior.
Passing a safety setting for a category changes the allowed probability that content is blocked.
categoryenum ( HarmCategory )Required. The category for this setting.
thresholdenum ( HarmBlockThreshold )Required. Controls the probability threshold at which harm is blocked.
| نمایش JSON |
|---|
{ "category": enum ( |
HarmBlockThreshold
Block at and beyond a specified harm probability.
| انومها | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED | Threshold is unspecified. |
BLOCK_LOW_AND_ABOVE | Content with NEGLIGIBLE will be allowed. |
BLOCK_MEDIUM_AND_ABOVE | Content with NEGLIGIBLE and LOW will be allowed. |
BLOCK_ONLY_HIGH | Content with NEGLIGIBLE, LOW, and MEDIUM will be allowed. |
BLOCK_NONE | All content will be allowed. |
OFF | Turn off the safety filter. |