本节将说明如何基于已创建好的一个知识服务进行检索或者问答。
/api/knowledge/service/responses 接口支持基于一个已创建的 DeepSearch 知识服务进行问答。
使用
service/responses接口有哪些优势?
- 在控制台前端调试在线参数并发布服务后,即可通过当前接口调用,获得与控制台前端完全一致的效果。
- 无需生成复杂的 AKSK 签名,通过 API Key 即可调用。
在您的知识库控制台界面发布知识服务,并关联相应的 API Key(用于权限校验)。
| 项目 | 值 | 说明 |
|---|---|---|
| URI | /api/knowledge/service/responses | |
| 请求方法 | POST | |
| 请求头 | Content-Type: application/json | 请求消息类型 |
| 请求头 | Authorization: Bearer {apikey} | 该知识服务关联的 API Key,用于鉴权 |
| 请求头 | Host: knowledge_base_domain | 知识库域名 |
| 参数 | 类型 | 是否必选 | 默认值 | 参数说明 |
|---|---|---|---|---|
service_resource_id | string | 是 | -- | 知识服务唯一 ID。可通过知识服务创建结果或知识服务列表接口获取。 |
input | json | 是 | -- | 问答对话消息。详见下方示例。 |
previous_response_id | string | 否 | nil | 上一轮对话的 Response ID。用于多轮对话场景传入上次请求返回的 response ID,无需传入历史对话。 |
stream | bool | 否 | true | 是否采用流式返回。问答服务中控制模型回答是否以 SSE 返回;检索服务中不会生成回答,但 true 仍会以 SSE 返回检索结果和结束标识,false 则一次性返回检索结果。 |
[ {"role": "user", "content": "当前轮次用户问题"} ]
[ { "role": "user", "content": [ { "type": "input_text", "text": "推荐一个类似的适合 3 岁小孩的玩具" }, { "type": "input_image", "image_url": "https://ark-project.tos-cn-beijing.volces.XXX.jpeg" } ] } ]
目前本接口仅支持 DeepSearch 类型的知识服务。
响应消息格式对齐方舟 Responses API 协议,请参考文档创建 Response和Response 生命周期。
curl -i -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer your_api_key' \ http://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/service/responses \ -d '{ "service_resource_id": "<YOUR_SERVICE_RESOURCE_ID>", "stream": false, "input": [ { "role": "user", "content": "注册抖音的方式有哪些" } ] }'
执行成功返回:
{ "created_at": 1792691898, "error": null, "id": "cresp-16316e72-2e2b-4dd0-aa40-e5965207af4a", "incomplete_details": null, "max_output_tokens": null, "model": "deepsearch-kb-1c55a1af863b834d", "object": "response", "output": [ { "id": "cmsg-0c566ed8-c4fd-4052-8ec9-0922d0164306", "content": [ { "text": "### 主流注册方式(抖音 APP)\n\n1. **手机号注册**\n\n> \n> 提示:按法规要求,账号发作品、直播、私信等功能,后续需要**实名认证**;虚拟号、部分网络号容易注册失败。\n - 短信验证码注册:输入手机号,收短信验证码注册aweme.snss...\n - 运营商一键登录注册:本机号码一键核验,不用输验证码lf3-cdn-to...\n2. **已有抖音号辅助创建辅助账号(小号)**\n路径:我 → 设置 → 切换账号 → 添加或注册新账号 → 辅助创建新账号,**不需要新手机号**,但辅助号后续建议单独绑定手机号,方便找回账号sf3-cdn-to...。\n3. **第三方授权注册(部分入口已收紧,以 APP 页面显示为准)**\n微信、QQ 授权登录注册。第三方登录注册后,**平台一般仍要求绑定手机号**,否则很多功能受限、账号找回风险高", "type": "output_text", "annotations": null } ], "role": "assistant", "status": "completed", "type": "message", "partial": false } ], "previous_response_id": "", "thinking": null, "service_tier": null, "status": "completed", "temperature": null, "tools": [ ], "top_p": null, "usage": { "input_tokens": 38851, "output_tokens": 94, "total_tokens": 38945, "tool_usage": { } }, "caching": null, "text": null, "instructions": null, "store": null, "expire_at": null, "tool_choice": "none", "parallel_tool_calls": false, "max_tool_calls": null, "reasoning": null, "token_usage": { "embedding_token_usage": { "prompt_tokens": 189, "completion_tokens": 0, "total_tokens": 189 }, "rerank_token_usage": 0, "llm_token_usage": { "prompt_tokens": 38851, "completion_tokens": 94, "total_tokens": 38945 } } }
执行失败返回:
HTTP/1.1 400 Bad Request Content-Length: 43 Content-Type: application/json { "error": { "code": "invalid_parameter", "message": "service apikey not match Request ID: 02179067972894300000000000000000000ffff0a00451b630b83", "param": "", "type": "" } }