Method: models.generateText

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

בקשת HTTP

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

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

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

פרמטרים
model

string

חובה. השם של Model או TunedModel שישמש ליצירת ההשלמה. דוגמאות: models/text-bison-001 receivedModels/sentence-translate-u3b7m

גוף הבקשה

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

ייצוג JSON 
{
  "prompt": {
    object (TextPrompt)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "stopSequences": [
    string
  ],
  "temperature": number,
  "candidateCount": integer,
  "maxOutputTokens": integer,
  "topP": number,
  "topK": integer
}
שדות
prompt

object (TextPrompt)

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

בהינתן הנחיה, המודל יפיק תגובת TextCompletion שהוא חוזה כהשלמה של טקסט הקלט.
safetySettings[]

object (SafetySetting)

אפשרות. רשימה של מופעים ייחודיים של SafetySetting לחסימת תוכן לא בטוח.

שייאכפו ב-GenerateTextRequest.prompt וב-GenerateTextResponse.candidates. לכל סוג של SafetyCategory לא יכולה להיות יותר מהגדרה אחת. ה-API יחסום הנחיות ותגובות שלא עומדות בערכי הסף שהוגדרו בהגדרות האלה. הרשימה הזאת מבטלת את הגדרות ברירת המחדל לכל SafetyCategory שצוין בהגדרות הבטיחות. אם לא צוין SafetySetting ל-SafetyCategory נתון ברשימה, ה-API ישתמש בהגדרת ברירת המחדל לשמירה על הבטיחות של הקטגוריה הזו. קטגוריות פגיעה HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDical, HARM_CATEGORY_DANGEROUS נתמכות בשירותי טקסט.
stopSequences[]

string

קבוצה של רצפי תווים (עד 5) שיפסיקו את יצירת הפלט. אם צוין, ה-API יפסיק בהופעה הראשונה של רצף עצירה. רצף העצירה לא ייכלל בתשובה.
temperature

number

אפשרות. ההגדרה קובעת את מידת הרנדומיזציה של הפלט. הערה: ערך ברירת המחדל משתנה בהתאם למודל. למידע נוסף, ניתן לעיין במאפיין Model.temperature של הפונקציה Model שהחזירה את הפונקציה getModel.

הערכים יכולים לנוע בין [0.0,1.0] כולל. ערך קרוב ל-1.0 יגרום ליצירת תשובות מגוונות יותר ויצירתיות יותר, בעוד שהערך שקרוב ל-0.0 יוביל בדרך כלל לתגובות ברורות יותר מהמודל.
candidateCount

integer

אפשרות. מספר התשובות שנוצרו שיש להחזיר.

הערך צריך להיות בין [1, 8] כולל. אם המדיניות לא מוגדרת, הערך שמוגדר כברירת מחדל הוא 1.
maxOutputTokens

integer

אפשרות. מספר האסימונים המרבי שיש לכלול במועמד.

אם המדיניות לא מוגדרת, הערך הזה יוגדר כברירת מחדל כ-outputTokenLimit שצוינה במפרט של Model.
topP

number

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

במודל נעשה שימוש משולב בדגימה מסוג 'טופ-קי' ו'גרעין'.

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

הערה: ערך ברירת המחדל משתנה בהתאם למודל. למידע נוסף, ניתן לעיין במאפיין Model.top_p של הפונקציה Model שהחזירה את הפונקציה getModel.
topK

integer

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

במודל נעשה שימוש משולב בדגימה מסוג 'טופ-קי' ו'גרעין'.

בדגימה מסוג 'Top K' נבדקת קבוצת topK האסימונים בעלי הסבירות הגבוהה ביותר. ברירת המחדל היא 40.

הערה: ערך ברירת המחדל משתנה בהתאם למודל. למידע נוסף, ניתן לעיין במאפיין Model.top_k של הפונקציה Model שהחזירה את הפונקציה getModel.

גוף התשובה

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

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של 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

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