文档首页> 企业搜索服务 KooSearch> API参考> API> 数据集搜索> 自动补全提示
更新时间：2023-07-18 GMT+08:00
查看PDF
分享

自动补全提示

功能介绍

自动补全提示。仅适用于站内搜索场景。

URI

POST /v1/{project_id}/search/suggest

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID和名称。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

application_id

是

String

应用ID。

Content-Type

是

String

请求体参数类型，该字段必须设置为：application/json。
表3 请求Body参数

参数

是否必选

参数类型

描述

query

是

String

根据当前输入的字符，提供补全和提示功能。

最小长度：1

最大长度：255

size

是

Integer

返回的补全词和提示词数量。

最小值：1

最大值：255

缺省值：10

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

totalHits

Integer

结果总数。

hits

Array of suggestHit objects

匹配结果集。
表5 suggestHit

参数

参数类型

描述

suggestion

String

补全提示字段。

count

Integer

搜索次数。

请求示例

站内搜索场景下自动补全提示请求示例。

https://koosearch.myhuaweicloud.com/v1/{project_id}/search/suggest

{
  "query" : "ja",
  "size" : 100
}

响应示例

状态码： 200

返回信息。

{
  "status" : "200",
  "message" : "success",
  "data" : {
    "totalHits" : 2,
    "hits" : [ {
      "suggestion" : "10",
      "count" : 1
    }, {
      "suggestion" : "1",
      "count" : 1
    } ]
  }
}

状态码： 400

详见错误码分类。

{
  "status" : "3014",
  "message" : "请求参数校验不通过",
  "data" : null
}

状态码： 500

服务器请求失败。

{
  "status" : "1000",
  "message" : "服务异常",
  "data" : null
}

状态码

状态码

描述

200

返回信息。

400

详见错误码分类。

500

服务器请求失败。

错误码

请参见错误码。

父主题： 数据集搜索
分享：

    相关文档

    相关产品