ContextQMD
Back to Weknora

聊天功能 API

docs/api/chat.md

0.7.07.5 KB
Original Source

聊天功能 API

返回目录

方法路径描述
POST/knowledge-chat/:session_id基于知识库的问答
POST/agent-chat/:session_id基于 Agent 的智能问答
POST/knowledge-search基于知识库的搜索知识
GET/sessions/:session_id/messages/:message_id/suggestions获取已生成的回答后推荐
POST/sessions/:session_id/messages/:message_id/suggestions确保生成或换一批推荐
POST/sessions/:session_id/suggestion-events上报曝光、点击、关闭事件

POST /knowledge-chat/:session_id - 基于知识库的问答

基于知识库的 RAG 问答，支持 SSE 流式响应。

请求参数：

参数类型必填说明
querystring是查询文本
knowledge_base_idsstring[]否知识库 ID 列表
knowledge_idsstring[]否知识文件 ID 列表，指定具体文件进行检索
agent_idstring否自定义 Agent ID，指定使用的智能体
summary_model_idstring否覆盖默认的摘要模型 ID
mentioned_itemsobject[]否@提及的知识库和文件列表
disable_titlebool否是否禁用自动标题生成（默认 false）
enable_memorybool否是否启用记忆功能
imagesobject[]否附带的图片（base64 格式），需要 Agent 启用图片上传
channelstring否来源渠道标识：web、api、im、browser_extension
suggestion_attributionobject否用户从推荐问题发起本轮时传入 {suggestion_set_id, question_id}；服务端会校验归属

请求:

curl
curl --location 'http://localhost:8080/api/v1/knowledge-chat/ceb9babb-1e30-41d7-817d-fd584954304b' \
--header 'X-API-Key: sk-xxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "query": "彗尾的形状",
    "knowledge_base_ids": ["kb-00000001"],
    "agent_id": "builtin-quick-answer"
}'

响应格式: 服务器端事件流（Server-Sent Events，Content-Type: text/event-stream）

响应:

event: message
data: {"id":"3475c004-0ada-4306-9d30-d7f5efce50d2","response_type":"references","content":"","done":false,"knowledge_references":[{"id":"c8347bef-...","content":"彗星xxx。","knowledge_id":"a6790b93-...","chunk_index":0,"knowledge_title":"彗星.txt","score":4.04,"match_type":3,"chunk_type":"text","knowledge_filename":"彗星.txt"}]}

event: message
data: {"id":"3475c004-0ada-4306-9d30-d7f5efce50d2","response_type":"answer","content":"彗尾的形状主要表现为...","done":false,"knowledge_references":null}

event: message
data: {"id":"3475c004-0ada-4306-9d30-d7f5efce50d2","response_type":"answer","content":"","done":true,"knowledge_references":null}

POST /agent-chat/:session_id - 基于 Agent 的智能问答

Agent 模式支持更智能的问答，包括工具调用、网络搜索、多知识库检索等能力。

请求参数：

参数类型必填说明
querystring是查询文本
knowledge_base_idsstring[]否知识库 ID 列表，可动态指定本次查询使用的知识库
knowledge_idsstring[]否知识文件 ID 列表，可动态指定本次查询使用的具体文件
agent_enabledbool否是否启用 Agent 模式（默认 false，优先使用 Agent 配置）
agent_idstring否自定义 Agent ID，指定使用的智能体（支持共享 Agent）
web_search_enabledbool否是否启用网络搜索（默认 false）
summary_model_idstring否覆盖默认的摘要模型 ID
mentioned_itemsobject[]否@提及的知识库和文件列表
disable_titlebool否是否禁用自动标题生成（默认 false）
enable_memorybool否是否启用记忆功能
imagesobject[]否附带的图片（base64 格式），需要 Agent 启用图片上传
channelstring否来源渠道标识：web、api、im、browser_extension
suggestion_attributionobject否用户从推荐问题发起本轮时传入 {suggestion_set_id, question_id}；服务端会校验归属

回答后推荐问题

回答主消息完成后，服务端会异步生成推荐问题，不阻塞 SSE 的 complete/done 事件。生成结果按“空间、助手消息、位置、配置快照、语言”持久化并去重。

http
POST /api/v1/sessions/{session_id}/messages/{message_id}/suggestions
Content-Type: application/json

{"regenerate": false}

状态包括 generating、ready、suppressed、failed。ready 时的每个问题都有稳定 id，点击后应先上报事件，并在下一次聊天请求中携带 suggestion_attribution。

http
POST /api/v1/sessions/{session_id}/suggestion-events
Content-Type: application/json

{
  "suggestion_set_id": "...",
  "question_id": "...",
  "event_type": "click"
}

网页嵌入提供同构接口：/api/v1/embed/{channel_id}/sessions/{session_id}/...，继续使用嵌入令牌和 X-Embed-Session。

mentioned_items 结构：

字段类型说明
idstring知识库或文件 ID
namestring显示名称
typestring类型：kb（知识库）或 file（文件）
kb_typestring知识库类型：document 或 faq（仅 type=kb 时）

images 结构：

字段类型说明
datastringbase64 编码的图片数据（data:image/png;base64,...）

请求:

curl
curl --location 'http://localhost:8080/api/v1/agent-chat/ceb9babb-1e30-41d7-817d-fd584954304b' \
--header 'X-API-Key: sk-xxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "query": "帮我查询今天的天气",
    "agent_enabled": true,
    "web_search_enabled": true,
    "knowledge_base_ids": ["kb-00000001"],
    "agent_id": "builtin-smart-reasoning",
    "mentioned_items": [
        {
            "id": "kb-00000001",
            "name": "天气知识库",
            "type": "kb",
            "kb_type": "document"
        }
    ]
}'

响应格式: 服务器端事件流（Server-Sent Events，Content-Type: text/event-stream）

响应类型说明：

response_type描述
agent_queryAgent 开始处理查询
thinkingAgent 思考过程
tool_call工具调用信息
tool_result工具调用结果
references知识库检索引用
answer最终回答内容
reflectionAgent 反思内容
session_title自动生成的会话标题
error错误信息

响应示例:

event: message
data: {"id":"req-001","response_type":"thinking","content":"用户想查询天气，我需要使用网络搜索工具...","done":false}

event: message
data: {"id":"req-001","response_type":"tool_call","content":"","done":false,"data":{"tool_name":"web_search","arguments":{"query":"今天天气"}}}

event: message
data: {"id":"req-001","response_type":"tool_result","content":"搜索结果：今天晴，气温25°C...","done":false}

event: message
data: {"id":"req-001","response_type":"answer","content":"根据查询结果，今天天气晴朗，气温约25°C。","done":false}

event: message
data: {"id":"req-001","response_type":"answer","content":"","done":true}