全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
开放搜索

下拉提示

更新时间:2017-06-07 13:26:11

搜索

下拉提示是搜索服务的基础功能,在用户输入查询词的过程中,智能推荐候选query,减少用户输入,帮助用户尽快找到想要的内容。 OpenSearch下拉提示在实现了中文前缀,拼音全拼,拼音首字母简拼查询等通用功能的基础上,实现了基于用户文档内容的query智能识别。用户通过控制台的简单配置,就能拥有专属的定制下拉提示。此外,控制台上还提供了黑名单,推荐词条功能,让用户进一步控制下拉提示的结果,实现更灵活的定制。

URL

/suggest

支持格式

JSON

HTTP请求方式

GET

请求参数

参数 类型 必需 取值范围 默认值 描述
query string 需要做下拉提示推荐的query文本,不需要指定索引名。
index_name string 要查询的应用名,不支持多应用查询。
suggest_name string 需要使用的下拉提示规则名称,不支持多个规则同时查询。
hit int [1-10] 10 需要推荐的query数量
  • 下拉提示的query参数和search接口的query参数不同。下拉提示的query参数就是用户在输入框中输入的原始文本,不需要索引字段名,直接query=mp3(mp3为用户输入查询词)即可。

返回结果

参数 类型 描述
request_id string 该条查询的记录id,主要用于排查问题使用
searchtime float 引擎查询耗时,单位为秒
suggestions array 下拉提示结果。array的每个值代表一个结果
errors string 错误内容,error_message代表错误信息。error_code代表错误码

示例

请求:(此处省略了公共参数及编码等因素)

http://$host/suggest?index_name=test_app&suggest_name=test_suggest&hit=3&query=连衣

成功返回:

{
   "request_id":"143671133017790789028624",
   "searchtime":0.002419,
   "suggestions":[
    {
       "suggestion":"连衣裙"
     },
    { 
       "suggestion":"连衣裙春装"
     },
    {
       "suggestion":"连衣裙文艺"
     }
   ]
 }

错误返回:

{
   "request_id":"143670993917790789028600",
   "searchtime":0.048228,
   "suggestions":[],
   "errors":[
     {
        "code":2551,
        "message":"No such suggestion"
      }
    ]
 }
本文导读目录