GenerateContentResponse

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

הערה לגבי סיווגי בטיחות וסינון תוכן. הם מדווחים גם להנחיות בGenerateContentResponse.prompt_feedback וגם לכל מועמד בfinishReason ובsafetyRatings. חוזה ה-API הוא: - או שכל המועמדים המבוקשים מוחזרים או שלא מוחזרים אף מועמדים - לא מוחזרים מועמדים רק אם הייתה בעיה בהנחיה (ראו promptFeedback) - משוב על כל מועמד מדווח ב-finishReason וב-safetyRatings.

ייצוג JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "promptFeedback": {
    object (PromptFeedback)
  },
  "usageMetadata": {
    object (UsageMetadata)
  }
}
שדות
candidates[]

object (Candidate)

התשובות של המועמדים מהמודל.
promptFeedback

object (PromptFeedback)

מחזירה את המשוב של ההנחיה שקשורה למסנני התוכן.
usageMetadata

object (UsageMetadata)

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

מועמד

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

ייצוג JSON 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "index": integer
}
שדות
content

object (Content)

פלט בלבד. תוכן שנוצר שהוחזר מהמודל.
finishReason

enum (FinishReason)

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

אם הם ריקים, המודל לא הפסיק ליצור את האסימונים.
safetyRatings[]

object (SafetyRating)

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

לכל קטגוריה יש דירוג אחד לכל היותר.
citationMetadata

object (CitationMetadata)

פלט בלבד. ציטוטים ביבליוגרפיים של המועמדים שנוצרו על ידי המודל.

אפשר לאכלס את השדה הזה בפרטי הקראה עבור כל טקסט שנכלל ב-content. אלה פסקאות ש'מצוטטות' מתוך תוכן שמוגן בזכויות יוצרים בנתוני האימון הבסיסיים של ה-LLM.
tokenCount

integer

פלט בלבד. מספר האסימונים למועמד הזה.
index

integer

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

FinishReason

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

טיפוסים בני מנייה (enum)
FINISH_REASON_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
STOP נקודת העצירה הטבעית של המודל או רצף העצירה שצוין.
MAX_TOKENS הגעת למספר האסימונים המקסימלי שצוין בבקשה.
SAFETY התוכן של המועמד סומן מטעמי בטיחות.
RECITATION התוכן של המועמד סומן מסיבות של הקראה.
OTHER סיבה לא ידועה.

SafetyRating

דירוג הבטיחות של קטע התוכן.

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

ייצוג JSON 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "blocked": boolean
}
שדות
category

enum (HarmCategory)

חובה. הקטגוריה של הדירוג הזה.
probability

enum (HarmProbability)

חובה. הסבירות לפגיעה בתוכן הזה.
blocked

boolean

האם התוכן הזה נחסם בגלל הסיווג הזה?

HarmProbability

הסבירות שקטע תוכן מסוים מזיק.

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

טיפוסים בני מנייה (enum)
HARM_PROBABILITY_UNSPECIFIED לא צוינה הסתברות.
NEGLIGIBLE יש סיכוי זניח שהתוכן יהיה לא בטוח.
LOW יש סיכוי נמוך שהתוכן יהיה לא בטוח.
MEDIUM יש סיכוי בינוני שהתוכן יהיה לא בטוח.
HIGH יש סיכוי גבוה שהתוכן יהיה לא בטוח.

CitationMetadata

אוסף של פרטי ייחוס של מקורות לחלק מהתוכן.

ייצוג JSON 
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}
שדות
citationSources[]

object (CitationSource)

ציטוטים למקורות עם תשובה ספציפית.

CitationSource

ציטוט אל מקור עבור חלק מתשובה ספציפית.

ייצוג JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}
שדות
startIndex

integer

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

האינדקס מציין את תחילת הקטע, הנמדד בבייטים.
endIndex

integer

זה שינוי אופציונלי. סוף הפלח המשויך, לא כולל.
uri

string

זה שינוי אופציונלי. URI שמשויך כמקור של חלק מהטקסט.
license

string

זה שינוי אופציונלי. רישיון לפרויקט ב-GitHub שמשויך כמקור לפילוח.

כדי לשלוח ציטוטים של קוד, נדרשים פרטי רישיון.

PromptFeedback

קבוצת מטא-נתונים של המשוב שההנחיה שצוינה ב-GenerateContentRequest.content.

ייצוג JSON 
{
  "blockReason": enum (BlockReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ]
}
שדות
blockReason

enum (BlockReason)

זה שינוי אופציונלי. אם היא מוגדרת, ההנחיה נחסמה ולא מוחזרים מועמדים. נסחו מחדש את ההנחיה.
safetyRatings[]

object (SafetyRating)

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

BlockReason

מציינת מה הייתה הסיבה לחסימת ההנחיה.

טיפוסים בני מנייה (enum)
BLOCK_REASON_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
SAFETY ההנחיה נחסמה מטעמי בטיחות. אפשר לבדוק את safetyRatings כדי להבין איזו קטגוריית בטיחות חסמה אותה.
OTHER ההנחיה נחסמה בגלל סיבות לא ידועות.

UsageMetadata

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

ייצוג JSON 
{
  "promptTokenCount": integer,
  "candidatesTokenCount": integer,
  "totalTokenCount": integer
}
שדות
promptTokenCount

integer

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

integer

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

integer

מספר האסימונים הכולל לבקשת היצירה (הנחיה + מועמדים).