文档中心

Viking AI 搜索

搜索接口

Overview - 搜索摘要接口

注意

受到 HTTP Body 大小限制，单次请求的包体大小最大不超过 10 MB。

items 最多处理前 20 个物品。传入更多物品时，请按相关性或业务优先级排序。

前置操作

确保应用已经完成并生效「搜索摘要」配置，且请求中使用的数据集已关联当前应用、物品数据已处理完成。

请求说明

接口概览

该接口根据用户问题和指定物品生成摘要、对比或选购建议。调用方负责传入参与摘要的物品，接口通过 SSE 流式返回生成结果。

参数	说明
请求方法	POST
请求路径	{REGION_URL}/api/v1/application/{APPLICATION_ID}/overview/{SCENE_ID}
Content-Type	application/json
鉴权	Authorization: Bearer <API_KEY>
返回方式	SSE 流式返回

服务域名

服务	区域	URL
火山引擎	华北（北京）	https://aisearch.cn-beijing.volces.com
火山引擎	东南亚（柔佛）	https://aisearch.ap-southeast-1.volces.com
BytePlus	东南亚（柔佛）	https://aisearch.ap-southeast-1.bytepluses.com

路径参数

参数	类型	必填	说明
APPLICATION_ID	String	是	应用唯一标识符。
SCENE_ID	String	是	搜索场景唯一标识符。

请求参数

参数	类型	必填	说明
session_id	String	是	本次摘要会话的唯一标识。建议为每个新会话生成新的 ID。
query	String	是	用户希望摘要回答的问题。
user	Object	否	用户信息，用于提供个性化上下文。
user._user_id	String	否	用户唯一标识。
user.nickname	String	否	用户昵称。
user.user_profile	String	否	与当前问题相关的用户偏好描述。
items	Array<Object>	是	参与摘要的物品列表。至少传入 1 个，最多处理前 20 个。
items[].dataset_id	String	是	物品所属的数据集 ID。数据集需要关联当前应用。
items[]._id	String	是	物品在数据集中的主键值。

请求示例

curl --request POST 'https://aisearch.cn-beijing.volces.com/api/v1/application/<application_id>/overview/{SCENE_ID}' \​
  --header 'Authorization: Bearer <API_KEY>' \​
  --header 'Content-Type: application/json' \​
  --data '{​
    "session_id": "overview_session_001",​
    "query": "对比这两款运动耳机的降噪、续航和佩戴舒适度",​
    "user": {​
      "_user_id": "user_123",​
      "nickname": "用户A",​
      "user_profile": "经常长途出行，重视续航和舒适度"​
    },​
    "items": [​
      {​
        "dataset_id": "<dataset_id>",​
        "_id": "item_001"​
      },​
      {​
        "dataset_id": "<dataset_id>",​
        "_id": "item_002"​
      }​
    ]​
  }'​

响应说明

接口返回 application/event-stream。客户端需要按接收顺序解析事件，并增量拼接 result.content。

响应参数

参数	类型	说明
request_id	String	请求唯一标识，用于问题排查。
result	Object	当前流式分片的响应结果。
result.content	String	当前返回的摘要文本分片。客户端按顺序追加。
result.payload	Object	摘要状态、关联物品和推荐追问等扩展信息。
result.payload.overview	Object	本次搜索摘要的状态信息。
result.payload.overview.enabled	Boolean	是否生成搜索摘要。
result.payload.overview.session_id	String	本次摘要会话标识。
result.payload.related_items	Array<Object>	摘要引用的关联物品信息。
result.payload.suggestions	Array<String>	基于当前摘要生成的推荐追问。
result.stop_reason	String	流式响应结束原因。值为 stop 时表示正常结束。

响应示例

{"request_id":"68631400-6f90-4ab2-9881-b87bfc4b8f12","result":{"payload":{"overview":{"enabled":true,"session_id":"overview_session_001"}}}}​
{"request_id":"68631400-6f90-4ab2-9881-b87bfc4b8f12","result":{"content":"两款耳机都支持主动降噪，"}}​
{"request_id":"68631400-6f90-4ab2-9881-b87bfc4b8f12","result":{"content":"其中 item_001 的续航更长。"}}​
{"request_id":"68631400-6f90-4ab2-9881-b87bfc4b8f12","result":{"payload":{"suggestions":["两款价格相差多少？","哪款更适合通勤？"]}}}​
{"request_id":"68631400-6f90-4ab2-9881-b87bfc4b8f12","result":{"stop_reason":"stop"}}​

不同字段可能出现在不同事件中。客户端收到 content 时增量展示文本；收到 stop_reason=stop 后结束读取。

未生成摘要

如果本次请求未触发搜索摘要，响应中的 result.payload.overview.enabled 为 false，且不会返回摘要正文。

{"request_id":"68631400-6f90-4ab2-9881-b87bfc4b8f12","result":{"payload":{"overview":{"enabled":false,"session_id":"overview_session_001"}},"stop_reason":"stop"}}​

常见问题

为什么部分物品没有出现在摘要中？

请检查物品是否超过 20 个、数据集是否已关联当前应用、物品主键是否存在，以及数据是否完成处理。服务只处理 items 中的前 20 个物品。

为什么返回内容不完整？

搜索摘要采用 SSE 流式返回。客户端需要持续读取响应，直到收到 stop_reason=stop。如果提前关闭连接，只能得到部分文本。

如何调整摘要内容和回答风格？

请在控制台的「搜索摘要」配置中调整输出语言、关注维度和生成提示词。生产环境建议统一通过控制台管理配置。

最近更新时间：2026.09.30 17:38:43

这个页面对您有帮助吗？

有用

无用