נקודת הקצה של המודלים מאפשרת לכם להציג באופן פרוגרמטי את המודלים הזמינים, ולאחזר מטא-נתונים מורחבים כמו פונקציונליות נתמכת וגודל חלון ההקשר. מידע נוסף זמין במדריך למודלים.
Method: 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
מציגה את Model שזמינים דרך 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: מודלים
משאב: מודל
מידע על מודל שפה גנרטיבי.
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
שיטות היצירה שהמודל תומך בהן.
השמות של השיטות התואמות ב-API מוגדרים כמחרוזות PascalCase, כמו generateMessage ו-generateContent.
thinking
boolean
אם המודל תומך בחשיבה.
temperature
number
שולט באקראיות של הפלט.
הערכים יכולים להיות בטווח של [0.0,maxTemperature], כולל. ערך גבוה יותר יפיק תשובות מגוונות יותר, ואילו ערך קרוב יותר ל-0.0 יגרום בדרך כלל לתשובות פחות מפתיעות מהמודל. הערך הזה מציין את ברירת המחדל שבה ה-backend ישתמש כשהוא יבצע את הקריאה למודל.
maxTemperature
number
הטמפרטורה המקסימלית שהמודל הזה יכול להשתמש בה.
topP
number
דגימת גרעין מתייחסת לקבוצה הקטנה ביותר של טוקנים שסכום ההסתברות שלהם הוא לפחות topP. הערך הזה מציין את ברירת המחדל שבה משתמש ה-backend בזמן ביצוע הקריאה למודל.
topK
integer
לדגימת Top-k.
דגימת Top-K מתייחסת לקבוצה של topK הטוקנים הסבירים ביותר. הערך הזה מציין את ברירת המחדל שבה ה-backend ישתמש כשהוא יבצע את הקריאה למודל. אם הוא ריק, סימן שהמודל לא משתמש בדגימת 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 } |
Method: 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 מאוחדות: - המפתחות של התוויות צריכים להתחיל באות. - המפתחות והערכים של התוויות יכולים להכיל עד 63 תווים (נקודות קוד ב-Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. - אפשר להשתמש בתווים בינלאומיים.
אופן השימוש: - מזהי בטיחות מאגרגטורים: משתמשים במפתח 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 ] } |
Method: 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
אופציונלי. אם מגדירים את ה-URIs האלה של ה-webhook, הם ישמשו לאירועי webhook במקום ה-webhooks הרשומים.
labels
map (key: string, value: string)
אופציונלי. תוויות עם מטא-נתונים שהוגדרו על ידי המשתמש לבקשה.
אופציונלי. התוויות צריכות לעמוד בדרישות הרגילות של תוויות Cloud מאוחדות: - המפתחות של התוויות צריכים להתחיל באות. - המפתחות והערכים של התוויות יכולים להכיל עד 63 תווים (נקודות קוד ב-Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. - אפשר להשתמש בתווים בינלאומיים.
אופן השימוש: - מזהי בטיחות מאגרגטורים: משתמשים במפתח safety_identifier (למשל {"safety_identifier": "user_session_123"})
אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.