Method: projects.locations.groundingConfigs.check

アース チェックを行います。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1/{groundingConfig=projects/*/locations/*/groundingConfigs/*}:check

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
groundingConfig

string

必須。グラウンディング構成のリソース名（例: projects/*/locations/global/groundingConfigs/default_grounding_config）。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
フィールド
answerCandidate

string

チェックする回答候補。最大長は 4,096 トークンです。
facts[]

object (GroundingFact)

グラウンディング チェックの事実のリスト。最大 200 個の事実をサポートしています。
groundingSpec

object (CheckGroundingSpec)

グラウンディング チェックの構成。
userLabels

map (key: string, value: string)

リソースに適用するユーザーラベルは、次の要件を満たす必要があります。

  • 1 つのリソースには、最大 64 個のラベルを適用できます。
  • ラベルは、Key-Value ペアでなければなりません。
  • キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。
  • キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。
  • ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。
  • キーは、小文字または国際文字で始める必要があります。

詳細については、Google Cloud ドキュメントをご覧ください。

レスポンスの本文

GroundedGenerationService.CheckGrounding メソッドに対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "citedChunks": [
    {
      object (FactChunk)
    }
  ],
  "citedFacts": [
    {
      object (CheckGroundingFactChunk)
    }
  ],
  "claims": [
    {
      object (Claim)
    }
  ],
  "supportScore": number
}
フィールド
citedChunks[]

object (FactChunk)

回答候補内のすべての主張で引用されている事実のリスト。これらは、リクエストで提供された事実から導き出されます。
citedFacts[]

object (CheckGroundingFactChunk)

回答候補内のすべての主張で引用されている事実のリスト。これらは、リクエストで提供された事実から導き出されます。
claims[]

object (Claim)

回答候補内のすべての申し立てにわたる申し立てテキストと引用情報。
supportScore

number

入力された回答候補のサポートスコア。スコアが高いほど、提示された事実によって裏付けられる主張の割合が高くなります。レスポンスが返されると、常に設定されます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

groundingConfig リソースに対する次の IAM 権限が必要です。

  • discoveryengine.groundingConfigs.check

詳細については、IAM のドキュメントをご覧ください。

GroundingFact

根拠となる事実。

JSON 表現 
{
  "factText": string,
  "attributes": {
    string: string,
    ...
  }
}
フィールド
factText

string

ファクトのテキスト コンテンツ。最大 1 万文字まで入力できます。
attributes

map (key: string, value: string)

ファクトに関連付けられている属性。一般的な属性には、source（事実の出典を示す）、author（事実の著者を示す）などがあります。

CheckGroundingSpec

グラウンディング チェックの仕様。

JSON 表現 
{
  "citationThreshold": number,
  "enableClaimLevelScore": boolean
}
フィールド
citationThreshold

number

回答候補の主張に対して事実の引用が必要かどうかを判断するために使用されるしきい値（[0,1]）。しきい値を高くすると、引用数は減りますが、引用の信頼性は高くなります。しきい値を低くすると、引用数は増えますが、引用の信頼性は低くなります。設定しない場合、しきい値はデフォルトで 0.6 になります。
enableClaimLevelScore

boolean

レスポンスで主張レベルのグラウンディング スコアを有効にする制御フラグ。

FactChunk

Fact Chunk。

JSON 表現 
{
  "chunkText": string,
  "source": string,
  "index": integer,
  "sourceMetadata": {
    string: string,
    ...
  },
  "uri": string,
  "title": string,
  "domain": string
}
フィールド
chunkText

string

ファクト チャンクのテキスト コンテンツ。最大 1 万文字まで入力できます。
source

string

このファクト チャンクが取得されたソース。リクエストで提供された GroundingFacts から取得された場合、このフィールドには、このチャンクが取得された特定の事実のインデックスが含まれます。
index

integer

このチャンクのインデックス。現在は、ストリーミング モードでのみ使用されます。
sourceMetadata

map (key: string, value: string)

ソース参照の詳細情報。
uri

string

ソースの URI。
title

string

ソースのタイトル。
domain

string

ソースのドメイン。

CheckGroundingFactChunk

グラウンディング チェック用の事実チャンク。

JSON 表現 
{
  "chunkText": string
}
フィールド
chunkText

string

ファクト チャンクのテキスト コンテンツ。最大 1 万文字まで入力できます。

クレーム

回答候補内の主張のテキストと引用情報。

JSON 表現 
{
  "claimText": string,
  "citationIndices": [
    integer
  ],
  "startPos": integer,
  "endPos": integer,
  "groundingCheckRequired": boolean,
  "score": number
}
フィールド
claimText

string

回答候補のクレームのテキスト。引用または反引用が見つかったかどうかにかかわらず、常に提供されます。
citationIndices[]

integer

申し立てに関連付けられている引用を指定するインデックス（citedChunks 内）のリスト。たとえば、[1,3,4] は、citedChunks[1]、citedChunks[3]、citedChunks[4] が主張を裏付けるために引用された事実であることを意味します。事実への引用は、その主張が事実によって裏付けられていることを示します。
startPos

integer

回答候補内の主張の開始位置を示す位置（バイト単位）。これは文字数で測定されるものではないため、一部の文字が複数バイトを占める可能性があることを考慮して、ユーザー インターフェースでレンダリングする必要があります。たとえば、クレーム テキストに ASCII 以外の文字が含まれている場合、文字数（プログラミング言語に依存）で測定した場合とバイト数（プログラミング言語に依存しない）で測定した場合で、開始位置と終了位置が異なります。
endPos

integer

回答候補内の主張の終了位置を示す位置（バイト単位、終了位置は含まない）。これは文字数で測定されるものではないため、そのようにレンダリングする必要があります。たとえば、クレーム テキストに ASCII 以外の文字が含まれている場合、文字数（プログラミング言語に依存）で測定した場合とバイト数（プログラミング言語に依存しない）で測定した場合で、開始位置と終了位置が異なります。
groundingCheckRequired

boolean

この主張でグラウンディング チェックが必要だったことを示します。システムがこの主張には帰属/グラウンディング チェックが必要ないと判断した場合、このフィールドは false に設定されます。この場合、主張に対してグラウンディング チェックが行われていないため、citationIndices は返されません。
score

number

回答候補の主張の信頼スコア。範囲は [0, 1] です。これは、CheckGroundingRequest.grounding_spec.enable_claim_level_score が true の場合にのみ設定されます。