快速入门
2.1 登录 MaxKB 系统
1 | 使用浏览器打开服务地址:http://目标服务器IP地址:目标端口。 |
2.2 添加模型
1 | 登录 MaxKB 系统后,可以先对接一下模型,也可以在创建应用时添加模型。 |
2.2.1 添加千帆大模型
1 | 点击【添加模型】,选择供应商【千帆大模型】,直接进入下一步填写千帆大模型表单。 |
1 | 模型名称: MaxKB 中自定义的模型名称。 |
2.2.2 添加 Ollama 模型
1 | 点击【添加模型】,选择供应商【 Ollama 】,直接进入下一步填写 Ollama 供应商的大模型表单。 |
2.2.3 添加 Azure OpenAI 模型
1 | 在模型管理中,点击供应商【 Azure OpenAI 】,直接进入下一步填写Azure OpenAI 的模型表单。 |
1 | API 域名、API Key、部署名称: 是Azure OpenAI 的模型部署中提供的,需要填写一致,参考下图: |
2.2.4 添加 OpenAI 大模型
1 | 在模型管理中,点击供应商【 OpenAI 】,直接进入下一步填写 OpenAI 的模型表单。 |
2.2.5 添加讯飞星火大模型
1 | 在模型管理中,点击供应商【讯飞星火】,直接进入下一步填写讯飞星火的模型表单。 |
2.2.6 添加智谱AI大模型
1 | 在模型管理中,点击供应商【智谱AI】,直接进入下一步填写智谱AI的模型表单。 |
2.2.7 添加通义千问大模型
1 | 在模型管理中,点击供应商【通义千问】,直接进入下一步填写通义千问的模型表单。 |
2.2.8 添加Kimi大模型
1 | 在模型管理中,点击供应商【Kimi】,直接进入下一步填写Kimi的模型表单。 |
2.3 创建知识库
1 | 打开【知识库】页面,点击【创建知识库】,进入创建知识库页面。 |
- 上传文档
1
2
3
4
5
6
7
8
9
10输入知识库名称、知识库描述、选择通用型知识库类型。
然后将离线文档通过拖拽方式或选择文件上传方式进行上传。
上传文档要求:
支持的格式为Markdown、TXT、PDF、DOCX;
每次最多上传 50 个文件;
每个文件不超过 100 MB。
文档规范建议:
1、规范分段标识:离线文档的分段标识要有一定规范,否则拆分出来的段落会不规整。
2、段落要完整:一个分段中最好能描述一个完整的功能点或问题。
- 设置分段规则 用户可在分段预览中对不合理的分段进行编辑和删除。
1
2
3
4
5当前支持智能分段和高级分段两种分段方式,推荐选择:智能分段。
支持查看分段预览。
```
点击【创建并导入】后,系统会对文档进行自动分段 -> 存储 -> 向量化处理操作。1
2
3
4<img width="1476" alt="EditSegments" src="https://github.com/1Panel-dev/MaxKB/assets/52996290/b252ea19-1413-4475-96e8-191d21780cce" >
- **创建完成**
点击【前往文档】进入该知识库的【文档】列表页面。点击【创建应用】,进入创建应用页面,左侧为应用信息,右侧为调试预览界面。1
2
3
4<img width="1475" alt="doc_list" src="https://github.com/1Panel-dev/MaxKB/assets/52996290/33b8917f-019c-40bd-8080-01c260202e48" >
## 2.4 创建应用
应用名称: 用户提问时对话框的标题和名字。
应用描述: 对应用场景及用途的描述。
AI模型: 显示【系统设置】-【模型管理】中大语言模型,也可以直接添加模型,请参考【添加模型】操作介绍。
提示词: 系统默认有知识库的问答提示词,用户可以自定义。
多轮对话: 开启时当用户提问携带用户在当前会话中最后3个问题;不开启则仅向大模型提交当前问题。
关联知识库: 选择已有的知识库进行关联,用户提问时会在关联的知识库中检索分段,引用分段生成提示词发送给大模型进行询问。若未关联知识库或未匹配到分段内容。
参数设置: 可以设置知识库的相似度,引用分段数量和最大引用字符数。
注意:关联的知识库和应用为同一个用户创建。
开场白: 用户打开对话时,系统弹出的问候语。支持 Markdown 格式;[- ]后的内容为快捷问题,一行一个。
问题优化: 对用户提出的问题先进行一次 LLM 优化处理,将优化后的问题在知识库中进行向量化检索,开启后能提高检索知识库的准确度,但由于多一次询问大模型会增加回答问题的时长。
应用信息设置完成后,可以在右侧调试预览中进行提问预览。以上 4 步完成后,便可进行问答对话了。1
2<img width="1472" alt="add-app" src="https://github.com/1Panel-dev/MaxKB/assets/52996290/06af41b8-42d5-4e69-837e-0a5e0fd30e88" >
入口一:在应用列表页面,点击【演示】,可进入问答页面。1
2## 2.5 演示预览
入口二:点击应用面板,在概览页面点击演示或复制公开访问链接至浏览器进入问答页面进行提问。在对话日志钟记录了所有用户会话中的问答详情,包括用户对AI 回答的反馈信息。1
2
3<img width="1475" alt="QA" src="https://github.com/1Panel-dev/MaxKB/assets/52996290/079a9f0c-b163-4d01-ac81-dceedbacbb3b" >
## 2.6 对话日志
维护人员可以通过查看对话日志和用户反馈来修正答案。
<img width="1468" alt="log-details" src="https://github.com/1Panel-dev/MaxKB/assets/52996290/af47e50b-50c4-43d3-bf74-cd68be09dac8" >