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

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

列舉
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 提示因不明原因而遭到封鎖。

UsageMetadata

產生要求權杖用量的中繼資料。

JSON 表示法 
{
  "promptTokenCount": integer,
  "candidatesTokenCount": integer,
  "totalTokenCount": integer
}
欄位
promptTokenCount

integer

提示中的權杖數量。設定 CacheContent 後，這仍是有效提示總大小。亦即快取內容中的權杖數量。
candidatesTokenCount

integer

所有已產生的候選項目權杖總數。
totalTokenCount

integer

產生要求的符記總數 (提示 + 候選)。