Method: models.countTokens

מריצה את כלי ההמרה לאסימונים של מודל בתוכן הקלט, ומחזירה את מספר האסימונים.

בקשת HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countTokens

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
model

string

חובה. שם המשאב של המודל. המזהה הזה משמש את המודל.

השם הזה צריך להיות תואם לשם הדגם שהוחזר על ידי השיטה models.list.

פורמט: models/{model}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON
{
  "contents": [
    {
      object (Content)
    }
  ],
  "generateContentRequest": {
    object (GenerateContentRequest)
  }
}
שדות
contents[]

object (Content)

זה שינוי אופציונלי. הקלט שניתן למודל כהנחיה. המערכת מתעלמת מהשדה הזה כאשר השדה generateContentRequest מוגדר.

generateContentRequest

object (GenerateContentRequest)

זה שינוי אופציונלי. הקלט הכולל שניתן למודל. models.countTokens יספרו הנחיות, קריאות לפונקציות וכו'.

גוף התשובה

תשובה של models.countTokens.

היא מחזירה את הערך tokenCount של המודל במסגרת prompt.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON
{
  "totalTokens": integer
}
שדות
totalTokens

integer

מספר האסימונים שאליהם model מוסיף את האסימון prompt.

תמיד לא שלילי. כשמוגדר תוכן שנשמר במטמון, זה עדיין הגודל הכולל של ההנחיות האפקטיביות. כלומר, זה כולל את מספר האסימונים בתוכן ששמור במטמון.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

למידע נוסף, ראו סקירה כללית על אימות.

GenerateContentRequest

בקשה ליצירת השלמה מהמודל.

ייצוג JSON
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}
שדות
model

string

חובה. השם של Model שישמש ליצירת ההשלמה.

פורמט: name=models/{model}

contents[]

object (Content)

חובה. תוכן השיחה הנוכחית עם המודל.

בשאילתות עם סיבוב אחד, מדובר באירוע יחיד. בשאילתות עם מספר פניות, זהו שדה חוזר שמכיל את היסטוריית השיחות + הבקשה האחרונה.

tools[]

object (Tool)

זה שינוי אופציונלי. רשימה של Tools שהמודל יכול להשתמש בהם כדי ליצור את התשובה הבאה.

Tool הוא קטע קוד שמאפשר למערכת לקיים אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או קבוצת פעולות, מחוץ לידע ולהיקף של המודל. הכלי היחיד שנתמך כרגע הוא Function.

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.

systemInstruction

object (Content)

זה שינוי אופציונלי. הוראת מערכת למפתחים. כרגע אפשר להשתמש רק בטקסט.

generationConfig

object (GenerationConfig)

זה שינוי אופציונלי. אפשרויות תצורה ליצירת מודל ולפלט שלו.

cachedContent

string

זה שינוי אופציונלי. שם התוכן שנשמר במטמון שמשמש כהקשר להצגת החיזוי. הערה: משמש רק בשמירה מפורשת במטמון, שבה המשתמשים יכולים לשלוט בשמירה במטמון (למשל איזה תוכן לשמור במטמון) וליהנות מחיסכון מובטח בעלויות. פורמט: cachedContents/{cachedContent}