AI RAG 文档知识库问答 API 接口
AI RAG 文档知识库问答 API 接口
接口详情官网地址: https://www.gugudata.com/api/details/knowledge-chat
AI RAG 文档知识库问答 API 支持将 API 文档、产品说明、帮助文档和协议资料构建为私有知识库,并基于已上传文档进行智能问答。AI、RAG、知识库、文档问答和流式响应等关键词场景常会用到,适合用于客服问答、开发者门户、内部知识系统、产品文档检索和多轮咨询等业务场景,方便开发者直接在应用、脚本或数据流程中接入。

1. 产品功能
-
• 支持上传 API 文档、产品说明、协议和帮助文档等资料构建私有知识库; -
• 支持 PDF、TXT、Markdown、HTML 和 DOCX 文档上传; -
• 上传后返回 document_id、解析状态、分块数量和入库状态,便于客户侧确认知识库构建结果; -
• 支持知识库分组与客户侧业务分组,适合多产品、多项目或多客户场景; -
• 支持基于线程的连续追问,适合嵌入客服、开发者门户和内部知识系统; -
• 支持 OpenAI Chat Completions 兼容 JSON 与 SSE 流式响应; -
• 回答结果包含引用来源,便于追溯内容依据; -
• 客户文档仅用于当前知识库问答,不用于训练公共模型; -
• 全接口支持 HTTPS(TLS v1.0 / v1.1 / v1.2 / v1.3); -
• 全面兼容 Apple ATS; -
• 全国多节点 CDN 部署; -
• 接口极速响应,多台服务器构建 API 接口负载均衡;
2. API 文档
接口地址: https://api.gugudata.com/ai/knowledge-bases/{knowledge_base_id}/chat/completions
返回格式: application/json; charset=utf-8
请求方式: POST
请求协议: HTTPS
请求示例: https://api.gugudata.com/ai/knowledge-bases/default/chat/completions?appkey=YOUR_APPKEY
数据预览: https://www.gugudata.com/preview/knowledge-chat
接口测试: https://api.gugudata.com/ai/knowledge-bases/default/chat/completions
3. 请求参数
|
|
|
|
|
|
|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4. 返回参数
|
|
|
|
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
5. 错误码说明
|
|
|
|
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
6. 适用场景
-
• 适合用于客服知识库、帮助中心和开发者门户,将产品文档、接口文档和常见问题快速转化为可问答能力。 -
• 适合用于企业内部知识检索、多项目资料管理和团队资料查询,减少人工查找、重复解释和上下文整理成本。 -
• 适合用于私有文档问答、多轮咨询和流式回复场景,将回答内容、引用来源和线程上下文直接接入业务系统。
7. 相关接口
7.1 同一接口族关联接口
|
|
|
|
|
|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
其中 AI RAG 文档知识库问答为本文主接口,完整请求参数和返回参数见第 3、4 节;以下展开上传知识库文档接口。
上传知识库文档
上传文档并构建私有知识库,适合在发起问答前导入 API 文档、产品说明、帮助文档、协议资料等内容。
接口地址: https://api.gugudata.com/ai/knowledge-bases/{knowledge_base_id}/documents
请求方式: POST
请求协议: HTTPS
请求参数:
|
|
|
|
|
|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回参数:
|
|
|
|
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
7.2 可搭配使用
-
• 可搭配使用:语义化获取站点 JSON 结构内容[1],适合先从网页中抽取结构化内容,再沉淀到知识库或业务流程。 -
• 可搭配使用:文章抽取信息化 JSON[2],适合补充网页文章内容抽取和知识资料整理能力。 -
• 可搭配使用:高考教育信息智能助手[3],适合补充教育信息问答和 RAG 问答类场景的接口能力。
引用链接
[1] 语义化获取站点 JSON 结构内容: https://www.gugudata.com/api/details/url2json[2] 文章抽取信息化 JSON: https://www.gugudata.com/api/details/article-extract[3] 高考教育信息智能助手: https://www.gugudata.com/api/details/gaokao-chat

DevOpen.Club Pro 高质量软件开发分享交流社群,汇聚了来自各行各业的 1300 多位软件开发者,是一个专注于分享高质量技术资源、讨论问题解决方案、孵化项目合作伙伴的干货社区。
自 2017 年成立以来,社群一直保持着持续的分享与交流,致力于为所有成员提供有价值的学习与合作机会。欢迎你的加入,与志同道合的开发者一起成长、共创未来。
任何技术都不是限制,我们最终目的是将技术转化成收入,实现财务自由。
#DevOpenClub Pro 社群指南#
-
每日分享高质量的技术开发资讯与资源;
-
快速提问、讨论交流,无论遇到何种技术难题,都能在这里获得帮助;
-
永久获取每年原创开发视频教程的第一手更新;
-
获取更多高质量软件开发行业新闻、技术文章与教学视频;
-
在群内结识更多朋友,寻求合作开发项目的机会,而不是用时间去闲聊(如果你认可的话);
-
与不同行业的伙伴交流创业小项目或分享心得;
-
探讨与分享技术面试的经验与技巧;
-
高质量、有价值的社区不仅仅局限于一个 QQ 群或微信群,而是一群人共同成长的舞台。

夜雨聆风