Method: projects.locations.groundingConfigs.check

執行接地檢查。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
groundingConfig

string

這是必要旗標，基礎設定的資源名稱，例如 projects/*/locations/global/groundingConfigs/default_grounding_config。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
欄位
answerCandidate

string

請候選人回答問題，確認是否符合資格。長度上限為 4096 個權杖。
facts[]

object (GroundingFact)

用於基礎事實檢查的事實清單。最多可支援 200 個事實。
groundingSpec

object (CheckGroundingSpec)

基礎檢查的設定。
userLabels

map (key: string, value: string)

套用於資源的使用者標籤必須符合下列規定：

  • 每項資源可以有多個標籤，上限為 64 個。
  • 每個標籤都必須是鍵/值組合。
  • 鍵的長度必須至少為 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

事實區塊。

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 時，才會設定這項屬性。