Method: models.streamGenerateContent

יוצר תגובה בשידור חי מהמודל עם קלט GenerateContentRequest.

בקשת HTTP

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

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

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

פרמטרים
model

string

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

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

גוף הבקשה

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

ייצוג JSON
{
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  }
}
שדות
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)

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

גוף התשובה

אם הפעולה בוצעה בהצלחה, גוף התגובה מכיל זרם של GenerateContentResponse מופעים.

היקפי הרשאות

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

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