Skip to content

Commit b22d06a

Browse files
committed
更新快速入门文档,调整整个文档结构
1 parent b115cdf commit b22d06a

File tree

2 files changed

+40
-12
lines changed

2 files changed

+40
-12
lines changed

docs/quick_start.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,47 @@
11

2-
## 1 操作流程
2+
## 1 快速部署
33

44
!!! Abstract ""
5-
MaxKB 的使用操作流程一般可分为四步:添加模型、创建知识库、创建应用、发布应用。
5+
按照部署服务器要求准备好部署环境后,通过安装脚本快速部署。
6+
7+
部署服务器要求:
8+
9+
* 操作系统:Ubuntu 22.04 / CentOS 7.6 64 位系统
10+
* CPU/内存:4C/8GB 以上
11+
* 磁盘空间:100GB
12+
13+
将安装包上传至服务器并解压,在安装包目录里执下脚本进行快速安装:
14+
```
15+
# 解压安装包
16+
tar -zxvf maxkb-v1.10.0-lts-offline.tar.gz
17+
18+
# 进入安装包解压缩后目录
19+
cd maxkb-v1.10.0-lts-offline
20+
21+
# 执行安装命令
22+
bash install.sh
23+
```
24+
25+
安装完成后,可通过浏览器访问地址 `http://目标服务器 IP 地址:8080`,并使用默认的管理员用户和密码登录 MaxKB。
26+
27+
```
28+
用户名:admin
29+
默认密码:MaxKB@123..
30+
```
31+
32+
33+
## 2 操作流程
34+
35+
!!! Abstract ""
36+
典型的 MaxKB 的操作流程一般可分为四步:添加模型、创建知识库、创建应用、发布应用。
637
在高级编排应用中还可以通过函数库的功能,实现数据处理、逻辑判断、信息提取等功能,提供更加强大、灵活的能力。
738

839
![操作流程](img/model/maxkb_flow.png)
940

1041
!!! Abstract ""
11-
下面以通用知识库为例,通过公有模型服务通义千问(本地模型部署操作,例如,DeepSeek部署,请参考[使用1Panel开源面板快速部署DeepSeek-R1](https://mp.weixin.qq.com/s/bF253jBHZIWIHvNnSMv-Rg)),快速创建智能问答应用并发布为例说明具体的操作
42+
下面以通用知识库为例,通过公有模型服务通义千问(本地模型部署操作,例如,DeepSeek部署,请参考[使用1Panel开源面板快速部署DeepSeek-R1](https://mp.weixin.qq.com/s/bF253jBHZIWIHvNnSMv-Rg)),快速创建智能问答应用并发布说明具体操作
1243

13-
## 2 添加模型
44+
### 2.1 添加模型
1445

1546
!!! Abstract ""
1647
登录 MaxKB 系统后,在供应商列表中选择`通义千问`,然后点击【添加模型】,进入模型配置表单配置参数如下:
@@ -27,13 +58,12 @@
2758
不同的平台参数要求不同,其它供应商模型配置添加详情见各模型对接详细说明。
2859

2960

30-
## 3 创建知识库
61+
### 2.2 创建知识库
3162

3263
!!! Abstract ""
3364

3465
打开【知识库】页面,点击【创建知识库】,输入知识库名称、知识库描述、选择内置的向量模型 MaxKB-Embedding,并设置知识库类型为通用型,然后将离线文档通过拖拽方式或选择文件上传方式进行上传。
3566

36-
### 3.1 上传文档
3767

3868
!!! Abstract ""
3969
上传文档要求:
@@ -51,8 +81,6 @@
5181
* 段落要完整:一个分段中最好能描述一个完整的内容。
5282

5383
![创建通用知识库](img/dataset/create_offline_dataset.png)
54-
55-
### 3.2 设置分段规则
5684

5785
!!! Abstract ""
5886
MaxKB 支持智能分段和高级分段两种分段方式。
@@ -111,7 +139,7 @@
111139

112140
![文档列表](img/dataset/doc_list.png)
113141

114-
## 4 创建应用
142+
### 2.3 创建应用
115143

116144
!!! Abstract ""
117145
点击【创建应用】,输入应用名称,选择【简易配置应用】,点击【创建】
@@ -164,7 +192,7 @@
164192
经过调试后,保存设置并发布。在应用列表页面,在概览页面点击演示或在浏览器中复制公开访问链接进入问答页面进行提问。
165193
![演示预览](img/app/app_view.png)
166194

167-
## 5 应用集成
195+
### 2.4 应用集成
168196

169197
!!! Abstract ""
170198
MaxKB 应用支持零编码快速嵌入第三方 Web系统。

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ theme:
3939
custom_dir: "theme"
4040
nav:
4141
- 产品介绍: index.md
42+
- 快速入门: quick_start.md
43+
- 更新日志: changelog.md
4244
- 系统架构: system_arch.md
4345
- 安装部署:
4446
- 离线安装: installation/offline_installtion.md
@@ -47,7 +49,6 @@ nav:
4749
- 阿里云安装: installation/aliyun.md
4850
- 腾讯云安装: installation/tencent.md
4951
- 命令行工具: installation/cli.md
50-
- 快速入门: quick_start.md
5152
- 功能手册:
5253
- 知识库:
5354
- 知识库: user_manual/dataset/dataset.md
@@ -105,7 +106,6 @@ nav:
105106
- 将MaxKB小助手集成到Halo中: faq/maxkb_In_halo.md
106107
- MaxKB和Dify有什么区别: faq/MaxKB VS.Dify.md
107108
- 知识库文档如何合理分段: faq/doc_segment.md
108-
- 更新日志: changelog.md
109109
- 联系我们: contact.md
110110

111111
markdown_extensions:

0 commit comments

Comments
 (0)