doc: 优化文档

This commit is contained in:
Rock Chin
2022-12-17 17:51:05 +08:00
parent a2d34b53de
commit d0c9813272
+6 -6
View File
@@ -1,4 +1,4 @@
# QChatGPT # QChatGPT🤖
- 测试号: 2196084348 - 测试号: 2196084348
- 交流、答疑群: 204785790 - 交流、答疑群: 204785790
@@ -9,7 +9,7 @@
通过调用OpenAI GPT-3模型提供的Completion API来实现一个更加智能的QQ机器人 通过调用OpenAI GPT-3模型提供的Completion API来实现一个更加智能的QQ机器人
## 功能 ## 功能
以下是功能特色,点击展开查看具体使用方法 以下是功能特色,点击展开查看具体使用方法
@@ -67,13 +67,13 @@
- 运行期间可使用`!reset` `!list` `!last` `!next` `!prompt`等指令管理会话 - 运行期间可使用`!reset` `!list` `!last` `!next` `!prompt`等指令管理会话
</details> </details>
## 技术栈 ## 💻技术栈
- [Mirai](https://github.com/mamoe/mirai) 高效率 QQ 机器人支持库 - [Mirai](https://github.com/mamoe/mirai) 高效率 QQ 机器人支持库
- [YiriMirai](https://github.com/YiriMiraiProject/YiriMirai) 一个轻量级、低耦合的基于 mirai-api-http 的 Python SDK。 - [YiriMirai](https://github.com/YiriMiraiProject/YiriMirai) 一个轻量级、低耦合的基于 mirai-api-http 的 Python SDK。
- [OpenAI API](https://openai.com/api/) OpenAI API - [OpenAI API](https://openai.com/api/) OpenAI API
## 项目结构 ## 🧱项目结构
- `pkg.database` 数据库操作相关 - `pkg.database` 数据库操作相关
- 数据库用于存放会话的历史记录,确保在程序重启后能记住对话内容 - 数据库用于存放会话的历史记录,确保在程序重启后能记住对话内容
@@ -82,7 +82,7 @@
- `pkg.qqbot` QQ机器人相关 - `pkg.qqbot` QQ机器人相关
- 处理QQ收到的消息,调用API并进行回复 - 处理QQ收到的消息,调用API并进行回复
## 部署 ## 🔩部署
**部署过程中遇到任何问题,请先在[QChatGPT](https://github.com/RockChinQ/QChatGPT/issues)或[qcg-installer](https://github.com/RockChinQ/qcg-installer/issues)的issue里进行搜索** **部署过程中遇到任何问题,请先在[QChatGPT](https://github.com/RockChinQ/QChatGPT/issues)或[qcg-installer](https://github.com/RockChinQ/qcg-installer/issues)的issue里进行搜索**
@@ -165,7 +165,7 @@ python3 main.py
</details> </details>
## 使用 ## 🚀使用
### 私聊使用 ### 私聊使用