乐享知识库接口文档 # AI 问答
请求URL
POST https://lxapi.lexiangla.com/cgi-bin/v1/ai/qa
请求头
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定值："application/json; charset=utf-8" |
| Authorization | 是 | 接口调用凭证 access_token 值格式："Bearer access_token" 示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS" |
| x-staff-id | 是 | 发起问答的成员帐号。若希望使用匿名用户，可设置为固定值："system-bot" |
其他说明
| 事项 | 说明 |
|---|---|
| 权限要求 | AI助手 |
请求参数
{
"query": "乐享是什么？",
"stream": false,
"anonymous_staff_id": "",
"skip_faq":false,
"new_session":false,
"session_id":"3e22842cxxxxxxxxxxxxxxxxxxx1b602cb706e5",
"qa_mode":"reasoning",
"max_chars": 200,
"targets": [
{
"type": "team",
"id": "74d76195adxxxxxxd49239d56e44f"
}
]
}
参数说明
| 参数 | 是否必须 | 默认值 | 说明 |
|---|---|---|---|
| query | 是 | 无 | 用户最新输入问题，最长 128 字符 |
| stream | 否 | false | 是否流式输出 |
| anonymous_staff_id | 否 | 无 | 匿名用户 ID，当HttpHeader.x-staff-id=system-bot时有效由业务调用方生成，字符串长度范围：[16, 32] |
| skip_faq | 否 | false | 是否跳过已关联的FAQ，仅调用AI根据站内知识生成的回答。 false：不跳过FAQ，若问题命中关联FAQ，则输出对应问答； true，跳过FAQ，仅调用AI根据站内知识生成的回答 |
| new_session | 否 | false | 是否重置并开启全新话题，避免此前对话混淆 AI 助手的理解。 false：参考对话上下文进行问答； true：重置并开启全新会话，此时传入session_id字段无效 |
| session_id | 否 | 无 | 会话ID，可用以区分不同的会话。不同会话间的对话历史相互隔离。当开启全新会话后会随响应返回，后续可通过传入对应的session_id保持多轮对话。字符串长度：40 |
| qa_mode | 否 | normal | 思考方式，可以通过传入参数开启不同的问答模式。 normal: 使用默认模型进行快速回答; normal-ds-v3: 使用deepseek-v3-0324模型进行快速回答; reasoning: 深度思考; research: 专业研究 |
| max_chars | 否 | 无 | 回答内容字数限制，仅输入大于0的整数才可生效（注：为保证语义完整，最终AI回答字数可能超过字数限制） |
| targets | 否 | 无 | 知识范围，可以通过传入参数限制知识来源的范围，不传则默认为全站知识。仅支持指定同一范围类型（targets.type），最多可传入20个范围对象。 |
| targets.type | 否 | 无 | 表示范围类型，可设置为space(知识库)/team(团队)/team_code(团队code) |
| targets.id | 否 | 无 | 表示对应范围类型的id。 |
非流式响应
200 OK 状态码
{
"code": 0,
"message": "success",
"request_id": "eb83bd93-5e50-4a0a-8db6-c0fb1bc7aa2b",
"data": {
"content": "腾讯乐享是腾讯公司推出的……",
"answer_source": "internal",
"session_id": "cc77ca018fe67dcb581f3b3c460894dedb9f6b80",
"reasoning_content": "嗯，用户询问\"乐享是什么？\"……",
"additional_content": {
"generated_question": "",
"reference_chunks": [
{
"content": "腾讯乐享是腾讯推出的……",
"target_id": "5dc00bd321a24568bb4787dec964cde2",
"target_type": "kb_entry",
"title": "腾讯乐享介绍",
"url": "/pages/5dc00bd321a24568bb4787dec964cde2"
},
{
"content": "打造公司的社区……",
"target_id": "a8db4ead786041afa336a42b8dad926b",
"target_type": "kb_entry",
"title": "SaaS产品分析",
"url": "/pages/a8db4ead786041afa336a42b8dad926b"
}
],
"reference_docs": [
{
"title": "腾讯乐享介绍",
"url": "/pages/5dc00bd321a24568bb4787dec964cde2"
},
{
"title": "SaaS产品分析",
"url": "/pages/93f2cf8eec6a438381aa2ccf040dfa85"
}
]
}
}
}
响应字段说明
| 参数 | 说明 |
|---|---|
| code | 状态码：0表示成功，非0表示失败 |
| message | 状态信息：success表示成功，其他值为失败信息 |
| request_id | 请求的唯一标识ID |
| data | 响应数据主体 |
| data.content | 返回的完整答案内容 |
| data.answer_source | 答案来源：internal(全站知识)，internal-team(指定团队空间)，internal-space(指定知识库) |
| data.reasoning_content | 当qa_mode等于reasoning或research时返回，返回深度思考过程。非对应qa_mode时不返回此字段 |
| data.session_id | 会话ID，用于区分不同会话 |
| data.additional_content | 附加内容信息 |
| data.additional_content.generated_question | 基于会话历史对用户query的语义改写结果 |
| data.additional_content.reference_chunks | 回答参考的内容段落列表 |
| data.additional_content.reference_chunks[].content | 匹配的实体内容 |
| data.additional_content.reference_chunks[].target_id | 匹配的实体ID |
| data.additional_content.reference_chunks[].target_type | 匹配的实体类型，kb_entry表示知识库知识 |
| data.additional_content.reference_chunks[].title | 匹配的实体标题 |
| data.additional_content.reference_chunks[].url | 匹配的实体页面访问路径 |
| data.additional_content.reference_docs | 回答参考的实体来源列表 |
| data.additional_content.reference_docs[].title | 匹配的实体标题 |
| data.additional_content.reference_docs[].url | 匹配的实体的页面访问路径 |
流式响应
基于 server-sent events (opens new window) 实现。
200 OK 状态码
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"internal_searching","message":"正在搜索","delta_content":"","content":"","detail":null},"delta_content":"","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"finished_internal_searching","message":"搜索到 11 篇资料","delta_content":"","content":"","detail":null},"delta_content":"","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":{"reference_chunks":[{"content":"\n腾讯乐享是腾讯推出的……","target_id":"5dc00bd321a24568bb4787dec964cde2","target_type":"kb_entry","title":"无标题","url":"/pages/5dc00bd321a24568bb4787dec964cde2"}]}}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"腾讯乐享是腾讯推出的一站式企业社区平台，专注于知识管理、培训学习、文化建设和内部协作，提供文档分类、在线","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"课程","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"、","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"考试","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"、","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"直播","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"、","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"论坛","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"等功能","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"，","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"助力","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"企业","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"数字化","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"管理","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
data:{"file_info":{"target_type":"kb_file","target_id":"fb088b73a62b43d5a61cf0fafb57d561"},"file_pages":[2,3],"file_type":"pdf","target_id":"2a9b232aee044b00a8762dea518af904","target_type":"kb_entry"}
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"。","content":"","finish_reason":"","is_stop":false,"answer_source":"","additional_content":null}
event:finish
data:{"completion_id":"586a64ca12ef4c3c94b2deaaa8c2ddfc","session_id":"72d408a0327a5026014853aae69cffd80e3c652b","processes":{"stage":"","message":"","delta_content":"","content":"","detail":null},"delta_content":"","content":"腾讯乐享是腾讯推出的一站式企业社区平台，专注于知识管理、培训学习、文化建设和内部协作，提供文档分类、在线课程、考试、直播、论坛等功能，助力企业数字化管理[1][2]。","finish_reason":"stop","is_stop":true,"answer_source":"internal","additional_content":{"generated_question":"","reference_docs":[{"title":"无标题","url":"/pages/5dc00bd321a24568bb4787dec964cde2"},{"title":"腾讯千帆-乐享-产品宣传册-211105","url":"/pages/2a9b232aee044b00a8762dea518af904"}]}}
响应字段说明
| 参数 | 说明 |
|---|---|
| completion_id | 任务id |
| session_id | 会话id |
| processes | 处理过程信息 |
| processes.message | 处理过程的具体信息 |
| delta_content | 内容块 |
| content | 完整答案内容 |
| finish_reason | 回答结束原因 |
| is_stop | 回答完成状态 |
| answer_source | internal表示使用全站知识回答，internal-team表示使用指定团队空间知识回答，internal-space表示使用指定知识库知识回答 |
| additional_content | 附加内容信息 |
| additional_content.generated_question | 对会话历史语义信息，对用户的query改写后的结果 |
| additional_content.reference_chunks | 回答参考的内容段落 |
| additional_content.reference_docs | 问答参考的内容来源 |
| additional_content.reference_docs.title | 乐享文档标题 |
| additional_content.reference_docs.url | 乐享文档链接 |