שמירת מטמון של הקשר מאפשרת לכם לשמור ולעשות שימוש חוזר בטוקנים של קלט שחושבו מראש שאתם רוצים להשתמש בהם שוב ושוב, למשל כשאתם שואלים שאלות שונות לגבי אותו קובץ מדיה. השימוש ב-CDN יכול להוביל לחיסכון בעלויות ולשיפור המהירות, בהתאם לשימוש. למידע נוסף, אפשר לעיין במדריך בנושא שמירת הקשר במטמון.
שיטה: cachedContents.create
יוצר משאב CachedContent.
נקודת קצה
posthttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
גוף הבקשה
גוף הבקשה מכיל מופע של CachedContent.
contents[]
object (Content)
אופציונלי. קלט בלבד. אי אפשר לשנות. התוכן שרוצים לשמור במטמון.
tools[]
object (Tool)
אופציונלי. קלט בלבד. אי אפשר לשנות. רשימה של Tools שהמודל יכול להשתמש בהם כדי ליצור את התשובה הבאה
expiration
Union type
expiration יכול להיות רק אחד מהבאים:expireTime
string (Timestamp format)
חותמת זמן בשעון UTC שמציינת מתי המשאב הזה נחשב כמשאב שתוקפו פג. הערך הזה תמיד מופיע בפלט, לא משנה מה נשלח בקלט.
הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
קלט בלבד. ערך חדש של TTL למשאב הזה, קלט בלבד.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
displayName
string
אופציונלי. אי אפשר לשנות. שם התצוגה המשמעותי של התוכן שבמטמון, שנוצר על ידי המשתמש. מקסימום 128 תווים ב-Unicode.
model
string
חובה. אי אפשר לשנות. השם של Model שבו רוצים להשתמש לתוכן שנשמר במטמון. הפורמט: models/{model}
systemInstruction
object (Content)
אופציונלי. קלט בלבד. אי אפשר לשנות. הוראת מערכת שהוגדרה על ידי מפתח. כרגע רק טקסט.
toolConfig
object (ToolConfig)
אופציונלי. קלט בלבד. אי אפשר לשנות. הגדרת הכלי. ההגדרה הזו משותפת לכל הכלים.
דוגמה לבקשה
בסיסית
Python
Node.js
Go
קונכייה
שם השולח
Python
Node.js
Go
מצ'אט
Python
Node.js
Go
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של CachedContent.
שיטה: cachedContents.list
רשימות CachedContents.
נקודת קצה
gethttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
פרמטרים של שאילתה
pageSize
integer
אופציונלי. המספר המקסימלי של תכנים שמאוחסנים במטמון שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזר מספר ברירת מחדל של פריטים (מתחת למקסימום). הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.
pageToken
string
אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של cachedContents.list. צריך להזין את הטוקן כדי לאחזר את הדף הבא.
כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-cachedContents.list חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
תגובה עם רשימת CachedContents.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
cachedContents[]
object (CachedContent)
רשימת התוכן שנשמר במטמון.
nextPageToken
string
טוקן שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.
| ייצוג ב-JSON |
|---|
{
"cachedContents": [
{
object ( |
שיטה: cachedContents.get
קורא את המשאב CachedContent.
נקודת קצה
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
פרמטרים של נתיב
name
string
חובה. שם המשאב שמתייחס לרשומה במטמון התוכן. פורמט: cachedContents/{id} הוא מקבל את הצורה cachedContents/{cachedcontent}.
גוף הבקשה
גוף הבקשה צריך להיות ריק.
דוגמה לבקשה
Python
Node.js
Go
קונכייה
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של CachedContent.
Method: cachedContents.patch
עדכון של משאב CachedContent (אפשר לעדכן רק את תאריך התפוגה).
נקודת קצה
patchhttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*}
פרמטרים של נתיב
cachedContent.name
string
פלט בלבד. מזהה. שם המשאב שאליו מתייחס התוכן שנשמר במטמון. פורמט: cachedContents/{id} הפורמט הוא cachedContents/{cachedcontent}.
פרמטרים של שאילתה
updateMask
string (FieldMask format)
רשימת השדות לעדכון.
זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"
גוף הבקשה
גוף הבקשה מכיל מופע של CachedContent.
expiration
Union type
expiration יכול להיות רק אחד מהבאים:expireTime
string (Timestamp format)
חותמת זמן בשעון UTC שמציינת מתי המשאב הזה נחשב כמשאב שתוקפו פג. הערך הזה תמיד מופיע בפלט, לא משנה מה נשלח בקלט.
הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
קלט בלבד. ערך חדש של TTL למשאב הזה, קלט בלבד.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
דוגמה לבקשה
Python
Node.js
Go
קונכייה
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של CachedContent.
שיטה: cachedContents.delete
מחיקת משאב CachedContent.
נקודת קצה
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
פרמטרים של נתיב
name
string
חובה. שם המשאב שאליו מתייחס הערך במטמון התוכן. הפורמט: cachedContents/{id}. הוא מופיע בצורה cachedContents/{cachedcontent}.
גוף הבקשה
גוף הבקשה צריך להיות ריק.
דוגמה לבקשה
Python
Node.js
Go
קונכייה
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה הוא אובייקט JSON ריק.
משאב REST: cachedContents
- משאב: CachedContent
- ToolConfig
- FunctionCallingConfig
- המצב
- RetrievalConfig
- LatLng
- UsageMetadata
- Methods
משאב: CachedContent
תוכן שעבר עיבוד מראש ואפשר להשתמש בו בבקשה הבאה אל GenerativeService.
אפשר להשתמש בתוכן שמור במטמון רק עם המודל שאיתו הוא נוצר.
contents[]
object (Content)
אופציונלי. קלט בלבד. אי אפשר לשנות. התוכן שרוצים לשמור במטמון.
tools[]
object (Tool)
אופציונלי. קלט בלבד. אי אפשר לשנות. רשימה של Tools שהמודל יכול להשתמש בהם כדי ליצור את התשובה הבאה
createTime
string (Timestamp format)
פלט בלבד. זמן היצירה של רשומת המטמון.
הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime
string (Timestamp format)
פלט בלבד. הזמן שבו רשומת המטמון עודכנה בפעם האחרונה לפי שעון UTC.
הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
usageMetadata
object (UsageMetadata)
פלט בלבד. מטא-נתונים על השימוש בתוכן שנשמר במטמון.
expiration
Union type
expiration יכול להיות רק אחד מהבאים:expireTime
string (Timestamp format)
חותמת זמן בשעון UTC שמציינת מתי המשאב הזה נחשב כמשאב שתוקפו פג. הערך הזה תמיד מופיע בפלט, לא משנה מה נשלח בקלט.
הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
קלט בלבד. ערך חדש של TTL למשאב הזה, קלט בלבד.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
name
string
פלט בלבד. מזהה. שם המשאב שאליו מתייחס התוכן שנשמר במטמון. פורמט: cachedContents/{id}
displayName
string
אופציונלי. אי אפשר לשנות. שם התצוגה המשמעותי של התוכן שבמטמון, שנוצר על ידי המשתמש. מקסימום 128 תווים ב-Unicode.
model
string
חובה. אי אפשר לשנות. השם של Model שבו רוצים להשתמש לתוכן שנשמר במטמון. הפורמט: models/{model}
systemInstruction
object (Content)
אופציונלי. קלט בלבד. אי אפשר לשנות. הוראת מערכת שהוגדרה על ידי מפתח. כרגע רק טקסט.
toolConfig
object (ToolConfig)
אופציונלי. קלט בלבד. אי אפשר לשנות. הגדרת הכלי. ההגדרה הזו משותפת לכל הכלים.
| ייצוג ב-JSON |
|---|
{ "contents": [ { object ( |
ToolConfig
הגדרת הכלי שמכילה פרמטרים לציון השימוש ב-Tool בבקשה.
functionCallingConfig
object (FunctionCallingConfig)
אופציונלי. הגדרת קריאה להפעלת פונקציה.
retrievalConfig
object (RetrievalConfig)
אופציונלי. הגדרת אחזור.
includeServerSideToolInvocations
boolean
אופציונלי. אם הערך הוא true, התשובה של ה-API תכלול את הקריאות לכלים ואת התשובות בצד השרת בהודעה Content. כך הלקוחות יכולים לראות את האינטראקציות של השרת עם הכלים.
| ייצוג ב-JSON |
|---|
{ "functionCallingConfig": { object ( |
FunctionCallingConfig
הגדרה לציון ההתנהגות של קריאה לפונקציה.
mode
enum (Mode)
אופציונלי. מציינים את המצב שבו הפעלת הפונקציה תתבצע. אם לא מציינים ערך, ברירת המחדל היא AUTO.
allowedFunctionNames[]
string
אופציונלי. קבוצה של שמות פונקציות, שאם מספקים אותם, המודל יפעיל רק את הפונקציות האלה.
ההגדרה הזו צריכה להיות מוגדרת רק אם המצב הוא ANY או VALIDATED. שמות הפונקציות צריכים להיות זהים לערך [FunctionDeclaration.name]. אם מגדירים את הפרמטר הזה, המודל ינבא קריאה לפונקציה רק מתוך שמות הפונקציות המותרים.
| ייצוג ב-JSON |
|---|
{
"mode": enum ( |
מצב
הגדרת אופן הביצוע של קריאות לפונקציות על ידי הגדרת מצב הביצוע.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODE_UNSPECIFIED |
מצב לא מוגדר של הפעלת פונקציות. אין להשתמש בערך הזה. |
AUTO |
התנהגות ברירת המחדל של המודל, המודל מחליט לחזות קריאה לפונקציה או תגובה בשפה טבעית. |
ANY |
המודל מוגבל לחיזוי של קריאה לפונקציה בלבד. אם מוגדרים שמות של פונקציות מותרות (allowedFunctionNames), הקריאה החזויה לפונקציה תוגבל לאחד מהשמות האלה. אחרת, הקריאה החזויה לפונקציה תהיה אחת מההצהרות על הפונקציות (functionDeclarations) שסופקו. |
NONE |
המודל לא יבצע חיזוי של הפעלת פונקציה. התנהגות המודל זהה למצב שבו לא מעבירים הצהרות פונקציה. |
VALIDATED |
המודל מחליט אם לחזות קריאה לפונקציה או תשובה בשפה טבעית, אבל הוא יאמת קריאות לפונקציה באמצעות פענוח מוגבל. אם מוגדרים שמות הפונקציות המותרות, הקריאה החזויה לפונקציה תוגבל לאחד משמות הפונקציות המותרות. אחרת, הקריאה החזויה לפונקציה תהיה אחת מהצהרות הפונקציות שסופקו. |
RetrievalConfig
LatLng
אובייקט שמייצג זוג של קווי רוחב ואורך. הערך הזה מבוטא כזוג מספרים ממשיים שמייצגים מעלות של קו רוחב ומעלות של קו אורך. אלא אם צוין אחרת, האובייקט הזה צריך להיות תואם ל תקן WGS84. הערכים צריכים להיות בטווחים מנורמלים.
latitude
number
קו הרוחב במעלות. הערך חייב להיות בטווח [-90.0, +90.0].
longitude
number
קו האורך במעלות. הערך חייב להיות בטווח [-180.0, +180.0].
| ייצוג ב-JSON |
|---|
{ "latitude": number, "longitude": number } |
UsageMetadata
מטא-נתונים על השימוש בתוכן שנשמר במטמון.
totalTokenCount
integer
המספר הכולל של האסימונים שהתוכן שנשמר במטמון צורך.
| ייצוג ב-JSON |
|---|
{ "totalTokenCount": integer } |