GenerateContentResponse

複数の候補をサポートするモデルからのレスポンス。

安全評価とコンテンツ フィルタリングに関する注意事項。これらは、GenerateContentResponse.prompt_feedback の両方のプロンプトに対して、finishReason および safetyRatings の各候補に対して報告されます。API コントラクトでは、- リクエストされたすべての候補者が返されるか、まったく候補が返されません。- プロンプトに問題があった場合にのみ候補が返されません(promptFeedback を参照)。- 各候補に関するフィードバックは、finishReasonsafetyRatings に報告されます。

JSON 表現
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "promptFeedback": {
    object (PromptFeedback)
  },
  "usageMetadata": {
    object (UsageMetadata)
  }
}
フィールド
candidates[]

object (Candidate)

モデルからの候補レスポンス。

promptFeedback

object (PromptFeedback)

コンテンツ フィルタに関するプロンプトのフィードバックを返します。

usageMetadata

object (UsageMetadata)

出力専用。生成リクエストのトークン使用状況に関するメタデータ。

PromptFeedback

GenerateContentRequest.content で指定されたプロンプトに対するフィードバック メタデータのセット。

JSON 表現
{
  "blockReason": enum (BlockReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ]
}
フィールド
blockReason

enum (BlockReason)

省略可。設定すると、プロンプトがブロックされ、候補は返されません。プロンプトを言い換えてください。

safetyRatings[]

object (SafetyRating)

プロンプトの安全性に関する評価。カテゴリごとに最大 1 つの評価を指定できます。

BlockReason

プロンプトがブロックされた理由を指定します。

列挙型
BLOCK_REASON_UNSPECIFIED デフォルト値。この値は使用されません。
SAFETY 安全上の理由により、プロンプトがブロックされました。safetyRatings を調べると、どの安全性カテゴリでブロックされたかがわかります。
OTHER 不明な理由によりプロンプトがブロックされました。

UsageMetadata

生成リクエストのトークン使用状況に関するメタデータ。

JSON 表現
{
  "promptTokenCount": integer,
  "cachedContentTokenCount": integer,
  "candidatesTokenCount": integer,
  "totalTokenCount": integer
}
フィールド
promptTokenCount

integer

プロンプト内のトークンの数。cacheContent が設定されている場合でも、これは有効なプロンプトの合計サイズです。つまり、キャッシュに保存されたコンテンツ内のトークンの数も含まれます。

cachedContentTokenCount

integer

プロンプトのキャッシュに保存された部分(キャッシュに保存されたコンテンツ)内のトークンの数。

candidatesTokenCount

integer

生成された候補全体のトークンの合計数。

totalTokenCount

integer

生成リクエストの合計トークン数(プロンプト + 候補)。