Skip to content

Commit ed8e19f

Browse files
greenyhsjgreenyhsj
committed
feat：修正前后空格和错误表达和视频链接地址
1 parent a283ada commit ed8e19f

12 files changed

Lines changed: 28 additions & 28 deletions

‎docs/dev_manual/APIKey_chat.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
!!! Abstract ""
2-
MaxKB 创建的应用支持通过 OpenAI SDK 格式以及提供系统 SDK接入，专业版在社区版本基础上提供平台级别的完整 SDK，详细情况见：[系统API](../user_manual/X-Pack/system_API.md)。
2+
MaxKB 创建的应用支持通过 OpenAI SDK 格式以及提供系统 SDK 接入，专业版在社区版本基础上提供平台级别的完整 SDK，详细情况见：[系统API](../user_manual/X-Pack/system_API.md)。
33

44
## 1 标准OpenAI API格式
55

66
!!! Abstract ""
7-
MaxKB 应用兼容 OpenAI API 格式，在OpenAI API 原有调用方式的基础上替换为 MaxKB 应用提供的 Base URL 以及 API Key 即可。
7+
MaxKB 应用兼容 OpenAI API 格式，在 OpenAI API 原有调用方式的基础上替换为 MaxKB 应用提供的 Base URL 以及 API Key 即可。
88

99
![API doc](../img/dev/openai_baseurl.png)
1010

1111
!!! Abstract ""
1212

1313
```
14-
# 将url 和 Authorization 替换为 MaxKB 应用实际真实的 Base URL 和 API Key。
14+
# 将 url 和 Authorization 替换为 MaxKB 应用实际真实的 Base URL 和 API Key。
1515

1616
curl https://maxkb.fit2cloud.com/api/application/xxxxxxxx-8c56-11ef-a99e-0242ac140003/chat/completions \
1717
-H "Content-Type: application/json" \
@@ -27,23 +27,23 @@
2727
}'
2828
```
2929

30-
## 2 系统API
30+
## 2 系统 API
3131

32-
### 2.1 打开API文档
32+
### 2.1 打开 API 文档
3333

3434
!!! Abstract ""
3535
在应用信息中复制并访问 swagger 地址。
3636

3737
![API doc](../img/dev/app_swaagger.png)
3838

39-
### 2.2 API Key认证
39+
### 2.2 API Key 认证
4040

4141
![APIKEY](../img/dev/app_apikey.png)
4242

4343
### 2.3 获取应用信息
4444

4545
!!! Abstract ""
46-
调用 profile 接口，获取应用详细信息（应用 id、name等）。
46+
调用 profile 接口，获取应用详细信息（应用 id、name 等）。
4747

4848
![ profile](../img/dev/app_profile.png)
4949

‎docs/dev_manual/dev_environment.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@
4242
### 3.1 创建数据库
4343

4444
!!! Abstract ""
45-
在 PostgreSql 中手动创建MaxKB 应用数据库，名称为`maxkb`。
45+
在 PostgreSql 中手动创建 MaxKB 应用数据库，名称为`maxkb`。
4646
```
4747
# 创建数据库
4848
CREATE DATABASE "maxkb";
4949
# 切换使用数据库
5050
\c "maxkb";
51-
# 创建vector 扩展
51+
# 创建 vector 扩展
5252
CREATE EXTENSION "vector";
5353
```
5454

@@ -60,7 +60,7 @@
6060
- 准备配置文件
6161

6262
```bash
63-
# 将config_example.yml配置文件拷贝至 /opt/maxkb/conf目录下
63+
# 将 config_example.yml 配置文件拷贝至 /opt/maxkb/conf 目录下
6464
cp config_example.yml /opt/maxkb/conf
6565
```
6666

