Method: projects.locations.collections.engines.completionConfig.completeQuery

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

HTTP 请求

POST https://discoveryengine.googleapis.com/v1beta/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery

网址采用 gRPC 转码语法。

路径参数

参数
completionConfig

string

必需。执行补全操作的父级数据存储区或引擎资源名称所对应的 completionConfig，例如 projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig。

请求正文

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

JSON 表示法 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
字段
query

string

必需。用于获取建议的预输入内容。最大长度为 128 个字符。

对于大多数建议类型，查询不能为空。如果为空，则会返回 INVALID_ARGUMENT 错误。例外情况是，当 suggestionTypes 仅包含 RECENT_SEARCH 类型时，查询可以为空字符串。这被称为“零前缀”特性，它会在查询为空时返回用户最近搜索过的查询。
queryModel

string

指定自动补全查询模型，仅适用于 QUERY SuggestionType。此设置会替换 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 个字符
userInfo

object (UserInfo)

可选。与最终用户相关的信息。

此标识符信息应与 UserEvent.user_info 和 SearchRequest.user_info 相同。
includeTailSuggestions

boolean

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

object (BoostSpec)

可选。用于提升条件所匹配建议的规范。
suggestionTypes[]

enum (SuggestionType)

可选。要返回的建议类型。如果为空或未指定，则返回查询建议。目前仅支持一种建议类型。
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

可选。每种建议类型的规范。
experimentIds[]

string

可选。相应请求的实验 ID。

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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

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

IAM 权限

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

  • discoveryengine.completionConfigs.completeQuery

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