GenerateContentResponse

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

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

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

object (Candidate)

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

object (PromptFeedback)

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

מועמד

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

ייצוג 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

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

טיפוסים בני מנייה (enums)
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

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

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

טיפוסים בני מנייה (enums)
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

מציין מה הייתה הסיבה לחסימת ההצעה לפעולה.

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