رابط برنامهنویسی کاربردی (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) مراجعه کنید.
toolConfig
object ( 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 پشتیبانی میشوند. برای اطلاعات دقیق در مورد تنظیمات ایمنی موجود، به راهنما مراجعه کنید. همچنین برای یادگیری نحوه لحاظ کردن ملاحظات ایمنی در برنامههای هوش مصنوعی خود، به راهنمای ایمنی مراجعه کنید.
systemInstruction
object ( Content
)
اختیاری. دستورالعمل(های) سیستم توسط توسعهدهنده تنظیم میشود. در حال حاضر، فقط متن.
generationConfig
object ( 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) مراجعه کنید.
toolConfig
object ( 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 پشتیبانی میشوند. برای اطلاعات دقیق در مورد تنظیمات ایمنی موجود، به راهنما مراجعه کنید. همچنین برای یادگیری نحوه لحاظ کردن ملاحظات ایمنی در برنامههای هوش مصنوعی خود، به راهنمای ایمنی مراجعه کنید.
systemInstruction
object ( Content
)
اختیاری. دستورالعمل(های) سیستم توسط توسعهدهنده تنظیم میشود. در حال حاضر، فقط متن.
generationConfig
object ( GenerationConfig
)
اختیاری. گزینههای پیکربندی برای تولید مدل و خروجیها.
string
cachedContent
اختیاری. نام محتوای ذخیره شده برای استفاده به عنوان زمینه برای ارائه پیشبینی. قالب: cachedContents/{cachedContent}
درخواست نمونه
متن
پایتون
نود جی اس
برو
پوسته
جاوا
تصویر
پایتون
نود جی اس
برو
پوسته
جاوا
صوتی
پایتون
برو
پوسته
ویدئو
پایتون
نود جی اس
برو
پوسته
پی دی اف
پایتون
برو
پوسته
چت
پایتون
نود جی اس
برو
پوسته
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ شامل جریانی از نمونههای GenerateContentResponse
است.
تولید پاسخ محتوا
پاسخ از مدلی که از پاسخهای کاندید چندگانه پشتیبانی میکند.
رتبهبندیهای ایمنی و فیلترینگ محتوا برای هر دو مورد در GenerateContentResponse.prompt_feedback
و برای هر کاندید در finishReason
و safetyRatings
گزارش میشوند. API: - یا همه کاندیدهای درخواستی یا هیچکدام از آنها را برمیگرداند. - فقط در صورتی که مشکلی در اعلان وجود داشته باشد، هیچ کاندیدی را برنمیگرداند ( promptFeedback
بررسی کنید). - بازخورد مربوط به هر کاندید را در finishReason
و safetyRatings
گزارش میدهد.
object ( Candidate )
candidates[]
پاسخهای کاندیداها از مدل.
object ( PromptFeedback )
promptFeedback
بازخورد مربوط به فیلترهای محتوا را برمیگرداند.
usageMetadata
object ( UsageMetadata
)
فقط خروجی. فراداده در مورد استفاده از توکن در درخواستهای تولید.
string
modelVersion
فقط خروجی. نسخه مدل مورد استفاده برای تولید پاسخ.
string
responseId
فقط خروجی. responseId برای شناسایی هر پاسخ استفاده میشود.
نمایش JSON |
---|
{ "candidates": [ { object ( |
بازخورد سریع
مجموعهای از فرادادههای بازخورد که در اعلان GenerateContentRequest.content
مشخص شدهاند.
blockReason
enum ( 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
تعداد کل توکنها در بین تمام کاندیدهای پاسخ تولید شده.
toolUsePromptTokenCount
integer
فقط خروجی. تعداد توکنهای موجود در اعلان(های) استفاده از ابزار.
integer
thoughtsTokenCount
فقط خروجی. تعداد توکنهای افکار برای مدلهای تفکر.
integer
totalTokenCount
تعداد کل توکنها برای درخواست تولید (نامزدهای اعلان + پاسخ).
object ( ModalityTokenCount )
promptTokensDetails[]
فقط خروجی. فهرست روشهایی که در ورودی درخواست پردازش شدهاند.
object ( ModalityTokenCount )
cacheTokensDetails[]
فقط خروجی. فهرستی از روشهای محتوای ذخیرهشده در ورودی درخواست.
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
- آدرس فراداده
- وضعیت بازیابی آدرس
یک کاندید پاسخ که از مدل تولید شده است.
content
object ( Content
)
فقط خروجی. محتوای تولید شده از مدل برگردانده میشود.
finishReason
enum ( FinishReason
)
اختیاری. فقط خروجی. دلیل اینکه مدل تولید توکنها را متوقف کرد.
اگر خالی باشد، مدل تولید توکنها را متوقف نکرده است.
safetyRatings[]
object ( SafetyRating
)
فهرست رتبهبندیها برای ایمنی یک کاندیدای پاسخ.
حداکثر یک رتبهبندی برای هر دسته وجود دارد.
citationMetadata
object ( CitationMetadata
)
فقط خروجی. اطلاعات استناد برای کاندیدای تولید شده توسط مدل.
این فیلد میتواند با اطلاعات تلاوت برای هر متنی که در content
وجود دارد، پر شود. اینها قطعاتی هستند که از مطالب دارای حق چاپ در دادههای آموزشی LLM پایه "تلاوت" میشوند.
integer
tokenCount
فقط خروجی. تعداد توکنها برای این نامزد.
groundingAttributions[]
object ( GroundingAttribution
)
فقط خروجی. اطلاعات انتساب منابعی که در ارائه پاسخی مستدل نقش داشتهاند.
این فیلد برای فراخوانیهای GenerateAnswer
پر میشود.
groundingMetadata
object ( GroundingMetadata
)
فقط خروجی. ابرداده پایه برای کاندیدا.
این فیلد برای فراخوانیهای GenerateContent
پر میشود.
number
avgLogprobs
فقط خروجی. میانگین لگاریتم نمره احتمال داوطلب.
logprobsResult
object ( LogprobsResult
)
فقط خروجی. نمرات لگاریتم درستنمایی برای توکنهای پاسخ و توکنهای برتر
urlContextMetadata
object ( 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 | مدل، ابزارهای زیادی را پشت سر هم فراخوانی کرد، بنابراین سیستم از اجرا خارج شد. |
انتساب زمینی
انتساب منبعی که در پاسخ به یک سوال نقش داشته است.
sourceId
object ( AttributionSourceId
)
فقط خروجی. شناسه منبعی که در این انتساب مشارکت داشته است.
content
object ( Content
)
محتوای منبع پایه که این انتساب را تشکیل میدهد.
نمایش JSON |
---|
{ "sourceId": { object ( |
شناسه منبع انتساب
شناسه منبعی که در این انتساب مشارکت داشته است.
Union type
source
source
میتواند فقط یکی از موارد زیر باشد: groundingPassage
object ( GroundingPassageId
)
شناسه برای یک متن درونخطی.
semanticRetrieverChunk
object ( 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[]
عبارتهای جستجوی وب برای جستجوی وب بعدی.
searchEntryPoint
object ( SearchEntryPoint
)
اختیاری. ورودی جستجوی گوگل برای جستجوهای وب بعدی.
retrievalMetadata
object ( RetrievalMetadata
)
فراداده مربوط به بازیابی در جریان اتصال به زمین.
string
googleMapsWidgetContextToken
اختیاری. نام منبع توکن زمینه ویجت نقشههای گوگل که میتواند با ویجت PlacesContextElement برای رندر کردن دادههای زمینهای استفاده شود. فقط در صورتی که اتصال به زمین با نقشههای گوگل فعال باشد، مقداردهی میشود.
نمایش JSON |
---|
{ "groundingChunks": [ { object ( |
جستجوی ورودی
نقطه ورود جستجوی گوگل.
string
renderedContent
اختیاری. قطعه محتوای وب که میتواند در یک صفحه وب یا نمای وب یک برنامه جاسازی شود.
sdkBlob
string ( bytes format)
اختیاری. JSON کدگذاری شده با Base64 که آرایهای از تاپلهای <search term, search url> را نشان میدهد.
یک رشته کدگذاری شده با base64.
نمایش JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
گراندینگ چانک
قطعه اتصال به زمین.
chunk_type
Union type
chunk_type
فقط میتواند یکی از موارد زیر باشد:web
object ( Web
)
تکهای از تار عنکبوت که به زمین وصل میشود.
retrievedContext
object ( RetrievedContext
)
اختیاری. تکه زمین از متن بازیابی شده توسط ابزار جستجوی فایل.
maps
object ( 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}
. کاربر میتواند از این شناسه برای جستجوی آن مکان استفاده کند.
placeAnswerSources
object ( 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 داشته باشد.
segment
object ( 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 ( |
کاندیداهای برتر
کاندیداهایی با احتمال لگاریتمی بالا در هر مرحله رمزگشایی.
object ( Candidate )
candidates[]
بر اساس احتمال لگاریتمی به ترتیب نزولی مرتب شدهاند.
نمایش 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) توسط ابزار بازیابی شد.
urlRetrievalStatus
enum ( 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 متنی پشتیبانی شده به اسناد مراجعه کنید.
responseSchema
object ( Schema
)
اختیاری. طرحواره خروجی متن کاندید تولید شده. طرحوارهها باید زیرمجموعهای از طرحواره OpenAPI باشند و میتوانند اشیاء، مقادیر اولیه یا آرایهها باشند.
در صورت تنظیم، یک responseMimeType
سازگار نیز باید تنظیم شود. انواع MIME سازگار: application/json
: طرحواره برای پاسخ JSON. برای جزئیات بیشتر به راهنمای تولید متن JSON مراجعه کنید.
_responseJsonSchema
value ( 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
روی یک زیر-طرح تنظیم شود، هیچ ویژگی دیگری، به جز آنهایی که با $
شروع میشوند، نمیتواند تنظیم شود.
responseJsonSchema
value ( 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 تعداد توکنها را بر اساس احتمال تجمعی محدود میکند.
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.
topK
integer
Optional. 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.
seed
integer
Optional. Seed used in decoding. If not set, the request uses a randomly generated seed.
presencePenalty
number
Optional. 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.
frequencyPenalty
number
Optional. 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.
responseLogprobs
boolean
Optional. If true, export the logprobs results in response.
logprobs
integer
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].
enableEnhancedCivicAnswers
boolean
Optional. Enables enhanced civic answers. It may not be available for all models.
speechConfig
object ( SpeechConfig
)
Optional. The speech generation config.
thinkingConfig
object ( ThinkingConfig
)
Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
imageConfig
object ( 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.
mediaResolution
enum ( 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.
voiceConfig
object ( VoiceConfig
)
The configuration in case of single-voice output.
multiSpeakerVoiceConfig
object ( MultiSpeakerVoiceConfig
)
Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voiceConfig field.
languageCode
string
Optional. 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_config
Union type
voice_config
can be only one of the following: prebuiltVoiceConfig
object ( PrebuiltVoiceConfig
)
The configuration for the prebuilt voice to use.
نمایش JSON |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
The configuration for the prebuilt speaker to use.
voiceName
string
The 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.
speaker
string
Required. The name of the speaker to use. Should be the same as in the prompt.
voiceConfig
object ( VoiceConfig
)
Required. The configuration for the voice to use.
نمایش JSON |
---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
Config for thinking features.
includeThoughts
boolean
Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
thinkingBudget
integer
The number of thoughts tokens that the model should generate.
نمایش JSON |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
ImageConfig
Config for image generation features.
aspectRatio
string
Optional. 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.
modality
enum ( Modality
)
The modality associated with this token count.
tokenCount
integer
Number of tokens.
نمایش JSON |
---|
{
"modality": enum ( |
روش
Content Part modality
انومها | |
---|---|
MODALITY_UNSPECIFIED | Unspecified modality. |
TEXT | Plain text. |
IMAGE | تصویر. |
VIDEO | ویدئو. |
AUDIO | 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.
category
enum ( HarmCategory
)
Required. The category for this rating.
probability
enum ( HarmProbability
)
Required. The probability of harm for this content.
blocked
boolean
Was 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.
category
enum ( HarmCategory
)
Required. The category for this setting.
threshold
enum ( 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. |