Gemini API از تولید محتوا با تصاویر، صدا، کد، ابزار و موارد دیگر پشتیبانی می کند. برای جزئیات بیشتر در مورد هر یک از این ویژگی ها، کد نمونه متمرکز بر وظیفه را بخوانید و بررسی کنید، یا راهنمای جامع را بخوانید.
- تولید متن
- چشم انداز
- صوتی
- جاسازی ها
- زمینه طولانی
- اجرای کد
- حالت 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
هستند. برای کسب اطلاعات بیشتر به فراخوانی تابع و راهنمای اجرای کد مراجعه کنید.
toolConfig
object ( ToolConfig
)
اختیاری. پیکربندی ابزار برای هر Tool
در درخواست مشخص شده است. برای مثال استفاده به راهنمای فراخوانی تابع مراجعه کنید.
safetySettings[]
object ( SafetySetting
)
اختیاری. فهرستی از نمونههای SafetySetting
منحصر به فرد برای مسدود کردن محتوای ناامن.
این در GenerateContentRequest.contents
و GenerateContentResponse.candidates
اعمال خواهد شد. برای هر نوع SafetyCategory
نباید بیش از یک تنظیم وجود داشته باشد. API هر محتوا و پاسخی را که نتواند آستانه تعیین شده توسط این تنظیمات را برآورده کند مسدود می کند. این فهرست تنظیمات پیشفرض را برای هر SafetyCategory
مشخصشده در تنظیمات ایمنی لغو میکند. اگر هیچ 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
)
اختیاری. گزینه های پیکربندی برای تولید مدل و خروجی ها.
cachedContent
string
اختیاری. نام محتوای ذخیره شده در حافظه پنهان برای استفاده به عنوان زمینه برای ارائه پیش بینی. قالب: cachedContents/{cachedContent}
درخواست نمونه
متن
پایتون
Node.js
برو
پوسته
جاوا
تصویر
پایتون
Node.js
برو
پوسته
جاوا
صوتی
پایتون
Node.js
برو
پوسته
ویدیو
پایتون
Node.js
برو
پوسته
پایتون
برو
پوسته
چت کنید
پایتون
Node.js
برو
پوسته
جاوا
حافظه پنهان
پایتون
Node.js
برو
مدل کوک شده
پایتون
حالت JSON
پایتون
Node.js
برو
پوسته
جاوا
اجرای کد
پایتون
برو
جاوا
فراخوانی تابع
پایتون
برو
Node.js
پوسته
جاوا
پیکربندی نسل
پایتون
Node.js
برو
پوسته
جاوا
تنظیمات ایمنی
پایتون
Node.js
برو
پوسته
جاوا
دستورالعمل سیستم
پایتون
Node.js
برو
پوسته
جاوا
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از 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
هستند. برای کسب اطلاعات بیشتر به فراخوانی تابع و راهنمای اجرای کد مراجعه کنید.
toolConfig
object ( ToolConfig
)
اختیاری. پیکربندی ابزار برای هر Tool
در درخواست مشخص شده است. برای مثال استفاده به راهنمای فراخوانی تابع مراجعه کنید.
safetySettings[]
object ( SafetySetting
)
اختیاری. فهرستی از نمونههای SafetySetting
منحصر به فرد برای مسدود کردن محتوای ناامن.
این در GenerateContentRequest.contents
و GenerateContentResponse.candidates
اعمال خواهد شد. برای هر نوع SafetyCategory
نباید بیش از یک تنظیم وجود داشته باشد. API هر محتوا و پاسخی را که نتواند آستانه تعیین شده توسط این تنظیمات را برآورده کند مسدود می کند. این فهرست تنظیمات پیشفرض را برای هر SafetyCategory
مشخصشده در تنظیمات ایمنی لغو میکند. اگر هیچ 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
)
اختیاری. گزینه های پیکربندی برای تولید مدل و خروجی ها.
cachedContent
string
اختیاری. نام محتوای ذخیره شده در حافظه پنهان برای استفاده به عنوان زمینه برای ارائه پیش بینی. قالب: cachedContents/{cachedContent}
درخواست نمونه
متن
پایتون
Node.js
برو
پوسته
جاوا
تصویر
پایتون
Node.js
برو
پوسته
جاوا
صوتی
پایتون
برو
پوسته
ویدیو
پایتون
Node.js
برو
پوسته
پایتون
برو
پوسته
چت کنید
پایتون
Node.js
برو
پوسته
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی جریانی از نمونه های GenerateContentResponse
است.
Generate ContentResponse
پاسخ از مدلی که از چندین پاسخ نامزد پشتیبانی می کند.
رتبهبندی ایمنی و فیلتر محتوا هم برای prompt در GenerateContentResponse.prompt_feedback
و هم برای هر نامزد در finishReason
و در safetyRatings
گزارش میشود. API: - همه نامزدهای درخواست شده یا هیچ یک از آنها را برمیگرداند - فقط در صورتی که مشکلی در درخواست وجود داشته باشد، هیچ نامزدی را برمیگرداند ( promptFeedback
بررسی کنید) - بازخورد هر نامزد را در finishReason
و safetyRatings
گزارش میکند.
candidates[]
object ( Candidate
)
پاسخ های کاندیدا از مدل.
promptFeedback
object ( PromptFeedback
)
بازخورد درخواست مربوط به فیلترهای محتوا را برمیگرداند.
usageMetadata
object ( UsageMetadata
)
فقط خروجی فراداده در مورد استفاده از رمز درخواست های تولید.
string
modelVersion
فقط خروجی نسخه مدل مورد استفاده برای ایجاد پاسخ.
string
responseId
فقط خروجی answerId برای شناسایی هر پاسخ استفاده می شود.
نمایندگی JSON |
---|
{ "candidates": [ { object ( |
PromptFeedback
مجموعه ای از فراداده های بازخوردی که در GenerateContentRequest.content
مشخص شده است.
blockReason
enum ( BlockReason
)
اختیاری. در صورت تنظیم، درخواست مسدود شده است و هیچ نامزدی برگردانده نمی شود. دستور را دوباره بیان کنید.
safetyRatings[]
object ( SafetyRating
)
رتبه بندی برای ایمنی سریع. حداکثر یک رتبه برای هر دسته وجود دارد.
نمایندگی JSON |
---|
{ "blockReason": enum ( |
BlockReason
دلیل مسدود شدن درخواست را مشخص می کند.
Enums | |
---|---|
BLOCK_REASON_UNSPECIFIED | مقدار پیش فرض این مقدار استفاده نشده است. |
SAFETY | درخواست به دلایل ایمنی مسدود شد. safetyRatings بررسی کنید تا متوجه شوید کدام دسته ایمنی آن را مسدود کرده است. |
OTHER | درخواست به دلایل نامعلوم مسدود شد. |
BLOCKLIST | درخواست به دلیل شرایطی که از فهرست مسدودی اصطلاحات موجود است مسدود شد. |
PROHIBITED_CONTENT | درخواست به دلیل محتوای ممنوع مسدود شد. |
IMAGE_SAFETY | نامزدها به دلیل محتوای تولید تصویر ناایمن مسدود شدند. |
UsageMetadata
فراداده در مورد استفاده از رمز درخواست تولید.
promptTokenCount
integer
تعداد توکن ها در اعلان. هنگامی که cachedContent
تنظیم میشود، این اندازه هنوز کل اندازه مؤثر است به این معنی که شامل تعداد نشانههای موجود در محتوای کش میشود.
cachedContentTokenCount
integer
تعداد توکن ها در قسمت کش شده اعلان (محتوای ذخیره شده)
candidatesTokenCount
integer
تعداد کل توکن ها در همه نامزدهای پاسخ تولید شده.
toolUsePromptTokenCount
integer
فقط خروجی تعداد نشانههای موجود در اعلان (های) استفاده از ابزار.
thoughtsTokenCount
integer
فقط خروجی تعداد نشانه های افکار برای مدل های تفکر.
totalTokenCount
integer
تعداد کل توکن برای درخواست تولید (کاندیداهای سریع + پاسخ).
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
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- وب
- RetrievedContext
- GroundingSupport
- بخش
- RetrievalMetadata
- Logprobs Result
- Top Candidates
- نامزد
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
یک کاندید پاسخ تولید شده از مدل.
content
object ( Content
)
فقط خروجی محتوای تولید شده از مدل برگردانده شده است.
finishReason
enum ( FinishReason
)
اختیاری. فقط خروجی دلیل توقف تولید توکن توسط مدل.
اگر خالی باشد، مدل تولید توکن را متوقف نکرده است.
safetyRatings[]
object ( SafetyRating
)
فهرست رتبه بندی برای ایمنی یک نامزد پاسخ.
حداکثر یک رتبه برای هر دسته وجود دارد.
citationMetadata
object ( CitationMetadata
)
فقط خروجی اطلاعات استناد برای نامزد تولید شده توسط مدل.
این قسمت ممکن است با اطلاعات تلاوت برای هر متن موجود در content
پر شود. اینها قسمتهایی هستند که از مطالب دارای حق چاپ در دادههای آموزشی بنیادی LLM «خوانده میشوند».
tokenCount
integer
فقط خروجی شمارش رمز برای این نامزد.
groundingAttributions[]
object ( GroundingAttribution
)
فقط خروجی اطلاعات انتساب برای منابعی که به یک پاسخ پایه کمک کرده اند.
این فیلد برای تماسهای GenerateAnswer
پر شده است.
groundingMetadata
object ( GroundingMetadata
)
فقط خروجی متاداده پایه برای نامزد.
این فیلد برای تماسهای GenerateContent
پر شده است.
number
avgLogprobs
فقط خروجی میانگین امتیاز احتمال ورود نامزد.
logprobsResult
object ( LogprobsResult
)
فقط خروجی امتیازات لاگ احتمال برای توکن های پاسخ و نشانه های برتر
urlContextMetadata
object ( UrlContextMetadata
)
فقط خروجی فراداده مربوط به ابزار بازیابی زمینه آدرس اینترنتی.
integer
index
فقط خروجی فهرست نامزد در لیست کاندیداهای پاسخ.
finishMessage
string
پیام اختیاری. فقط خروجی دلیل توقف تولید توکن ها توسط مدل را شرح می دهد. این فقط زمانی پر می شود که finishReason
تنظیم شده باشد.
نمایندگی JSON |
---|
{ "content": { object ( |
FinishReason
دلیل توقف تولید توکن ها توسط مدل را مشخص می کند.
Enums | |
---|---|
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 | مدل به طور متوالی ابزارهای زیادی را فراخوانی کرد، بنابراین سیستم از اجرا خارج شد. |
GroundingAttribution
ذکر منبعی که به یک پاسخ کمک کرده است.
sourceId
object ( AttributionSourceId
)
فقط خروجی شناسه منبع کمک کننده در این انتساب.
content
object ( Content
)
محتوای منبع پایه که این انتساب را تشکیل می دهد.
نمایندگی JSON |
---|
{ "sourceId": { object ( |
AttributionSourceId
شناسه منبع کمک کننده در این انتساب.
source
Union type
source
می تواند تنها یکی از موارد زیر باشد: groundingPassage
object ( GroundingPassageId
)
شناسه برای یک گذر درون خطی.
semanticRetrieverChunk
object ( SemanticRetrieverChunk
)
شناسه یک Chunk
که از طریق Semantic Retriever واکشی شده است.
نمایندگی JSON |
---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
شناسه بخشی در GroundingPassage
.
string
passageId
فقط خروجی شناسه متن مطابق با GenerateAnswerRequest
's GroundingPassage.id
.
partIndex
integer
فقط خروجی فهرست بخش در 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 } |
GroundingMetadata
هنگامی که اتصال زمین فعال است، متادیتا به مشتری بازگردانده می شود.
groundingChunks[]
object ( GroundingChunk
)
فهرست منابع پشتیبان بازیابی شده از منبع زمینی مشخص شده.
groundingSupports[]
object ( GroundingSupport
)
لیست پشتیبانی از زمین
string
webSearchQueries[]
جستارهای جستجوی وب برای جستجوی وب بعدی.
searchEntryPoint
object ( SearchEntryPoint
)
اختیاری. ورودی جستجوی گوگل برای جستجوهای وب بعدی.
object ( RetrievalMetadata )
retrievalMetadata
فراداده مربوط به بازیابی در جریان زمین.
نمایندگی JSON |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
نقطه ورودی جستجوی گوگل
renderedContent
string
اختیاری. قطعه محتوای وب که می تواند در یک صفحه وب یا نمای وب برنامه جاسازی شود.
sdkBlob
string ( bytes format)
اختیاری. Base64 JSON کدگذاری شده آرایه ای از تاپل <search term, search url> را نشان می دهد.
رشته ای با کد base64.
نمایندگی JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
قطعه زمین.
chunk_type
Union type
chunk_type
فقط می تواند یکی از موارد زیر باشد:web
object ( Web
)
زمین کردن تکه از وب.
retrievedContext
object ( RetrievedContext
)
اختیاری. قطعه زمینی از زمینه بازیابی شده توسط ابزار جستجوی فایل.
نمایندگی JSON |
---|
{ // chunk_type "web": { object ( |
وب
تکه ای از وب.
string
uri
مرجع URI قطعه.
string
title
عنوان تکه.
نمایندگی JSON |
---|
{ "uri": string, "title": string } |
RetrievedContext
تکهای از متن بازیابی شده توسط ابزار جستجوی فایل.
string
uri
اختیاری. مرجع URI سند بازیابی معنایی.
string
title
اختیاری. عنوان سند
string
text
اختیاری. متن تکه.
نمایندگی JSON |
---|
{ "uri": string, "title": string, "text": string } |
GroundingSupport
پشتیبانی زمین.
groundingChunkIndices[]
integer
فهرستی از شاخصها (به «grounding_chunk») که استنادهای مرتبط با ادعا را مشخص میکند. برای مثال [1،3،4] به این معنی است که grounding_chunk[1]، grounding_chunk[3]، grounding_chunk[4] محتوای بازیابی شده منتسب به ادعا هستند.
امتیاز اعتماد مراجع پشتیبانی محدوده از 0 تا 1. 1 مطمئن ترین است. اندازه این لیست باید به اندازه groundingChunkIndices باشد.
segment
object ( Segment
)
بخشی از محتوایی که این پشتیبانی به آن تعلق دارد.
نمایندگی JSON |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
بخش
بخش محتوا
partIndex
integer
فقط خروجی نمایه یک شی Part در شیء محتوای مادر آن.
startIndex
integer
فقط خروجی شاخص شروع در قسمت داده شده، در بایت اندازه گیری می شود. آفست از شروع قطعه، شامل، با شروع از صفر.
endIndex
integer
فقط خروجی نمایه پایان در قسمت داده شده، بر حسب بایت اندازه گیری می شود. افست از شروع قطعه، انحصاری، شروع از صفر.
string
text
فقط خروجی متن مربوط به بخش از پاسخ.
نمایندگی JSON |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
فراداده مربوط به بازیابی در جریان زمین.
number
googleSearchDynamicRetrievalScore
اختیاری. امتیاز نشان میدهد که اطلاعات جستجوی Google چقدر میتواند به پاسخگویی به درخواست کمک کند. امتیاز در محدوده [0، 1] است که 0 کمترین احتمال و 1 محتمل ترین است. این امتیاز تنها زمانی جمع می شود که جستجوی google grounding و بازیابی پویا فعال باشد. برای تعیین اینکه آیا جستجوی گوگل راه اندازی شود یا خیر، با آستانه مقایسه می شود.
نمایندگی JSON |
---|
{ "googleSearchDynamicRetrievalScore": number } |
Logprobs Result
نتایج Logprobs
topCandidates[]
object ( TopCandidates
)
طول = تعداد کل مراحل رمزگشایی.
object ( Candidate )
chosenCandidates[]
طول = تعداد کل مراحل رمزگشایی. نامزدهای انتخاب شده ممکن است در topCandidates باشند یا نباشند.
number
logProbabilitySum
مجموع احتمالات لاگ برای همه توکن ها.
نمایندگی JSON |
---|
{ "topCandidates": [ { object ( |
Top Candidates
کاندیداهایی که در هر مرحله رمزگشایی احتمالات ثبت بالا را دارند.
candidates[]
object ( Candidate
)
بر اساس احتمال گزارش به ترتیب نزولی مرتب شده است.
نمایندگی JSON |
---|
{
"candidates": [
{
object ( |
نامزد
نامزد برای نشانه و امتیاز logprobs.
string
token
مقدار رشته رمز نامزد.
tokenId
integer
مقدار شناسه رمز نامزد.
logProbability
number
احتمالاحتمال ثبت نام نامزد.
نمایندگی JSON |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
فراداده مربوط به ابزار بازیابی زمینه آدرس اینترنتی.
urlMetadata[]
object ( UrlMetadata
)
فهرست زمینه url.
نمایندگی JSON |
---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
زمینه بازیابی یک URL واحد.
retrievedUrl
string
آدرس اینترنتی توسط ابزار بازیابی شده است.
urlRetrievalStatus
enum ( UrlRetrievalStatus
)
وضعیت بازیابی url.
نمایندگی JSON |
---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
وضعیت بازیابی url.
Enums | |
---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED | مقدار پیش فرض این مقدار استفاده نشده است. |
URL_RETRIEVAL_STATUS_SUCCESS | بازیابی آدرس اینترنتی با موفقیت انجام شد. |
URL_RETRIEVAL_STATUS_ERROR | بازیابی آدرس اینترنتی به دلیل خطا انجام نشد. |
URL_RETRIEVAL_STATUS_PAYWALL | بازیابی URL انجام نشد زیرا محتوا پشت دیوار پرداخت است. |
URL_RETRIEVAL_STATUS_UNSAFE | بازیابی URL انجام نشد زیرا محتوا ناامن است. |
CitationMetadata
مجموعه ای از منابع منبع برای یک قطعه محتوا.
citationSources[]
object ( CitationSource
)
استناد به منابع برای پاسخ خاص.
نمایندگی JSON |
---|
{
"citationSources": [
{
object ( |
منبع استناد
استناد به یک منبع برای بخشی از یک پاسخ خاص.
startIndex
integer
اختیاری. شروع بخش پاسخی که به این منبع نسبت داده می شود.
شاخص شروع بخش را نشان می دهد که در بایت اندازه گیری می شود.
endIndex
integer
اختیاری. انتهای بخش منتسب، انحصاری.
string
uri
اختیاری. URI که به عنوان منبع بخشی از متن نسبت داده می شود.
string
license
اختیاری. مجوز برای پروژه GitHub که به عنوان منبعی برای بخش نسبت داده می شود.
اطلاعات مجوز برای استناد کد مورد نیاز است.
نمایندگی JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
- نمایندگی JSON
- مدالیته
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ImageConfig
- MediaResolution
گزینه های پیکربندی برای تولید مدل و خروجی ها. همه پارامترها برای هر مدلی قابل تنظیم نیستند.
string
stopSequences[]
اختیاری. مجموعه ای از دنباله های کاراکتر (تا 5) که تولید خروجی را متوقف می کند. اگر مشخص شود، 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 را می پذیرد.
در صورت تنظیم، responseSchema
باید حذف شود، اما responseMimeType
مورد نیاز است.
در حالی که ممکن است طرحواره JSON کامل ارسال شود، همه ویژگی ها پشتیبانی نمی شوند. به طور خاص، فقط ویژگی های زیر پشتیبانی می شوند:
-
$id
-
$defs
-
$ref
-
$anchor
-
type
-
format
-
title
-
description
-
enum
(برای رشته ها و اعداد) -
items
-
prefixItems
-
minItems
-
maxItems
-
minimum
-
maximum
-
anyOf
-
oneOf
(تعبیری مشابهanyOf
) -
properties
-
additionalProperties
-
required
ویژگی غیر استاندارد propertyOrdering
نیز ممکن است تنظیم شود.
ارجاعات چرخهای به میزان محدودی باز میشوند و به این ترتیب، فقط در ویژگیهای غیر ضروری قابل استفاده هستند. (ویژگیهای تهشونده کافی نیستند.) اگر $ref
روی یک طرح فرعی تنظیم شود، هیچ ویژگی دیگری به جز آنهایی که با $
شروع میشوند، نمیتوانند تنظیم شوند.
responseJsonSchema
value ( Value
format)
اختیاری. یک جزئیات داخلی به جای این فیلد از responseJsonSchema
استفاده کنید.
responseModalities[]
enum ( Modality
)
اختیاری. روشهای درخواستی پاسخ. مجموعه ای از روش هایی را نشان می دهد که مدل می تواند بازگرداند و باید در پاسخ انتظار داشت. این دقیقاً مطابق با روشهای پاسخ است.
یک مدل ممکن است چندین ترکیب از روش های پشتیبانی شده داشته باشد. اگر روشهای درخواستی با هیچ یک از ترکیبهای پشتیبانیشده مطابقت نداشته باشند، یک خطا برگردانده میشود.
یک لیست خالی معادل درخواست فقط متن است.
candidateCount
integer
اختیاری. تعداد پاسخ های تولید شده برای بازگشت. اگر تنظیم نشود، به طور پیشفرض روی ۱ خواهد بود. لطفاً توجه داشته باشید که این برای مدلهای نسل قبلی (خانواده Gemini 1.0) کار نمیکند.
maxOutputTokens
integer
اختیاری. حداکثر تعداد نشانه هایی که باید در یک نامزد پاسخ گنجانده شود.
توجه: مقدار پیش فرض بسته به مدل متفاوت است، به ویژگی Model.output_token_limit
Model
بازگشتی از تابع getModel
مراجعه کنید.
number
temperature
اختیاری. تصادفی بودن خروجی را کنترل می کند.
توجه: مقدار پیش فرض بر اساس مدل متفاوت است، به ویژگی Model.temperature
Model
بازگشتی از تابع getModel
مراجعه کنید.
مقادیر می توانند از [0.0، 2.0] متغیر باشند.
number
topP
اختیاری. حداکثر احتمال تجمعی نشانه هایی که باید در هنگام نمونه گیری در نظر گرفته شوند.
این مدل از نمونه برداری ترکیبی Top-k و Top-p (هسته) استفاده می کند.
توکن ها بر اساس احتمالات اختصاص داده شده مرتب می شوند تا فقط محتمل ترین توکن ها در نظر گرفته شوند. نمونهگیری Top-k مستقیماً حداکثر تعداد توکنهای مورد نظر را محدود میکند، در حالی که نمونهبرداری هستهای تعداد نشانهها را بر اساس احتمال تجمعی محدود میکند.
توجه: مقدار پیشفرض براساس Model
متفاوت است و با ویژگی Model.top_p
که از تابع getModel
برگردانده شده است، مشخص میشود. یک ویژگی topK
خالی نشان میدهد که مدل نمونهگیری top-k را اعمال نمیکند و اجازه تنظیم topK
در درخواستها نمیدهد.
topK
integer
اختیاری. حداکثر تعداد نشانه هایی که باید در هنگام نمونه گیری در نظر گرفته شود.
مدل های Gemini از نمونه برداری Top-p (هسته) یا ترکیبی از نمونه برداری Top-k و هسته استفاده می کنند. نمونه گیری Top-k مجموعه ای از محتمل ترین توکن های topK
را در نظر می گیرد. مدلهایی که با نمونهبرداری هسته اجرا میشوند، اجازه تنظیم topK را نمیدهند.
توجه: مقدار پیشفرض براساس Model
متفاوت است و با ویژگی Model.top_p
که از تابع getModel
برگردانده شده است، مشخص میشود. یک ویژگی topK
خالی نشان میدهد که مدل نمونهگیری top-k را اعمال نمیکند و اجازه تنظیم topK
در درخواستها نمیدهد.
integer
seed
اختیاری. بذر مورد استفاده در رمزگشایی اگر تنظیم نشود، درخواست از یک دانه تولید شده به طور تصادفی استفاده می کند.
presencePenalty
number
جریمهاختیاری. اگر نشانه قبلاً در پاسخ دیده شده باشد، جریمه حضور برای logprobs نشانه بعدی اعمال می شود.
این پنالتی باینری روشن/خاموش است و به تعداد دفعات استفاده از توکن (بعد از اولین بار) بستگی ندارد. برای جریمه ای که با هر بار استفاده افزایش می یابد، از frequencyPenalty
استفاده کنید.
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
اختیاری. 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
اختیاری. If true, export the logprobs results in response.
logprobs
integer
اختیاری. 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
اختیاری. Enables enhanced civic answers. It may not be available for all models.
speechConfig
object ( SpeechConfig
)
اختیاری. The speech generation config.
thinkingConfig
object ( ThinkingConfig
)
اختیاری. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
imageConfig
object ( ImageConfig
)
اختیاری. 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
)
اختیاری. If specified, the media resolution specified will be used.
JSON representation |
---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
مدالیته
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
The speech generation config.
voiceConfig
object ( VoiceConfig
)
The configuration in case of single-voice output.
multiSpeakerVoiceConfig
object ( MultiSpeakerVoiceConfig
)
اختیاری. The configuration for the multi-speaker setup. It is mutually exclusive with the voiceConfig field.
languageCode
string
اختیاری. 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 representation |
---|
{ "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 representation |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
The configuration for the prebuilt speaker to use.
voiceName
string
The name of the preset voice to use.
JSON representation |
---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
The configuration for the multi-speaker setup.
speakerVoiceConfigs[]
object ( SpeakerVoiceConfig
)
مورد نیاز. All the enabled speaker voices.
JSON representation |
---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
The configuration for a single speaker in a multi speaker setup.
speaker
string
مورد نیاز. The name of the speaker to use. Should be the same as in the prompt.
voiceConfig
object ( VoiceConfig
)
مورد نیاز. The configuration for the voice to use.
JSON representation |
---|
{
"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 representation |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
ImageConfig
Config for image generation features.
aspectRatio
string
اختیاری. 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 representation |
---|
{ "aspectRatio": string } |
MediaResolution
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). |
HarmCategory
The category of a rating.
These categories cover various kinds of harms that developers may wish to adjust.
Enums | |
---|---|
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 representation |
---|
{
"modality": enum ( |
مدالیته
Content Part modality
Enums | |
---|---|
MODALITY_UNSPECIFIED | Unspecified modality. |
TEXT | متن ساده |
IMAGE | تصویر. |
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.
category
enum ( HarmCategory
)
مورد نیاز. The category for this rating.
probability
enum ( HarmProbability
)
مورد نیاز. The probability of harm for this content.
blocked
boolean
Was this content blocked because of this rating?
JSON representation |
---|
{ "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.
Enums | |
---|---|
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
)
مورد نیاز. The category for this setting.
threshold
enum ( HarmBlockThreshold
)
مورد نیاز. Controls the probability threshold at which harm is blocked.
JSON representation |
---|
{ "category": enum ( |
HarmBlockThreshold
Block at and beyond a specified harm probability.
Enums | |
---|---|
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. |