Method: projects.locations.groundingConfigs.check

执行接地检查。

HTTP 请求

POST https://discoveryengine.googleapis.com/v1alpha/{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 个 token。
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

从其中检索相应事实块的来源。如果该事实块是从请求中提供的 GroundingFact 检索到的，则此字段将包含检索到此块的特定事实的索引。
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 时，才会设置此字段。