Method: projects.locations.dataStores.servingConfigs.answer

回答查询方法。

HTTP 请求

POST https://discoveryengine.googleapis.com/v1/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:answer

网址采用 gRPC 转码语法。

路径参数

参数
servingConfig

string

必需。servingConfigs.search 服务配置的资源名称，例如 projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config 或 projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config。此字段用于标识服务配置名称，即用于执行搜索的一组模型。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
字段
query

object (Query)

必需。当前用户查询。
session

string

会话资源名称。不需要。

如果未设置会话字段，则 API 处于无会话模式。

我们支持自动会话模式：用户可以使用通配符 - 作为会话 ID。系统会自动生成并分配新的 ID。
safetySpec

object (SafetySpec)

模型规范。
relatedQuestionsSpec

object (RelatedQuestionsSpec)

相关问题规范。
groundingSpec

object (GroundingSpec)

可选。接地规范。
answerGenerationSpec

object (AnswerGenerationSpec)

回答生成规范。
searchSpec

object (SearchSpec)

servingConfigs.search 规范。
queryUnderstandingSpec

object (QueryUnderstandingSpec)

查询理解规范。
asynchronousMode
(deprecated)

boolean

已弃用：此字段已弃用。将支持 Streaming Answer API。

异步模式控制。

如果已启用，则返回的响应将包含回答/会话资源名称，但不包含最终答案。API 用户需要通过调用 ConversationalSearchService.GetAnswer 或 ConversationalSearchService.GetSession 方法进行轮询，以获取回答/会话的最新状态。
userPseudoId

string

用于跟踪访问者的唯一标识符。例如，可以使用 HTTP Cookie 实现此目的，该 Cookie 应能够唯一标识单个设备上的访问者。如果访问者登录或退出网站，此唯一标识符不应发生变化。

此字段不应具有固定值，例如 unknown_visitor。

该字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。
userLabels

map (key: string, value: string)

应用于资源的用户标签必须符合以下要求：

  • 每项资源可以有多个标签，但不能超过 64 个。
  • 每个标签都必须采用键值对形式。
  • 键至少有 1 个字符，最多有 63 个字符，且不能为空。值可以为空，且最多包含 63 个字符。
  • 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符必须使用 UTF-8 编码，允许使用国际字符。
  • 标签的键部分必须是唯一的。不过，您可以将同一个键用于多个资源。
  • 键必须以小写字母或国际字符开头。

如需了解详情，请参阅 Google Cloud 文档。
endUserSpec

object (EndUserSpec)

可选。最终用户规范。

响应正文

如果成功，则响应正文包含一个 AnswerQueryResponse 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 servingConfig 资源的以下 IAM 权限：

  • discoveryengine.servingConfigs.answer

如需了解详情，请参阅 IAM 文档。