نقطه پایانی مدلها روشی را برای شما فراهم میکند تا بهصورت برنامهنویسی مدلهای دردسترس را فهرست کنید و فرادادههای گسترده مانند عملکرد پشتیبانیشده و اندازه پنجره بافت را بازیابی کنید. در راهنمای مدلها اطلاعات بیشتری کسب کنید.
روش: models.get
اطلاعاتی درباره یک Model خاص، مانند شماره نسخه، محدودیتهای توکن، پارامترها و سایر فرادادهها، دریافت میکند. برای اطلاعات دقیق درباره مدل، به راهنمای مدلهای Gemini مراجعه کنید.
نقطه پایانی
دریافتhttps: / /generativelanguage.googleapis.com /v1beta /{name=models /*}
پارامترهای مسیر
name
string
الزامی. نام منبع مدل.
این نام باید با نام مدلی که روش models.list برمیگرداند مطابقت داشته باشد.
قالب: models/{model} به شکل models/{model} است.
متن درخواست
بدنه درخواست باید خالی باشد.
درخواست نمونه
Python
رفتن
صدف
بدنه پاسخ
اگر موفقیتآمیز باشد، بدنه پاسخ حاوی نمونهای از Model است.
روش: models.list
Modelهای دردسترس ازطریق Gemini API را فهرست میکند.
نقطه پایانی
دریافتhttps: / /generativelanguage.googleapis.com /v1beta /models
پارامترهای پُرسمان
pageSize
integer
حداکثر تعداد Models برای برگرداندن (در هر صفحه).
اگر مشخص نشده باشد، ۵۰ مدل در هر صفحه برگردانده میشود. این روش حداکثر ۱۰۰۰ مدل در هر صفحه برمیگرداند، حتی اگر pageSize بزرگتری را ارسال کنید.
pageToken
string
یک توکن صفحه، که از تماس قبلی models.list دریافت شده است.
pageToken برگرداندهشده توسط یک درخواست را بهعنوان آرگومان برای درخواست بعدی ارائه دهید تا صفحه بعدی بازیابی شود.
هنگام صفحهبندی، همه پارامترهای دیگری که به models.list ارائه میشوند باید با فراخوانیای که توکن صفحه را ارائه کرده است مطابقت داشته باشند.
متن درخواست
بدنه درخواست باید خالی باشد.
درخواست نمونه
Python
رفتن
صدف
بدنه پاسخ
پاسخ از ListModel حاوی فهرست صفحهبندیشده «مدلها».
اگر موفقیتآمیز باشد، بدنه پاسخ حاوی دادههایی با ساختار زیر است:
models[]
object (Model)
مدلهای برگرداندهشده.
nextPageToken
string
یک کد، که میتواند بهعنوان pageToken برای بازیابی صفحه بعدی ارسال شود.
اگر این فیلد حذف شود، صفحه دیگری وجود ندارد.
| نمایش JSON |
|---|
{
"models": [
{
object ( |
منبع REST: مدلها
منبع: مدل
اطلاعاتی درباره «مدل زبانی زایا».
name
string
الزامی. نام منبع Model. برای همه مقادیر مجاز، به انواع مدل مراجعه کنید.
قالب: models/{model} با قرارداد نامگذاری {model}:
- "{baseModelId}-{version}"
مثالها:
models/gemini-1.5-flash-001
baseModelId
string
الزامی. نام مدل پایه، این را به درخواست تولید ارسال کنید.
مثالها:
gemini-1.5-flash
version
string
الزامی. شماره نسخه مدل.
این نشاندهنده نسخه عمده است (1.0 یا 1.5)
displayName
string
نام قابلخواندن برای انسان برای مدل. مثلاً «Gemini 1.5 Flash».
نام میتواند حداکثر ۱۲۸ نویسه باشد و میتواند شامل هر نویسه UTF-8 باشد.
description
string
شرح کوتاهی از مدل.
inputTokenLimit
integer
حداکثر تعداد دادهواحد ورودی مجاز برای این مدل.
outputTokenLimit
integer
حداکثر تعداد دادهواحدهای خروجی دردسترس برای این مدل.
supportedGenerationMethods[]
string
روشهای تولید پشتیبانیشده مدل.
نامهای روش میانای برنامهسازی کاربردی مربوطه بهعنوان رشتههای Pascal case تعریف میشوند، مانند generateMessage و generateContent.
thinking
boolean
اینکه آیا مدل از فکر کردن پشتیبانی میکند یا نه.
temperature
number
تصادفی بودن برونداد را کنترل میکند.
مقادیر میتوانند در محدوده [0.0,maxTemperature] باشند. مقدار بالاتر پاسخهایی تولید میکند که تنوع بیشتری دارند، درحالیکه مقدار نزدیکتر به 0.0 معمولاً منجر به پاسخهای کمتر غافلگیرکننده از مدل میشود. این مقدار پیشفرضی را مشخص میکند که باید توسط پسزمینه هنگام برقراری تماس با مدل استفاده شود.
maxTemperature
number
حداکثر دمایی که این مدل میتواند استفاده کند.
topP
number
برای نمونهبرداری Nucleus.
نمونهگیری هستهای کوچکترین مجموعه از نشانههایی را درنظر میگیرد که مجموع احتمال آنها حداقل topP باشد. این مقدار پیشفرضی را مشخص میکند که باید توسط پسزمینه هنگام برقراری تماس با مدل استفاده شود.
topK
integer
برای نمونهبرداری Top-k.
نمونهبرداری Top-k مجموعه topK محتملترین دادهواحد را درنظر میگیرد. این مقدار پیشفرضی را مشخص میکند که باید توسط پسزمینه هنگام برقراری تماس با مدل استفاده شود. اگر خالی باشد، نشان میدهد که مدل از نمونهبرداری top-k استفاده نمیکند و topK بهعنوان پارامتر تولید مجاز نیست.
| نمایش JSON |
|---|
{ "name": string, "baseModelId": string, "version": string, "displayName": string, "description": string, "inputTokenLimit": integer, "outputTokenLimit": integer, "supportedGenerationMethods": [ string ], "thinking": boolean, "temperature": number, "maxTemperature": number, "topP": number, "topK": integer } |
روش: models.predict
درخواست پیشبینی را اجرا میکند.
نقطه پایانی
پستhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:predict
پارامترهای مسیر
model
string
الزامی. نام مدل برای پیشبینی. قالب: name=models/{model}. این فرم models/{model} را میگیرد.
متن درخواست
بدنه درخواست حاوی دادههایی با ساختار زیر است:
instances[]
value (Value format)
الزامی. نمونههایی که ورودی تماس پیشبینی هستند.
parameters
value (Value format)
اختیاری. پارامترهایی که تماس پیشبینی را کنترل میکنند.
labels
map (key: string, value: string)
اختیاری. برچسبهای دارای فراداده تعریفشده توسط کاربر برای درخواست.
اختیاری. برچسبها باید از الزامات استاندارد برچسب Cloud یکپارچه پیروی کنند: - کلیدهای برچسب باید با حرف شروع شوند. - کلیدها و مقادیر برچسب نباید بیشتر از ۶۳ نویسه (نقطه کد یونیکد) باشند و فقط میتوانند حاوی حروف کوچک، نویسههای عددی، زیرخط، و خط تیره باشند. - نویسههای بینالمللی مجاز هستند.
کاربرد: - شناسههای ایمنی از تجمیعکنندهها: از کلید safety_identifier استفاده کنید (مثلاً {"safety_identifier": "user_session_123"})
شیئی که حاوی فهرستی از جفتهای "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
بدنه پاسخ
پیام پاسخ برای [PredictionService.Predict].
اگر موفقیتآمیز باشد، بدنه پاسخ حاوی دادههایی با ساختار زیر است:
predictions[]
value (Value format)
بروندادهای فراخوانی پیشبینی.
| نمایش JSON |
|---|
{ "predictions": [ value ] } |
روش: models.predictLongRunning
همانند models.predict است اما LRO برمیگرداند.
نقطه پایانی
پستhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:predictLongRunning
پارامترهای مسیر
model
string
الزامی. نام مدل برای پیشبینی. قالب: name=models/{model}.
متن درخواست
بدنه درخواست حاوی دادههایی با ساختار زیر است:
instances[]
value (Value format)
الزامی. نمونههایی که ورودی تماس پیشبینی هستند.
parameters
value (Value format)
اختیاری. پارامترهایی که تماس پیشبینی را کنترل میکنند.
webhookConfig.uris[]
string
اختیاری. اگر تنظیم شود، از این URIهای وبقلاب بهجای وبقلابهای ثبتشده برای رویدادهای وبقلاب استفاده خواهد شد.
labels
map (key: string, value: string)
اختیاری. برچسبهای دارای فراداده تعریفشده توسط کاربر برای درخواست.
اختیاری. برچسبها باید از الزامات استاندارد برچسب Cloud یکپارچه پیروی کنند: - کلیدهای برچسب باید با حرف شروع شوند. - کلیدها و مقادیر برچسب نباید بیشتر از ۶۳ نویسه (نقطه کد یونیکد) باشند و فقط میتوانند حاوی حروف کوچک، نویسههای عددی، زیرخط، و خط تیره باشند. - نویسههای بینالمللی مجاز هستند.
کاربرد: - شناسههای ایمنی از تجمیعکنندهها: از کلید safety_identifier استفاده کنید (مثلاً {"safety_identifier": "user_session_123"})
شیئی که حاوی فهرستی از جفتهای "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
بدنه پاسخ
اگر موفقیتآمیز باشد، بدنه پاسخ حاوی نمونهای از Operation است.