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

定義模型停止產生權杖的原因。

列舉
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

內容有害的機率。

分類系統有助於判斷內容是否不安全。但這並不代表內容是否受到傷害的嚴重程度。

列舉
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

說明提示遭到封鎖的原因。

列舉
BLOCK_REASON_UNSPECIFIED 預設值。這個值未使用。
SAFETY 基於安全考量，系統已封鎖提示。你可以查看「safetyRatings」，瞭解哪個安全性類別封鎖了這項功能。
OTHER 提示因不明原因而遭到封鎖。