Method: projects.locations.dataStores.completeQuery

使用“建议的关键字”功能补全指定用户输入。

HTTP 请求

GET https://discoveryengine.googleapis.com/v1beta/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery

网址采用 gRPC 转码语法。

路径参数

参数
dataStore

string

必需。为其执行补全操作的父级数据存储区的资源名称，例如 projects/*/locations/global/collections/default_collection/dataStores/default_data_store。

查询参数

参数
query

string

必需。用于提取建议的预输入内容。长度上限为 128 个字符。
queryModel

string

指定自动补全数据模型。此设置会替换 Cloud 控制台的“配置”>“自动补全”部分中指定的任何模型。目前支持的值：

  • document - 使用根据用户导入的文档生成的建议。
  • search-history - 使用根据 SearchService.Search API 调用的过往历史记录生成的建议。如果 Search API 没有流量，请勿使用此设置。
  • user-event - 使用根据用户导入的搜索事件生成的建议。
  • document-completable - 使用直接从用户导入的标记为“可补全”的文档字段中提取的建议。

默认值：

  • document 是常规数据存储区的默认模型。
  • search-history 是网站搜索数据存储区的默认模型。
userPseudoId

string

用于跟踪访问者的唯一标识符。例如，可以通过 HTTP Cookie 实现，该 Cookie 应能唯一标识单个设备上的访问者。即使访问者登录或登出网站，此唯一标识符也不应更改。

此字段不应具有 unknown_visitor 等固定值。

此标识符应与 UserEvent.user_pseudo_id 和 SearchRequest.user_pseudo_id 相同。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 128 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。
includeTailSuggestions

boolean

指示在没有建议与完整查询匹配时，是否应返回尾部建议。即使设置为 true，如果存在与完整查询匹配的建议，则只会返回这些建议，而不会返回尾部建议。

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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

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

IAM 权限

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

  • discoveryengine.dataStores.completeQuery

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