Skip to content

Commit 23abffd

Browse files
committed
描述文本优化
1 parent 8b656b0 commit 23abffd

File tree

5 files changed

+11
-10
lines changed

5 files changed

+11
-10
lines changed

docs/dev_manual/APIKey_chat.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
1-
# 应用API
2-
31
!!! Abstract ""
4-
MaxKB 支持提供系统应用 API 以及兼容 OpenAI 标准格式调用对话
2+
MaxKB 社区版提供系统应用 API 以及兼容 OpenAI 标准格式进行对话,专业版提供系统级别 API,详细情况见:[系统API ](../user_manual/X-Pack/system_API.md)
53

64
## 1 应用API
75

8-
### 1.1 打开swagger文档
6+
### 1.1 打开API文档
97

108
!!! Abstract ""
11-
在应用-概况-应用信息中复制并访问 swagger 地址。
9+
在应用信息中复制并访问 swagger 地址。
1210

1311
![API doc](../img/dev/app_swaagger.png)
1412

15-
### 1.2 API Key 认证
13+
### 1.2 API Key认证
1614

1715
![APIKEY](../img/dev/app_apikey.png)
1816

docs/installation/aliyun.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
- 您也可以自行购买阿里云服务器,并在选择镜像时搜索 **MaxKB**,即可快速选择镜像进行部署。
1515

16+
**注意:** 购买时请选择合适的实例规格,建议 4C/8G 及以上。
17+
1618
!!! Abstract "服务器优惠"
1719

1820
如果您还没有服务器,可以通过以下优惠链接购买阿里云服务器:

docs/quick_start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
![通义千问 APIkey](img/model/tongyi_model.png)
2525

2626
!!! Abstract ""
27-
不同的平台参数要求不同,其它供应商模型配置添加详情见:[模型管理-添加模型 ](./user_manual/model/model.md)
27+
不同的平台参数要求不同,其它供应商模型配置添加详情见各模型对接详细说明。
2828

2929

3030
## 3 创建知识库
@@ -173,7 +173,7 @@
173173
![嵌入第三方](<img/app/embed.png>)
174174

175175
!!! Abstract ""
176-
在专业版中,也可以接入企业微信、公众号、钉钉和飞书等应用,详细说明见:[X-Pack功能-应用接入 ](./user_manual/X-Pack/app.md)
176+
在专业版中,也可以接入企业微信、公众号、钉钉和飞书等应用,详细说明见:[X-Pack功能-应用接入 ](./user_manual/X-Pack/app_integrate.md)
177177

178178

179179

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11

22
# 外观设置
3+
34
!!! Abstract ""
4-
可设置系统的主题色、网站 logo、登录 logo、登录背景图、网站名称、slogan等,以及主页右上方用户手册、论坛求助、项目地址等平台信息的显示设置。
5+
MaxKB 专业版可设置系统的主题色、网站 logo、登录 logo、登录背景图、网站名称、slogan等,以及主页右上方用户手册、论坛求助、项目地址等平台信息的显示设置。
56

67
![主题设置](../../img/system/theme.png)

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ nav:
9494

9595
- 开发文档:
9696
- 开发环境搭建: dev_manual/dev_environment.md
97-
- 如何通过应用API KEY进行对话: dev_manual/APIKey_chat.md
97+
- 通过API KEY进行对话: dev_manual/APIKey_chat.md
9898
- 常见问题:
9999
- Ollama离线部署LLM模型: faq/Offline_install_OllamaModel.md
100100
- Ollama使用GPU运行LLM模型: faq/GPU_runOllama.md

0 commit comments

Comments
 (0)