Skip to content

Commit 767502b

Browse files
authored
Merge pull request #60 from AstrBotDevs/feat/kb
feat: 更新知识库文档,以反映新的 v4.5.0 重新设计的知识库功能
2 parents 7a3e3e0 + 0971b89 commit 767502b

File tree

4 files changed

+68
-55
lines changed

4 files changed

+68
-55
lines changed

use/image-3.png

217 KB
Loading

use/image-4.png

377 KB
Loading

use/knowledge-base-old.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# AstrBot 知识库
2+
3+
> [!TIP]
4+
> 需要 AstrBot 版本 >= 4.5.0。
5+
>
6+
> 我们在 4.5.0 版本中重新设计了全新的知识库系统,AstrBot 将原生支持知识库功能。下文介绍的是新版知识库的使用方法。如果您使用的是之前的版本,请参考[旧版知识库使用文档](https://docs.astrbot.app/zh/use/knowledge-base-old), 我们建议您升级到最新版以获得更好的体验。
7+
8+
![知识库预览](image-3.png)
9+
10+
## 配置嵌入模型
11+
12+
打开服务提供商页面,点击新增服务提供商,选择 Embedding,如下图所示:
13+
14+
![](../source/images/knowledge-base/QQ_1748619486233.png)
15+
16+
目前 AstrBot 支持兼容 OpenAI API 和 Gemini API 的嵌入向量服务。
17+
18+
点击上面的提供商卡片进入配置页面,填写配置。
19+
20+
配置完成后,点击保存。
21+
22+
## 配置重排序模型(可选)
23+
24+
重排序模型可以一定程度上提高最终召回结果的精度。
25+
26+
和嵌入模型的配置类似,打开服务提供商页面,点击新增服务提供商,选择重排序。有关重排序模型的更多信息请参考网络。
27+
28+
## 创建知识库
29+
30+
AstrBot 支持多知识库管理。在聊天时,您可以**自由指定知识库**
31+
32+
进入知识库页面,点击创建知识库,如下图所示:
33+
34+
![](../source/images/knowledge-base/image.png)
35+
36+
填写相关信息。在嵌入模型下拉菜单中您将看到刚刚创建好的嵌入模型和重排序模型(重排序模型可选)。
37+
38+
> [!TIP]
39+
> 一旦选择了一个知识库的嵌入模型,请不要再修改该提供商的**模型**或者**向量维度信息**,否则将**严重影响**该知识库的召回率甚至**报错**
40+
41+
## 上传文件
42+
43+
44+
45+
## 附录 2:免费的嵌入模型申请
46+
47+
### PPIO 派欧云
48+
49+
1. 打开 [PPIO 派欧云官网](https://ppio.cn/user/register?invited_by=AIOONE),并注册账户(通过此链接注册的账户将会获得 15 元人民币的代金券)。
50+
2. 进入 [模型广场](https://ppio.cn/model-api/console),点击嵌入模型
51+
3. 点击 BAAI:BGE-M3 (截止至 2025-06-02,该模型在该平台免费)。
52+
4. 找到 API 接入指南,申请 Key。
53+
5. 填写 AstrBot OpenAI Embedding 模型提供商配置:
54+
1. API Key 为刚刚申请的 PPIO 的 API Key
55+
2. embedding api base 填写 `https://api.ppinfra.com/v3/openai`
56+
3. model 填写你选择的模型,此例子中为 `baai/bge-m3`

use/knowledge-base.md

Lines changed: 12 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,29 @@
11
# AstrBot 知识库
22

33
> [!TIP]
4-
> 需要 AstrBot 版本 >= 3.5.13,并且 WebUI 已经同步升级至最新版本。
4+
> 需要 AstrBot 版本 >= 4.5.0。
5+
>
6+
> 我们在 4.5.0 版本中重新设计了全新的知识库系统,AstrBot 将原生支持知识库功能。下文介绍的是新版知识库的使用方法。如果您使用的是之前的版本,请参考[旧版知识库使用文档](https://docs.astrbot.app/zh/use/knowledge-base-old), 我们建议您升级到最新版以获得更好的体验。
57
6-
## 简介
7-
8-
AstrBot 提供了开箱即用的知识库功能。
9-
10-
## 安装
11-
12-
为了保证主线依赖的精简性,AstrBot 的知识库能力采用插件的形式提供,您需要先安装插件。
13-
14-
前往 WebUI,点击 `知识库` 即可进入到知识库页面。
15-
16-
如果显示未安装知识库,请先安装知识库插件。点击安装按钮即可,或者前往插件市场安装 `astrbot_plugin_knowledge_base` 插件。可能需要安装数分钟,请耐心等待,如果安装过程中发生了错误,请提交 Issue 至 [AstrBot Issues](https://github.com/AstrBotDevs/AstrBot/issues)
8+
![知识库预览](image-3.png)
179

1810
## 配置嵌入模型
1911

2012
打开服务提供商页面,点击新增服务提供商,选择 Embedding,如下图所示:
2113

2214
![](../source/images/knowledge-base/QQ_1748619486233.png)
2315

24-
目前 AstrBot 仅支持兼容 OpenAI API 的嵌入向量服务,如 OpenAI、Ollama 等。您可以参考此页后文 `附录-2 免费的嵌入模型申请` 章节申请免费的嵌入模型
16+
目前 AstrBot 支持兼容 OpenAI API 和 Gemini API 的嵌入向量服务
2517

2618
点击上面的提供商卡片进入配置页面,填写配置。
2719

28-
> [!TIP]
29-
> 请再三确保您所填写的**模型名称****嵌入维度**是否正确!常见的维度大小有:768, 1024, 1536, 3072。
30-
3120
配置完成后,点击保存。
3221

3322
## 配置重排序模型(可选)
3423

35-
重排序模型可以一定程度上提高最终召回结果的精度。和嵌入模型的配置类似,打开服务提供商页面,点击新增服务提供商,选择重排序。有关重排序模型的更多信息请参考网络。
24+
重排序模型可以一定程度上提高最终召回结果的精度。
25+
26+
和嵌入模型的配置类似,打开服务提供商页面,点击新增服务提供商,选择重排序。有关重排序模型的更多信息请参考网络。
3627

3728
## 创建知识库
3829

@@ -49,47 +40,13 @@ AstrBot 支持多知识库管理。在聊天时,您可以**自由指定知识
4940
5041
## 上传文件
5142

52-
点击创建完成的知识库,如下图所示:
53-
54-
![](../source/images/knowledge-base/image-1.png)
55-
56-
您可以上传文件或者通过 URL 来将信息导入到知识库。
57-
58-
### 从文件
59-
60-
数据源选择上传文件,拖拽或者点击上传您想要导入的文件。**最大的单个上传文件大小暂时为 128 MB。**
61-
62-
> [!TIP]
63-
> AstrBot 知识库使用 Markitdown 来将非文本文件转换成大模型友好的 Markdown 格式。
64-
> 您可以上传的文件格式如下:md, txt, docx, xlsx, pptx 等等。其中,兼容性最好的方案是 md 和 txt。
65-
66-
点击上传到知识库即可开始上传。对于大文件,这可能需要一些时间。如果有报错并且无法解决,请提交 Issue 至 [AstrBot Issues](https://github.com/AstrBotDevs/AstrBot/issues)
67-
68-
上传成功后,下方会弹出绿色的提示。
69-
70-
### 从 URL
71-
72-
> [!TIP]
73-
> 您需要先前往插件市场安装 astrbot_plugin_url_2_knowledge_base 并根据插件文档内的指示完成 playwright 安装后才可使用本功能。
74-
75-
输入网页 URL,即可导入。如果有报错并且无法解决,请提交 Issue 至 [AstrBot Issues](https://github.com/AstrBotDevs/AstrBot/issues)
76-
77-
上传成功后,下方会弹出绿色的提示。
78-
79-
## 测试和使用
80-
81-
您可以点击 `搜索内容` 立刻开始测试可用性(不会使用 LLM)。
82-
83-
您可在配置页选择需要使用的知识库。
84-
85-
## 反馈
43+
创建好知识库之后,可以为知识库上传文档。支持同时上传最多 10 个文件,单个文件大小不超过 128 MB。
8644

87-
这是一个新功能。如果有报错并且无法解决,请提交 Issue 至 [AstrBot Issues](https://github.com/AstrBotDevs/AstrBot/issues)
45+
![上传文件](image-4.png)
8846

89-
## 附录 1:Credits
47+
## 使用知识库
9048

91-
1. AstrBot 知识库插件仓库地址:[astrbot_plugin_knowledge_base](https://github.com/lxfight/astrbot_plugin_knowledge_base)
92-
2. Made with ❤ by **[@lxfight](https://github.com/lxfight)** and [@Soulter](https://github.com/Soulter) and [@Yxiguan](https://github.com/Yxiguan) and [@TheAnyan](https://github.com/TheAnyan).
49+
在配置文件中,可以为不同的配置文件指定不同的知识库。
9350

9451
## 附录 2:免费的嵌入模型申请
9552

0 commit comments

Comments
 (0)