QueryCompletion - 搜索补全--全域AI搜索-火山引擎

文档中心

立即注册

导航

QueryCompletion - 搜索补全

最近更新时间：2025.08.25 23:32:15首次发布时间：2025.04.24 20:27:19

对搜索词进行联想，根据输入的部分搜索词，返回对搜索词进行联想后的查询词。

请求说明

请求方式：POST
请求地址：https://aisearch.cn-beijing.volces.com/api/v1/application/{application_id}/query_completion

{application_id}：在控制台创建应用后系统指定的应用唯一标识，可在控制台查看

鉴权方式

可使用API Key或Access Key鉴权，详情参考API 鉴权机制说明

请求参数

请求体

参数	类型	是否必选	示例值	描述
query	String	是	"在海边"	待联想的查询词，输入查询词的长度需要大于等于在应用中配置的最小联想字符数。

响应参数

请求响应

参数	类型	示例值	描述
request_id	String	25ee998a-5462-9385-9f18-035f1da7a6e5	用于唯一标识一次请求，可根据request_id快速定位一次请求的执行。
result	Result	见下方：Result	搜索联想结果

数据结构

Result

参数	类型	示例值	描述
suggestions	Array of Suggestion	见下方：Suggestion	搜索联想结果列表，默认返回10条，如需调整可在应用配置中搜索联想的最大查询召回量。

Suggestion

参数	类型	示例值	描述
suggestion	String	"在海边露营"	单条搜索联想词

请求示例

curl -X POST 'https://aisearch.cn-beijing.volces.com/api/v1/application/60590835675/query_completion' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <API Key>' \
  -d '{
  "query": "在海边"
}'

响应示例

{
  "request_id": "25ee998a-5462-9385-9f18-035f1da7a6e5",
  "result": {
    "suggestions": [
      {
        "suggestion": "在海边散步"
      },
      {
        "suggestion": "在海边露营"
      },
      {
        "suggestion": "在海边度假"
      },
      {
        "suggestion": "在海边冲浪"
      },
      {
        "suggestion": "在海边看日出"
      }
    ]
  }
}

错误处理

错误码

本接口错误码请参见公共错误码文档。