QChatGPT/README.md

113 lines
3.2 KiB
Markdown
Raw Normal View History

2022-12-08 14:59:59 +08:00
# QChatGPT
2022-12-08 16:51:30 +08:00
通过调用OpenAI GPT-3模型提供的Completion API来实现一个更加智能的QQ机器人
2022-12-12 00:22:08 +08:00
2022-12-12 00:42:34 +08:00
- 回复符合上下文
2022-12-12 00:22:08 +08:00
- 支持敏感词过滤,避免账号风险
2022-12-12 00:42:34 +08:00
- 使用官方api不需要网络代理稳定快捷
- 组件少,部署方便,提供一键安装器
- 交流、答疑群: 204785790
2022-12-12 00:22:08 +08:00
- 提供测试机器人QQ: 960164003
2022-12-08 14:59:59 +08:00
## 技术栈
- [Mirai](https://github.com/mamoe/mirai) 高效率 QQ 机器人支持库
- [YiriMirai](https://github.com/YiriMiraiProject/YiriMirai) 一个轻量级、低耦合的基于 mirai-api-http 的 Python SDK。
- [OpenAI API](https://openai.com/api/) OpenAI API
## 项目结构
- `pkg.database` 数据库操作相关
2022-12-12 00:22:08 +08:00
- 数据库用于存放会话的历史记录,确保在程序重启后能记住对话内容
2022-12-08 14:59:59 +08:00
- `pkg.openai` OpenAI API相关
2022-12-09 23:30:44 +08:00
- 用于调用OpenAI的API生成回复内容
2022-12-08 14:59:59 +08:00
- `pkg.qqbot` QQ机器人相关
2022-12-09 23:30:44 +08:00
- 处理QQ收到的消息调用API并进行回复
2022-12-08 14:59:59 +08:00
2022-12-11 22:46:17 +08:00
## 部署
2022-12-11 21:27:50 +08:00
2022-12-11 22:46:17 +08:00
### 注册OpenAI账号
2022-12-11 21:27:50 +08:00
2022-12-11 22:46:17 +08:00
参考以下文章
2022-12-11 21:27:50 +08:00
2022-12-11 22:46:17 +08:00
> [只需 1 元搞定 ChatGPT 注册](https://zhuanlan.zhihu.com/p/589470082)
> [手把手教你如何注册ChatGPT超级详细](https://guxiaobei.com/51461)
2022-12-08 14:59:59 +08:00
2022-12-11 22:46:17 +08:00
注册成功后请前往[个人中心查看](https://beta.openai.com/account/api-keys)api_key
2022-12-12 00:22:08 +08:00
完成注册后,使用以下自动化或手动部署步骤
2022-12-09 23:30:44 +08:00
2022-12-11 22:46:17 +08:00
### 自动化部署
2022-12-08 14:59:59 +08:00
2022-12-11 22:46:17 +08:00
使用[此安装器](https://github.com/RockChinQ/qcg-installer)进行部署
- 此安装器目前仅支持Windows x64平台其他平台请手动部署
2022-12-08 14:59:59 +08:00
2022-12-11 22:46:17 +08:00
### 手动部署
<details>
<summary>手动部署适用于所有平台</summary>
2022-12-08 14:59:59 +08:00
2022-12-11 22:46:17 +08:00
- 请使用Python 3.9.x以上版本
- 请注意OpenAI账号额度消耗
- 每个账户仅有18美元免费额度如未绑定银行卡则会在超出时报错
- OpenAI收费标准默认使用的`text-davinci-003`模型 0.02美元/千字
2022-12-08 14:59:59 +08:00
2022-12-11 22:46:17 +08:00
#### 配置Mirai
2022-12-08 14:59:59 +08:00
按照[此教程](https://yiri-mirai.wybxc.cc/tutorials/01/configuration)配置Mirai及YiriMirai
启动mirai-console后使用`login`命令登录QQ账号保持mirai-console运行状态
2022-12-08 14:59:59 +08:00
2022-12-11 22:46:17 +08:00
#### 配置主程序
2022-12-08 14:59:59 +08:00
1. 克隆此项目
```bash
git clone https://github.com/RockChinQ/QChatGPT
2022-12-11 18:13:45 +08:00
cd QChatGPT
2022-12-08 14:59:59 +08:00
```
2. 安装依赖
```bash
2022-12-09 23:30:44 +08:00
pip3 install pymysql yiri-mirai openai colorlog func_timeout
2022-12-08 14:59:59 +08:00
```
3. 运行一次主程序,生成配置文件
```bash
2022-12-09 23:30:44 +08:00
python3 main.py
2022-12-08 14:59:59 +08:00
```
4. 编辑配置文件`config.py`
按照文件内注释填写配置信息
5. 运行主程序
2022-12-08 14:59:59 +08:00
```bash
2022-12-09 23:30:44 +08:00
python3 main.py
2022-12-08 14:59:59 +08:00
```
2022-12-11 18:13:45 +08:00
- 如提示安装`uvicorn`或`hypercorn`请*不要*安装这两个不是必需的目前存在未知原因bug
2022-12-10 17:54:35 +08:00
- 如报错`TypeError: As of 3.10, the *loop* parameter was removed from Lock() since it is no longer necessary`, 请参考 [此处](https://github.com/RockChinQ/QChatGPT/issues/5)
2022-12-08 15:02:31 +08:00
无报错信息即为运行成功
2022-12-11 22:46:17 +08:00
</details>
2022-12-08 15:02:31 +08:00
## 使用
### 私聊使用
1. 添加机器人QQ为好友
2. 发送消息给机器人,机器人即会自动回复
3. 可以通过`!help`查看帮助信息
2022-12-10 11:08:49 +08:00
<img alt="私聊示例" src="res/屏幕截图%202022-12-08%20150949.png" width="550" height="279"/>
2022-12-08 15:13:13 +08:00
2022-12-08 15:02:31 +08:00
### 群聊使用
1. 将机器人拉进群
2. at机器人并发送消息机器人即会自动回复
2022-12-08 15:13:13 +08:00
3. at机器人并发送`!help`查看帮助信息
<img alt="群聊示例" src="res/屏幕截图%202022-12-08%20150511.png" width="671" height="522"/>