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)

レスポンス候補の安全性に関する評価のリスト。

1 つのカテゴリにつき最大 1 つの評価があります。
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

省略可。このソースに帰属するレスポンスのセグメントの開始。

[Index] は、セグメントの開始を示すバイト単位です。
endIndex

integer

省略可。貢献度が割り当てられたセグメントの終了点（排他的）。
uri

string

省略可。テキスト部分のソースとして帰属する URI。
license

string

省略可。セグメントのソースとして関連付けられている GitHub プロジェクトのライセンス。

コードの引用にはライセンス情報が必要です。

PromptFeedback

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

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

enum (BlockReason)

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

object (SafetyRating)

プロンプトの安全性に関する評価。1 つのカテゴリにつき最大 1 つの評価があります。

BlockReason

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

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

UsageMetadata

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

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

integer

プロンプト内のトークン数。
candidatesTokenCount

integer

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

integer

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