Candidate

モデルから生成されたレスポンス候補。

JSON 表現
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "groundingAttributions": [
    {
      object (GroundingAttribution)
    }
  ],
  "index": integer
}
フィールド
content

object (Content)

出力のみ。モデルから返された生成コンテンツ

finishReason

enum (FinishReason)

(省略可)出力のみ。モデルがトークンの生成を停止した理由。

空の場合、モデルによるトークンの生成は停止していません。

safetyRatings[]

object (SafetyRating)

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

カテゴリごとに最大 1 つの評価があります。

citationMetadata

object (CitationMetadata)

出力のみ。モデルで生成された候補の引用情報。

このフィールドには、content に含まれるテキストの列挙情報を指定できます。LLM の基礎的なトレーニング データに含まれる著作物から「列挙」された文章のことです。

tokenCount

integer

出力のみ。この受験者のトークン数。

groundingAttributions[]

object (GroundingAttribution)

出力のみ。根拠づけられた回答に寄与したソースの帰属情報。

このフィールドは、GenerateAnswer 呼び出しで入力されます。

index

integer

出力のみ。候補者リスト内の候補者のインデックス。

FinishReason

モデルがトークンの生成を停止した理由を定義します。

列挙型
FINISH_REASON_UNSPECIFIED デフォルト値。この値は使用されません。
STOP モデルの自然な停車場所、または指定された停車シーケンス。
MAX_TOKENS リクエストで指定されたトークンの最大数に達しました。
SAFETY 安全性を確保するために受験者のコンテンツが報告されました。
RECITATION 列挙理由から候補者のコンテンツがフラグが付けられました。
OTHER 不明な理由。

GroundingAttribution

回答に寄与した情報源の帰属。

JSON 表現
{
  "sourceId": {
    object (AttributionSourceId)
  },
  "content": {
    object (Content)
  }
}
フィールド
sourceId

object (AttributionSourceId)

出力のみ。このアトリビューションに貢献しているソースの識別子。

content

object (Content)

この帰属を構成するソース コンテンツの根拠を示す。

AttributionSourceId

このアトリビューションに貢献しているソースの識別子。

JSON 表現
{

  // Union field source can be only one of the following:
  "groundingPassage": {
    object (GroundingPassageId)
  },
  "semanticRetrieverChunk": {
    object (SemanticRetrieverChunk)
  }
  // End of list of possible types for union field source.
}
フィールド

共用体フィールド source

source は次のいずれかになります。

groundingPassage

object (GroundingPassageId)

インライン文の識別子。

semanticRetrieverChunk

object (SemanticRetrieverChunk)

セマンティック レトリーバーによって取得された Chunk の識別子。

GroundingPassageId

GroundingPassage 内のパーツの識別子。

JSON 表現
{
  "passageId": string,
  "partIndex": integer
}
フィールド
passageId

string

出力のみ。GenerateAnswerRequestGroundingPassage.id と一致するパッセージの ID。

partIndex

integer

出力のみ。GenerateAnswerRequestGroundingPassage.content 内にあるパートのインデックス。

SemanticRetrieverChunk

SemanticRetrieverConfig を使用して GenerateAnswerRequest で指定されたセマンティック レトリーバーによって取得された Chunk の識別子。

JSON 表現
{
  "source": string,
  "chunk": string
}
フィールド
source

string

出力のみ。リクエストの SemanticRetrieverConfig.source に一致するソースの名前。例: corpora/123corpora/123/documents/abc

chunk

string

出力のみ。属性テキストを含む Chunk の名前。例: corpora/123/documents/abc/chunks/xyz