נקודת הקצה של המודלים מאפשרת לכם ליצור רשימה של המודלים הזמינים באופן פרוגרמטי, ולאחזר מטא-נתונים מורחבים כמו פונקציונליות נתמכת וגודל חלון ההקשר. מידע נוסף זמין במדריך בנושא מודלים.
שיטה: models.get
קבלת מידע על Model ספציפי, כמו מספר הגרסה, מגבלות הטוקנים, פרמטרים ומטא-נתונים אחרים. מידע מפורט על המודלים זמין במדריך למודלים של Gemini.
נקודת קצה
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=models /*}
פרמטרים של נתיב
name
string
חובה. שם המשאב של המודל.
השם הזה צריך להיות זהה לשם של מודל שמוחזר על ידי השיטה models.list.
פורמט: models/{model} הפורמט הוא models/{model}.
גוף הבקשה
גוף הבקשה צריך להיות ריק.
דוגמה לבקשה
Python
Go
קונכייה
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Model.
Method: models.list
רשימה של Models שזמינים דרך Gemini API.
נקודת קצה
gethttps: / /generativelanguage.googleapis.com /v1beta /models
פרמטרים של שאילתה
pageSize
integer
המספר המקסימלי של Models שיוחזרו (לכל דף).
אם לא מציינים ערך, יוצגו 50 מודלים בכל דף. השיטה הזו מחזירה לכל היותר 1,000 מודלים לדף, גם אם מעבירים pageSize גדול יותר.
pageToken
string
טוקן של דף שהתקבל מקריאה קודמת של models.list.
כדי לאחזר את הדף הבא, צריך להזין את pageToken שהוחזר מבקשה אחת כארגומנט לבקשה הבאה.
כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-models.list חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
גוף הבקשה
גוף הבקשה צריך להיות ריק.
דוגמה לבקשה
Python
Go
קונכייה
גוף התשובה
תשובה מ-ListModel שמכילה רשימה עם מספור עמודים של מודלים.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
models[]
object (Model)
המודלים שמוחזרים.
nextPageToken
string
טוקן שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא.
אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.
| ייצוג ב-JSON |
|---|
{
"models": [
{
object ( |
משאב REST: models
משאב: מודל
מידע על מודל שפה גנרטיבי.
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.
השם יכול להכיל עד 128 תווים, והוא יכול לכלול כל תו UTF-8.
description
string
תיאור קצר של המודל.
inputTokenLimit
integer
המספר המקסימלי של טוקנים של קלט שמותר למודל הזה.
outputTokenLimit
integer
מספר הטוקנים המקסימלי של הפלט שזמין במודל הזה.
supportedGenerationMethods[]
string
שיטות היצירה הנתמכות של המודל.
שמות ה-method המתאימים של ה-API מוגדרים כמחרוזות בפורמט Pascal case, כמו generateMessage ו-generateContent.
thinking
boolean
האם המודל תומך בחשיבה.
temperature
number
המדיניות קובעת את מידת הרנדומיזציה של הפלט.
הערכים יכולים לנוע בין [0.0,maxTemperature], כולל. ערך גבוה יותר יניב תשובות מגוונות יותר, ואילו ערך שקרוב יותר ל-0.0 בדרך כלל יניב תשובות פחות מפתיעות מהמודל. הערך הזה מציין את ברירת המחדל שבה ה-Backend ישתמש בזמן שהוא מבצע את הקריאה למודל.
maxTemperature
number
רמת האקראיות המקסימלית שבה המודל הזה יכול להשתמש.
topP
number
דגימת גרעין מתייחסת לקבוצה הקטנה ביותר של טוקנים שסכום ההסתברות שלהם הוא לפחות topP. הערך הזה מציין את ברירת המחדל שבה ה-Backend ישתמש בזמן שהוא מבצע את הקריאה למודל.
topK
integer
לדגימת k המילים המובילות.
דגימת Top-k מתייחסת לקבוצה של topK הטוקנים הסבירים ביותר. הערך הזה מציין את ברירת המחדל שבה ה-Backend ישתמש בזמן שהוא מבצע את הקריאה למודל. אם הערך ריק, המשמעות היא שהמודל לא משתמש בדגימה של 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
מבצעת בקשת חיזוי.
נקודת קצה
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:predict
פרמטרים של נתיב
model
string
חובה. שם המודל לחיזוי. פורמט: name=models/{model} הוא מקבל את הצורה models/{model}.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
instances[]
value (Value format)
חובה. המופעים שמשמשים כקלט לקריאת החיזוי.
parameters
value (Value format)
אופציונלי. הפרמטרים שקובעים את שיחת החיזוי.
גוף התשובה
הודעת תגובה ל- [PredictionService.Predict].
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
predictions[]
value (Value format)
הפלט של קריאת החיזוי.
| ייצוג ב-JSON |
|---|
{ "predictions": [ value ] } |
Method: models.predictLongRunning
זהה ל-models.predict אבל מחזיר LRO.
נקודת קצה
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:predictLongRunning
פרמטרים של נתיב
model
string
חובה. שם המודל לחיזוי. פורמט: name=models/{model}
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
instances[]
value (Value format)
חובה. המופעים שמשמשים כקלט לקריאת החיזוי.
parameters
value (Value format)
אופציונלי. הפרמטרים שקובעים את שיחת החיזוי.
webhookConfig.uris[]
string
אופציונלי. אם מגדירים כתובות URI של webhook, הן ישמשו לאירועי webhook במקום כתובות ה-webhook הרשומות.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.