下拉提示

更新时间:2020-07-08 10:29:17

查询下拉提示列表

描述

查询下拉提示列表

方法

GET

URL

/v3/openapi/apps/{app_name}/actions/suggest?query={query}&hit={hit}&re_search={re_search}&user_id={user_id}&model_name={model_name}

  • 以上 URL 省略了请求Header参数及编码等因素
  • 以上 URL 中省略了访问应用的 host 地址

请求参数

名称 是否必须 类型 默认值 说明 备注
query string 搜索关键词(包含中文需进行urlencode编码)
hit int 10 查询的数据条数
re_search string 当前支持:“homonym”,开启同音别字补全召回
user_id string 用户id,查询个性化结果时需要
model_name string 指定输出结果的模型名称

返回参数

名称 类型 说明
data object 操作结果


参数说明:

参数 是否必须 默认 类型 说明
list array 查询所得的下拉提示列表

示例

请求示例

  1. http://$host/v3/openapi/apps/{app_name}/actions/suggest?query={query}&hit={hit}&re_search={re_search}&user_id={user_id}&model_name={model_name}

返回示例

正确返回

  1. {
  2. "request_id": "150116615820104116121674",
  3. "searchtime": 0.002654,
  4. "suggestions": [
  5. {
  6. "suggestion": "连衣裙"
  7. },
  8. {
  9. "suggestion": "连衣裙春装"
  10. },
  11. {
  12. "suggestion": "连衣裙文艺"
  13. }
  14. ]
  15. }

错误返回
参考:错误码说明