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

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

טיפוסים בני מנייה (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 הבקשה נחסמה מסיבות לא ידועות.

UsageMetadata

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

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

integer

מספר האסימונים בהנחיה.
candidatesTokenCount

integer

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

integer

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