diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 000000000..2a674a54f --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,50 @@ +name: 部署文档 + +on: + push: + branches: + - main + +permissions: + contents: write + +jobs: + deploy-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: 设置 Node.js + uses: actions/setup-node@v3 + with: + node-version: 18 + + - name: 安装 pnpm + run: | + npm install -g pnpm + + - name: 安装依赖 + run: + pnpm install + + - name: 构建文档 + env: + NODE_OPTIONS: --max_old_space_size=8192 + run: |- + pnpm run docs:build + + - name: 部署文档 + uses: cross-the-world/scp-pipeline@master + env: + WELCOME: "ssh scp ssh pipelines" + LASTSSH: "Doing something after copying" + with: + host: ${{ secrets.SERVER_HOST }} + user: ${{ secrets.SERVER_NAME }} + pass: ${{ secrets.PASSWD }} + connect_timeout: 100s + local: './src/.vuepress/dist/*' + remote: ${{ secrets.TARGET }} diff --git a/.gitignore b/.gitignore index 7924c938e..411fb0d34 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,3 @@ node_modules/ src/.vuepress/.cache/ src/.vuepress/.temp/ src/.vuepress/dist/ -.github/ \ No newline at end of file diff --git a/README.md b/README.md index f09340ddb..3079bab05 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ > 此分支是 QChatGPT 3.0 的文档 -> [QChatGPT 代码仓库](https://github.com/RockChinQ/QChatGPT/tree/feat/asyncio) +> [QChatGPT 代码仓库](https://github.com/RockChinQ/QChatGPT/tree/feat/asyncio) > [本文档地址](https://github.com/the-lazy-me/QChatGPT-Wiki/tree/doc/v3) ## 参与编写 @@ -29,7 +29,6 @@ pnpm docs:dev ### 一些规范化标准 -- 除去`posts`文件夹是用名词复数，其余名词一律使用单数 - 文件夹和文件的命名：**一律使用全小写，单词直接`-`隔开，如**`config-intro.md` - 子文件（夹）的命名，**不加前缀**（即文件夹的名称），如：`plugin`文件夹下的，插件列表（文件）称之为`list.md`，文件夹`some-plugin-deploy` - 由于这是有关于文档的规范化命名，所以任何文件的名称都可以以教程的角度来理解，如`plugin`是有关插件的教程 diff --git a/src/.vuepress/navbar.ts b/src/.vuepress/navbar.ts index cd15fdad7..79a6687d6 100644 --- a/src/.vuepress/navbar.ts +++ b/src/.vuepress/navbar.ts @@ -10,7 +10,7 @@ export default navbar([ { text: "部署教程", icon: "blog", - link: "/posts/deploy", + link: "/posts/deploy/", }, // "/posts/deploy/", // "/posts/Features", diff --git a/src/.vuepress/sidebar.ts b/src/.vuepress/sidebar.ts index 580381f42..0f6449e7f 100644 --- a/src/.vuepress/sidebar.ts +++ b/src/.vuepress/sidebar.ts @@ -21,21 +21,21 @@ export default sidebar({ icon: "support", link: "manual", }, - { - text: "安装器部署(Win)(不推荐，长时间未维护)", - icon: "list", - link: "auto-app-win", - }, - { - text: "Docker部署(仅推荐在Linux上使用)", - icon: "list", - link: "auto-docker", - }, - { - text: "安装器部署(Linux)(不推荐，已经长时间未维护)", - icon: "list", - link: "auto-app-linux", - }, + // { + // text: "安装器部署(Win)(不推荐，长时间未维护)", + // icon: "list", + // link: "auto-app-win", + // }, + // { + // text: "Docker部署(仅推荐在Linux上使用)", + // icon: "list", + // link: "auto-docker", + // }, + // { + // text: "安装器部署(Linux)(不推荐，已经长时间未维护)", + // icon: "list", + // link: "auto-app-linux", + // }, ], }, { diff --git a/src/posts/config-intro.md b/src/posts/config-intro.md index 6e47c328e..615d83ca8 100644 --- a/src/posts/config-intro.md +++ b/src/posts/config-intro.md @@ -1,6 +1,6 @@ --- title: QChatGPT的详细配置解读 -icon: info +icon: context # 这是侧边栏的顺序 order: 3 # 设置作者 diff --git a/src/posts/deploy/README.md b/src/posts/deploy/README.md index f4e45dabe..daf5dd79d 100644 --- a/src/posts/deploy/README.md +++ b/src/posts/deploy/README.md @@ -19,26 +19,15 @@ index: false > 全平台通用，可以避免安装器部署失败的问题 - [ 点击查看手动部署的具体操作](manual.md) -## 自动化部署 -:::tip -Windows首选[安装器](#windows)，Linux首选[Docker](#docker) -::: -### 安装器（不推荐） -> 部署过程最简单，但有一定失败概率 - -安装器可在Windows和Linux平台下使用 -- [ 点击查看Windows的具体操作](auto-app-win.md) - -- [ 点击查看Linux的具体操作](auto-app-linux.md) -### Docker（Linux推荐） -> docker方式较为复杂，若您不熟悉docker的操作及相关知识，强烈建议您使用其他方式部署，我们不会且难以解决您主机上多个容器的连接问题。 -- [ 点击查看Docker部署的具体操作](auto-docker.md) - ## 本项目交流 QQ 群 ### 社区群 -Lazy的交流群二：738382634 [链接](https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=T8rXTa9K4Iypw7pKzLqshQ9Yaumey0lz&authKey=yKfFqnoWk2diU73tEqLnKeqhR0%2BKzB9rOVa0dIjUqm6SOlJvZWNp3XmkkPENmw9m&noverify=0&group_code=738382634) +Lazy的交流群一：891448839（已满） + +Lazy的交流群二：738382634（已满） + +Lazy的交流群三：248432104 ### 官方群 diff --git a/src/posts/deploy/auto-app-linux.md b/src/posts/deploy/auto-app-linux.md deleted file mode 100644 index 4c2728ab1..000000000 --- a/src/posts/deploy/auto-app-linux.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -head: - - - meta - - name: keywords - content: ChatGPT QQ机器人教程，QChatGPT项目部署教程 -title: 安装器部署(Linux)(不推荐，已经长时间未维护) -icon: linux -order: Lazy,ikun -date: 2023-10-28 -category: - - 部署教程 ---- -:::info 目录 -[[toc]] -::: - -:::tip 建议配合视频使用 - -::: - -## 第一步：下载安装器文件 - -在根目录输入以下指令创建一个文件夹（bot 为文件夹的名字，随便起） - -```terminal -mkdir bot -``` - -然后输入指令进入 bot 文件夹（bot 切换为你起的名字） - -```terminal -cd bot -``` - -创建一个 screen 窗口，命名为 bot，可以随便 - -```terminal -screen -S bot -``` - -然后输入以下指令下载安装器文件 - -```terminal -wget https://github.com/RockChinQ/qcg-installer/releases/download/v0.13.2/qcg-installer-linux-amd64 -``` - -## 第二步：运行安装器 - -依次执行以下命令 - -```terminal -sudo chmod -R 777 qcg-installer-linux-amd64 -``` - -```terminal -./qcg-installer-linux-amd64 -``` - -耐心等待，可能需要半个小时，直至如图界面 - -![图1](https://s2.loli.net/2023/08/11/j5DnQPVCYh1sJ78.jpg) - -输入你的 api_key 并回车，然后输机器人 QQ 号再回车 - -## 第三步：配置签名服务器 - -打开这个网页，点击 release，点击下载 zip 压缩包 - -[https://github.com/MrXiaoM/qsign](https://github.com/MrXiaoM/qsign) - -将下载好的压缩包解压后里面会有两个文件夹，其中 plugins 文件夹里面的 jar 包上传到 mirai 文件夹下的 plugins 文件夹 - -![图2](https://s2.loli.net/2023/08/11/KiJQozRlPDdtBUs.png) - -txlib 文件夹上传到 mirai 文件夹下 - -![图3](https://s2.loli.net/2023/08/11/OD8C9Fa156BugcT.png) - -## 第四步：登录 - -手机上打开这个网页 - -[https://github.com/KasukuSakura/mirai-login-solver-sakura](https://github.com/KasukuSakura/mirai-login-solver-sakura) - -点击 release，点击下载 apk-release.apk 文件，然后安装 - -返回到 FinalShell，输入以下指令 - -```terminal -./run-mirai.sh -``` - -耐心等待，然后输入，其中 123456 是替换为你机器人的 QQ 号，67890 替换为你机器人 QQ 的密码 - -```terminal -login 12345 67890 -``` - -回车后可以看到这些提示 - -![图4](https://s2.loli.net/2023/08/11/MymgAkDBQU4NpE9.jpg) - -输入这个命令并回车 - -```terminal -TxCaptchaHelper -``` - -然后可以看到提示要在手机端输入请求码，这时打开刚才手机上安装的软件，输入请求码，点击下一步，验证完成后，可以在 FinalShell 上看到提示是否要发送验证码 - -![图5](https://s2.loli.net/2023/08/11/bI5jzOyGvCiUhTV.jpg) - -输入指令并回车 - -```terminal -yes -``` - -稍后填入手机收到的验证码 - -这时可以看到就登录成功了 - -点击蓝色界面，然后按快捷键 CTRL+a+c（先按下 ctrl+a 不放，再按 c），可以看到新建了一个窗口，输入指令 - -```terminal -./run-bot.sh -``` - -然后会提示输入管理员 QQ - -然后就可以成功与机器人对话了，私聊直接发信息，群聊需要@ - -## 第五步：反向代理 - -当然，目前使用仍然需要代理或要求你的服务器在国外，否则就会报超时错误，但是考虑到不一定有海外服务器或方便设置全局代理，我们可以通过设置反向代理来解决 -具体操作：打开QChatGPT文件夹下的config.py文件（可以用记事本或VScode等任何代码编辑器） -找到这一行，在你填写API_Key的附近 -``` -"reverse_proxy": None -``` -将这行代码改为 -``` -"reverse_proxy": "双引号里面写你的反代地址" -``` -若使用[**本UP主**](https://space.bilibili.com/407410594)免费提供的反代地址请输入为`"reverse_proxy": "http://api.openai.lazyshare.top/v1"`，反代地址不一定长久有效，且用且珍惜 -设置完成后应是如图情况 -![反代设置.jpg](https://s2.loli.net/2023/08/16/GeoiZCbLtfg3uqH.jpg) -然后记得保存，并重新运行run-bot - -## 补充：Linux部署时报错 - -### GLIBC 2.XX缺乏 -通常此情况发生于基于Red Hat的系统，例如CentOS - -这是由于glibc依赖版本不足导致的，此时并不建议去升级glibc。，glibc版本升级可能导致操作系统无法使用，所以请务必谨慎操作，先在同版本操作系统系统模拟测试，将glibc新版本所依赖的软件完成升级后再行升级。 - -这种情况下，建议使用手动部署 -教程请看项目仓库，[点击跳转](./manual.md) diff --git a/src/posts/deploy/auto-app-win.md b/src/posts/deploy/auto-app-win.md deleted file mode 100644 index c0f04176e..000000000 --- a/src/posts/deploy/auto-app-win.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -head: - - - meta - - name: keywords - content: ChatGPT QQ机器人教程，QChatGPT项目部署教程 -title: 安装器部署(Win)(不推荐，长时间未维护) -icon: windows -order: 1 -author: Lazy,ikun -date: 2023-09-30 -category: - - 部署教程 ---- -:::info 目录 -[[toc]] -::: - -:::tip 建议配合视频使用 - -::: - - -## 第一步：下载一键安装器 - -打开这个网页 - -[https://github.com/RockChinQ/qcg-installer](https://github.com/RockChinQ/qcg-installer) - -点击 release，点击下载 exe 文件，保存到一个合适位置 - -双击刚才的 exe 文件，程序即可自动加载 - -如果速度过慢，可以关闭该窗口，删除多出来的 python 文件夹，在文件夹空白处右击，在终端中打开，输入以下指令 - -```terminal -.\qcg-installer-windows-amd64.exe -p http://localhost:7890 -``` - -> 这里的 `http://localhost:7890` 是你的代理地址，请根据自己的情况修改。具体请参考 [qcg-installer](https://github.com/RockChinQ/qcg-installer) - -耐心等待，程序将自动运行至提示输入OpenAI api_key，这时输入你的 api_key 并回车，获取 api_key 链接在这里 - -[https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys) - -然后输入你机器人的 QQ 号并回车 - -## 第二步：配置签名服务器 - -打开这个网页，点击 release，点击下载 zip 压缩包 - -[https://github.com/MrXiaoM/qsign](https://github.com/MrXiaoM/qsign) - -将下载好的压缩包解压后里面会有两个文件夹，其中 plugins 文件夹里面的 jar 包放到到 mirai 文件夹下的 plugins 文件夹，txlib 文件夹移动到 mirai 文件夹，如图所示 - -![图1](https://s2.loli.net/2023/08/11/vH4u7jlYCt1iKEG.png) - -![图2](https://s2.loli.net/2023/08/11/bC2ZapYwjMAErq4.png) - -## 第三步：登录 - -手机上打开这个网页 - -[https://github.com/KasukuSakura/mirai-login-solver-sakura](https://github.com/KasukuSakura/mirai-login-solver-sakura) - -点击 release，下载 apk-release.apk 文件，然后安装 - -双击 run-mirai.bat，耐心等待，然后输入，其中 123456 是替换为你机器人的 QQ 号，67890 替换为你机器人 QQ 的密码 - -```terminal -login 12345 67890 -``` - -然后输入 - -```terminal -TxCaptchaHelper -``` - -回车后可以看到弹窗提示，点击第二个，弹出二维码，打开手机刚才下载的软件，点击扫描二维码，验证完成后，可以看到电脑提示验证，选择短信验证，然后输入收到的验证码，点击确定即可成功登录 -如果没有弹窗提示，可以看到终端提示要在手机端输入识别码，打开手机刚才下载的软件，输入，验证通过后，可以看到电脑提示要发送短信验证码，输入` yes `后回车，然后输入手机收到的短信验证码，回车后就可以看到登录成功了 - -然后点击 run-bot.bat，可以看到提示登录成功了，这时就可以给你的机器人发送消息了，私聊直接发送，群聊需要@ -## 第四步：反向代理 - -当然，目前使用仍然需要全局代理，但考虑到总是全局代理不方便，我们可以通过设置反向代理来解决 -具体操作：打开QChatGPT文件夹下的config.py文件（可以用记事本或VScode等任何代码编辑器） -找到这一行，在你填写API_Key的附近 -``` -"reverse_proxy": None -``` -将这行代码改为 -``` -"reverse_proxy": "双引号里面写你的反代地址" -``` -若使用[**本UP主**](https://space.bilibili.com/407410594)免费提供的反代地址请输入为`"reverse_proxy": "http://api.openai.lazyshare.top/v1"`，反代地址不一定长久有效，且用且珍惜 -设置完成后应是如图情况 -![反代设置.jpg](https://s2.loli.net/2023/08/16/GeoiZCbLtfg3uqH.jpg) -然后记得保存，并重新运行run-bot - - - \ No newline at end of file diff --git a/src/posts/deploy/auto-docker.md b/src/posts/deploy/auto-docker.md deleted file mode 100644 index 7c98c21ab..000000000 --- a/src/posts/deploy/auto-docker.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -head: - - - meta - - name: keywords - content: ChatGPT QQ机器人教程，QChatGPT项目部署教程 -title: Docker部署(仅推荐在Linux上使用) -icon: warn -order: 4 -author: Lazy,ikun -date: 2023-10-28 -category: - - 部署教程 ---- - - -:::warning -请您确保您**确实**需要 Docker 部署，您**必须**具有以下能力： - - 了解 `Docker` 和 `Docker Compose` 的使用 - - 了解容器间网络通信配置方式 - - 了解容器文件挂载机制 - - 了解容器调试操作 - - 动手能力强、资料查找能力强 - - 若您不完全具有以上能力，请勿使用 Docker 部署，由于误操作导致的配置不正确，我们将不会解答您的问题并不负任何责任。 - **非常不建议**您在除 Linux 之外的系统上使用 Docker 进行部署。 -::: - -:::info 目录 -[[toc]] -::: - -## 概览 - -QChatGPT 主程序需要连接`QQ登录框架`以与QQ通信，您可以选择 [Mirai](https://github.com/mamoe/mirai)（还需要配置mirai-api-http，请查看此仓库README中手动部署部分） 或 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp)，我们仅发布 QChatGPT主程序 的镜像，您需要自行配置QQ登录框架（可以参考[README.md](https://github.com/RockChinQ/QChatGPT#-%E9%85%8D%E7%BD%AEqq%E7%99%BB%E5%BD%95%E6%A1%86%E6%9E%B6)中的教程，或自行寻找其镜像）并在 QChatGPT 的配置文件中设置连接地址。 - -> **Note** -> 请先确保 Docker 和 Docker Compose 已安装 - -## 准备文件 - -> QChatGPT 目前暂不可以在没有配置模板文件的情况下自动生成文件，您需要按照以下步骤手动创建需要挂载的文件。 -> 如无特殊说明，模板文件均在此仓库中。 - -> 如果您不想挨个创建，也可以直接clone本仓库到本地，执行`python main.py`后即可自动根据模板生成所需文件。 - -现在请在一个空目录创建以下文件或目录： - -### 📄`config.py` - -复制根目录的`config-template.py`所有内容，创建`config.py`并根据其中注释进行修改。 - -### 📄`banlist.py` - -复制`res/templates/banlist-template.py`所有内容，创建`banlist.py`，这是黑名单配置文件，根据需要修改。 - -### 📄`cmdpriv.json` - -复制`res/templates/cmdpriv-template.json`所有内容，创建`cmdpriv.json`，这是各命令的权限配置文件，根据需要修改。 - -### 📄`sensitive.json` - -复制`res/templates/sensitive-template.json`所有内容，创建`sensitive.json`，这是敏感词配置，根据需要修改。 - -### 📄`tips.py` - -复制`tips-custom-template.py`所有内容，创建`tips.py`，这是部分提示语的配置，根据需要修改。 - -## 运行 - -已预先准备好`docker-compose.yaml`，您需要根据您的网络配置进行适当修改，使容器内的 QChatGPT 程序可以正常与 Mirai 或 go-cqhttp 通信。 - -将`docker-compose.yaml`复制到本目录，根据网络环境进行配置，并执行: - -```bash -docker compose up -``` - -若无报错即配置完成，您可以Ctrl+C关闭后使用`docker compose up -d`将其置于后台运行 - -## 注意 - -- 安装的插件都会保存在`plugins`(映射到本目录`plugins`)，安装插件时可能会自动安装相应的依赖，此时若`重新创建`容器，已安装的插件将被加载，但所需的增量依赖并未安装，会导致引入问题。您可以删除插件目录后重启，再次安装插件，以便程序可以自动安装插件所需依赖。 - - \ No newline at end of file diff --git a/src/posts/deploy/manual.md b/src/posts/deploy/manual.md index ec69454ef..eabd3d0cf 100644 --- a/src/posts/deploy/manual.md +++ b/src/posts/deploy/manual.md @@ -48,7 +48,7 @@ category: -## 配置主程序 +## 安装主程序 1. 克隆此项目（按照下方命令，需要安装 Git） 或 前往[Release](https://github.com/RockChinQ/QChatGPT/releases)页面下载最新版本的压缩包（推荐）并解压 @@ -75,20 +75,209 @@ pip3 install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple som python3 main.py ``` -4. 编辑配置文件`config.py` +> 如果输入上面的指令无反应，并且你确认你已经装了python，则输入`python main.py`，下同 -按照文件内注释填写配置信息，或者阅读[此页面](../config-intro.md)来学习如何配置信息 - -> Tips: 大多数情况下，你只需关注qq小号，OpenAI Key的配置和管理员QQ号的配置 - -5. 运行主程序 +提示如下信息 ```bash -python3 main.py + + ___ ___ _ _ ___ ___ _____ + / _ \ / __| |_ __ _| |_ / __| _ \_ _| +| (_) | (__| ' \/ _` | _| (_ | _/ | | + \__\_\\___|_||_\__,_|\__|\___|_| |_| + +⭐️开源地址: https://github.com/RockChinQ/QChatGPT +📖文档地址: https://q.rkcn.top + +以下文件不存在，已自动生成，请按需修改配置文件后重启： +- plugins/__init__.py +- plugins/plugins.json +- data/config/command.json +- data/config/pipeline.json +- data/config/platform.json +- data/config/provider.json +- data/config/system.json +- data/config/sensitive-words.json +- data/scenario/default.json ``` -> 如果输入上面的指令无反应，并且你确认你已经装了python，则输入`python main.py` +## 配置主程序 -无报错信息即为运行成功 +为了快速上手，你需要重点关注以下文件： -当你成功运行后，你需要开始阅读[此页面](../config-intro.md) +- `data/config/platform.json` +- `data/config/provider.json` + +### 配置data/config/platform.json + +```json +{ + "adapter": "yiri-mirai", + "enable": false, + "host": "127.0.0.1", + "port": 8080, + "verifyKey": "yirimirai", + "qq": 123456789 +}, +{ + "adapter": "nakuru", + "enable": false, + "host": "127.0.0.1", + "ws_port": 8080, + "http_port": 5700, + "token": "" +}, +{ + "adapter": "aiocqhttp", + "enable": false, + "host": "127.0.0.1", + "port": 8080 +}, +{ + "adapter": "qq-botpy", + "enable": false, + "appid": "", + "secret": "", + "intents": [ + "public_guild_messages", + "direct_message" + ] +} +``` + +截至2024年2月13日，目前支持`mirai`、`go-cqhttp`、`aiocqhttp`、`QQ官方机器人`，支持同时开启多个消息适配器，甚至四个全开 + +#### 接入mirai + +```json +{ + "adapter": "yiri-mirai", + "enable": false, + "host": "127.0.0.1", + "port": 8080, + "verifyKey": "yirimirai", + "qq": 123456789 +}, +``` + +`"adapter": "yiri-mirai"`，无需动，表明是接入`mirai`的配置 + +`enable`：是否启用，`true`开启 + +`host`：主机地址，一般不动 + +`port`：设置端口，默认8080，与`mirai-api-http`里面设置的保持一致 + +`verifyKey`：密钥，默认yirimirai，与`mirai-api-http`里面设置的保持一致 + +`qq`：设置机器人QQ号，与当前mirai登录的机器人的QQ号保持一致 + +#### 接入go-cqhttp + +```json +{ + "adapter": "nakuru", + "enable": false, + "host": "127.0.0.1", + "ws_port": 8080, + "http_port": 5700, + "token": "" +}, +``` + +`"adapter": "nakuru",`，无需动，表明是接入`go-cqhttp`的配置 + +`enable`：是否启用，`true`开启 + +`host`：主机地址，一般不动 + +`ws_port`：正向WS服务器监听地址，与`go-cqhttp`的`config.yml`里面的保持一致 + +`http_port`：http服务器监听地址，与`go-cqhttp`的`config.yml`里面的保持一致 + +`token`：验证密钥，，与`go-cqhttp`的`config.yml`里面的保持一致 + +#### 接入shamrock等onebot协议实现的机器人框架 + +```json +{ + "adapter": "aiocqhttp", + "enable": false, + "host": "127.0.0.1", + "port": 8080 +}, +``` + +`"adapter": "aiocqhttp",`，无需动，表示是接入`shamrock等onebot协议实现的机器人框架`的配置 + +`enable`：是否启用，`true`开启 + +`host`：主机地址，一般不动 + +`port`：设置端口，默认8080，与对应框架里面设置的保持一致 + +#### 接入QQ官方机器人 + +```json +{ + "adapter": "qq-botpy", + "enable": false, + "appid": "", + "secret": "", + "intents": [ + "public_guild_messages", + "direct_message" + ] +} +``` + +`"adapter": "qq-botpy",`，无需动，表明是接入`QQ官方机器人`的配置 + +`enable`：是否启用，`true`开启 + +`appid`：申请到的QQ官方机器人的appid + +`secret`：申请到的QQ官方机器人的secret + +`intents`：控制监听的事件类型，`public_guild_messages` 频道消息`direct_message` 频道私聊消息 `public_messages` Q群消息（需要权限） + + + +### 配置data/config/provider.json + +配置提供AI聊天接口的信息 + +```json +"enable-chat": true, +``` + +`enable-chat`：是否开启AI聊天功能 + +```json +"openai-config": { + "api-keys": [ + "sk-1234567890" + ], + "base_url": "https://api.openai.com/v1", + "chat-completions-params": { + "model": "gpt-3.5-turbo" + }, + "request-timeout": 120 +}, +``` + +`api-keys`：以列表的形式设置若干个api key，例如： + +```json +"api-keys": [ + "sk-1234567890", + "sk-23452354253", + "sk-2352453674" +], +``` + +`base_url`：设置接口地址，后面一定要加`/v1` + +`model`：选择模型 + +`request-timeout`：设置请求超时时间，以秒为单位，对于耗时较长的模型(如GPT4)，建议设置较大值