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

提示中的權杖數量。
candidatesTokenCount

integer

已產生的候選項目總數。
totalTokenCount

integer

產生要求 (提示 + 候選項目) 的權杖總數。