@@ -76,9 +76,9 @@
7676
DB_ENGINE: django.db.backends.postgresql_psycopg2
7777
7878
# 模型相关配置
79-
# 模型路径:如果EMBEDDING_MODEL_NAME是绝对路径则无效,反之则会从https://huggingface.co/下载模型到当前目录
79+
# 模型路径:如果 EMBEDDING_MODEL_NAME 是绝对路径则无效,反之则会从 https://huggingface.co/ 下载模型到当前目录
8080
EMBEDDING_MODEL_PATH: /opt/maxkb/model/
81-
# 模型名称:如果模型名称是路径,则会加载目录下的模型,如果是模型名称,则会在https://huggingface.co/下载模型 模型的下载位置为EMBEDDING_MODEL_PATH
81+
# 模型名称:如果模型名称是路径,则会加载目录下的模型,如果是模型名称,则会在 https://huggingface.co/ 下载模型 模型的下载位置为 EMBEDDING_MODEL_PATH
8282
EMBEDDING_MODEL_NAME: /opt/maxkb/model/shibing624_text2vec-base-chinese
8383
```
8484

@@ -104,8 +104,8 @@
104104
### 4.2 启动后端
105105

106106
!!! Abstract ""
107-
后端系统，需要启动 web服务、本地模型服务、和异步任务队列服务。
108-
注意: 在项目根目录执行
107+
后端系统，需要启动 web服务、本地模型服务、和异步任务队列服务。
108+
注意：在项目根目录执行
109109

110110
!!! Abstract ""
111111
在 MaxKB 项目根目录下依次执行以下命令，启动 Web 服务。

‎docs/faq/GPU_runOllama.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 如何让Ollama使用GPU运行LLM模型
1+
# 如何让 Ollama 使用 GPU 运行 LLM 模型
22

33
!!! Abstract ""
44
以 NVIDIA 为例，说明 Ollama GPU 模式运行大模型的具体操作。

‎docs/faq/MaxKB VS.Dify.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
MaxKB 和 Dify 都是基于大语言模型技术的开源项目，两者在产品定位以及能力上存在差异：
44

55
- 产品定位不同：Dify 定位于大模型应用的开发平台，属于中间件范畴；MaxKB 定位于基于大模型和 RAG 的智能问答助手，属于开箱即用的最终应用。
6-
- 产品能力对比：以下表格是 Dify 官方提供的与 LangChain、Flowise 等产品的能力对比；MaxKB 是基于LangChain构建的应用，并补齐了 LangChain 在 Workflow 和 SSO 等企业级功能上面的空白。
6+
- 产品能力对比：以下表格是 Dify 官方提供的与 LangChain、Flowise 等产品的能力对比；MaxKB 是基于 LangChain 构建的应用，并补齐了 LangChain 在 Workflow 和 SSO 等企业级功能上面的空白。
77

88
<table style="width: 100%;height: 80%;">
99
<tr>

‎docs/faq/Offline_install_OllamaModel.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 如何使用Ollama离线部署LLM大语言模型
1+
# 如何使用 Ollama 离线部署 LLM 大语言模型
22

33

44
!!! Abstract ""

‎docs/faq/doc_segment.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
!!! Abstract ""
1111

12-
MaxKB默认的切分规则，本质上是按照特定的正则表达式进行切分，除此之外在高级分段规则中还支持手动输入正则表达式进行切分，这样就可以根据文档规律的表达方式进行合理地分段。
12+
MaxKB 默认的切分规则，本质上是按照特定的正则表达式进行切分，除此之外在高级分段规则中还支持手动输入正则表达式进行切分，这样就可以根据文档规律的表达方式进行合理地分段。
1313

1414
## 1 常见分段标识及其正则表达
1515

@@ -26,7 +26,7 @@
2626

2727
!!! Abstract ""
2828

29-
将上传文档后，如果选择默认的分段规则，无法都无法获得立项的效果。
29+
将上传文档后，如果选择默认的分段规则，分段预览效果不佳，可以使用高级分段。
3030
![doc](../img/FAQ/doc_default_split.png)
3131
![doc](../img/FAQ/doc_advance_split.png)
3232

‎docs/faq/function_library.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
!!! Abstract ""
88
函数库运行时提示缺少依赖，是因为某些函数库在运行时需要调用其他第三方库来完成特定功能。如果这些第三方库未安装，函数库就无法正常运行，从而提示缺少依赖。
9-
进入 maxkb 容器 ：
9+
进入 MaxKB 容器 ：
1010
```
1111
docker exec -it maxkb bash
1212
```

‎docs/faq/knowledge_base.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
## 3 文档提交成功，但未显示上传的文档
4242

4343
!!! Abstract ""
44-
文档提交成功后未显示上传的文档，可能是反向代理的请求大小配置不，增加代理配置后可解决此问题。
44+
文档提交成功后未显示上传的文档，可能是反向代理的请求大小配置太小，增加代理配置后可解决此问题。
4545

4646
## 4 知识库以 ZIP 格式导出再导入时分段数不一致
4747

@@ -51,7 +51,7 @@
5151
## 5 知识库上传文档后，文档标题乱码
5252

5353
!!! Abstract ""
54-
的压缩软件导致问题。已知 WinRAR 和 52 压缩存在兼容性问题，建议使用其他压缩软件进行压缩和解压操作。
54+
压缩软件导致问题。已知 WinRAR 和 52 压缩存在兼容性问题，建议使用其他压缩软件进行压缩和解压操作。
5555

5656
## 6 向量化成功，但生成问题失败
5757

‎docs/faq/system_management.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
```
2424
psql -Uroot
2525
```
26-
进入 maxkb数据库
26+
进入 MaxKB 数据库
2727
```
2828
\c maxkb;
2929
```
@@ -67,7 +67,7 @@
6767

6868
!!! Abstract ""
6969
**确保服务可访问：**
70-
MaxKB 容器需要可正常访问 Ollama 服务。在 maxkb 容器中访问 Ollama 的 API 域名，确保返回 【Ollama is running 】的状态。
70+
MaxKB 容器需要可正常访问 Ollama 服务。在 MaxKB 容器中访问 Ollama 的 API 域名，确保返回 【Ollama is running】的状态。
7171

7272
![doc](../img/FAQ/ollama可访问.png){width="900px"}
7373

@@ -77,7 +77,7 @@
7777

7878
!!! Abstract ""
7979
**以上确认无误后，再到 MaxKB 中 添加 Ollama 的模型。
80-
对于 Window 环境安装 Ollama 可进一步参考：[Windows 系统本地部署 Ollama +MaxKB 安装教程](https://kb.fit2cloud.com/?p=349d848b-7a0a-421b-8029-38e0440f35d4)。**
80+
对于 Window 环境安装 Ollama 可进一步参考：[Windows 系统本地部署 Ollama + MaxKB 安装教程](https://kb.fit2cloud.com/?p=349d848b-7a0a-421b-8029-38e0440f35d4)。**
8181

8282

8383

‎docs/instructional_video.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
## 3 功能演示
1313

14-
[![功能演示-模型管理](./img/video/模型管理.png){ width="300"}](https://www.bilibili.com/video/BV1gAmHYMEHb?spm_id_from=333.788.videopod.sections&vd_source=2be54e435e136941c6aab6077b8fc303)
14+
[![功能演示-模型管理](./img/video/模型管理.png){ width="300"}](https://www.bilibili.com/video/BV18JypYeEkj?spm_id_from=333.788.videopod.sections)
1515
[![功能演示-知识库](./img/video/知识库.png){ width="300"}](https://www.bilibili.com/video/BV1SAmHYTEnM?spm_id_from=333.788.videopod.sections&vd_source=2be54e435e136941c6aab6077b8fc303)
1616
[![功能演示-函数库](img/video/函数库.png){ width="300"}](https://www.bilibili.com/video/BV1MKmHYKEbk?spm_id_from=333.788.videopod.sections&vd_source=2be54e435e136941c6aab6077b8fc303) </br>
1717

0 commit comments

Comments
 (0)