Method: models.generateMessage

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

בקשת HTTP

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

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

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

פרמטרים
model

string

חובה. שם המודל שבו יש להשתמש.

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

גוף הבקשה

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

ייצוג JSON 
{
  "prompt": {
    object (MessagePrompt)
  },
  "temperature": number,
  "candidateCount": integer,
  "topP": number,
  "topK": integer
}
שדות
prompt

object (MessagePrompt)

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

בהינתן הנחיה, המודל יחזיר את מה שהוא חוזים מהי ההודעה הבאה בדיון.
temperature

number

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

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

integer

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

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

number

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

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

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

integer

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

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

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

גוף התשובה

התשובה מהמודל.

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

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

ייצוג JSON 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}
שדות
candidates[]

object (Message)

הודעות תגובה של מועמדים מהמודל.
messages[]

object (Message)

היסטוריית השיחות שהמודל משתמש בה.
filters[]

object (ContentFilter)

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

המדד הזה מציין אילו SafetyCategory(ים) חסמו בקשה לתגובה הזו, את הערך הנמוך ביותר של HarmProbability שהפעיל חסימה ואת הגדרת Harm שנשלחה לקטגוריה הזו.

היקפי הרשאות

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

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