From da95b8f198ccf33f88badfed741e40d01caa6121 Mon Sep 17 00:00:00 2001 From: RockChinQ <1010553892@qq.com> Date: Sun, 18 Feb 2024 21:13:47 +0800 Subject: [PATCH] =?UTF-8?q?perf:=20=E5=AE=8C=E5=96=84=E9=83=A8=E7=BD=B2?= =?UTF-8?q?=E6=95=99=E7=A8=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/posts/deploy/config.md | 109 ++++++++++----------------- src/posts/deploy/platforms/README.md | 18 ++--- src/posts/deploy/qchatgpt/manual.md | 6 +- 3 files changed, 47 insertions(+), 86 deletions(-) diff --git a/src/posts/deploy/config.md b/src/posts/deploy/config.md index f9cafe752..879a5e465 100644 --- a/src/posts/deploy/config.md +++ b/src/posts/deploy/config.md @@ -9,55 +9,19 @@ author: Lazy date: 2024-02-18 --- - - -为了快速上手，你需要重点关注以下文件： +修改以下配置文件即可启用 QChatGPT 的基本功能，更多的配置项详解请查看[配置详解](../config-intro.md)。 - `data/config/platform.json` - `data/config/provider.json` -## 配置消息平台platform.json +## platform.json -配置data/config/platform.json +修改此配置文件以指定需要连接的消息平台，只需要关注`platform-adapters`字段。 +目前支持 `mirai`、`go-cqhttp`、`aiocqhttp`、`qq-botpy` 四种消息平台适配器，也可以同时启用多个同种类或不同种类的平台适配器 -```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" - ] -} -``` +### YiriMirai 适配器 -截至2024年2月13日，目前支持`mirai`、`go-cqhttp`、`aiocqhttp`、`QQ官方机器人`，支持同时开启多个消息适配器，甚至四个全开 - -#### 接入mirai +用于接入 Mirai。 ```json { @@ -72,9 +36,9 @@ date: 2024-02-18 `"adapter": "yiri-mirai"`，无需动，表明是接入`mirai`的配置 -`enable`：是否启用，`true`开启 +`enable`：是否启用，配置完成后请将其设为`true` -`host`：主机地址，一般不动 +`host`：运行 mirai 的主机地址，一般不改动 `port`：设置端口，默认8080，与`mirai-api-http`里面设置的保持一致 @@ -82,7 +46,9 @@ date: 2024-02-18 `qq`：设置机器人QQ号，与当前mirai登录的机器人的QQ号保持一致 -#### 接入go-cqhttp +### Nakuru 适配器 + +用于接入 go-cqhttp。 ```json { @@ -95,11 +61,11 @@ date: 2024-02-18 }, ``` -`"adapter": "nakuru",`，无需动，表明是接入`go-cqhttp`的配置 +`"adapter": "nakuru"`，无需动，表明是接入`go-cqhttp`的配置 -`enable`：是否启用，`true`开启 +`enable`：是否启用，配置完成后请将其设为`true` -`host`：主机地址，一般不动 +`host`：运行 go-cqhttp 的主机地址，一般不改动 `ws_port`：正向WS服务器监听地址，与`go-cqhttp`的`config.yml`里面的保持一致 @@ -107,7 +73,9 @@ date: 2024-02-18 `token`：验证密钥，，与`go-cqhttp`的`config.yml`里面的保持一致 -#### 接入shamrock等onebot协议实现的机器人框架 +### aiocqhttp 适配器 + +用于接入 Shamrock 等兼容 OneBot 协议的机器人框架（仅支持反向ws）。 ```json { @@ -118,15 +86,17 @@ date: 2024-02-18 }, ``` -`"adapter": "aiocqhttp",`，无需动，表示是接入`shamrock等onebot协议实现的机器人框架`的配置 +`"adapter": "aiocqhttp"`，无需动，表示是接入`shamrock等onebot协议实现的机器人框架`的配置 -`enable`：是否启用，`true`开启 +`enable`：是否启用，配置完成后请将其设为`true` -`host`：主机地址，一般不动 +`host`：监听的 IP 地址，使用 aiocqhttp 时，QChatGPT 作为服务端被动等待框架连接，请在 Shamrock 等框架中设置为运行 QChatGPT 的主机的 IP 地址，如果是同一个主机，保持设置为 `127.0.0.1` 即可 -`port`：设置端口，默认8080，与对应框架里面设置的保持一致 +`port`：设置监听的端口，默认8080，需在 Shamrock 等框架中设置为与此处一致的端口 -#### 接入QQ官方机器人 +### qq-botpy 适配器 + +用于接入 QQ 官方机器人 API。 ```json { @@ -141,27 +111,19 @@ date: 2024-02-18 } ``` -`"adapter": "qq-botpy",`，无需动，表明是接入`QQ官方机器人`的配置 +`"adapter": "qq-botpy"`，无需动，表明是接入`QQ官方机器人`的配置 -`enable`：是否启用，`true`开启 +`enable`：是否启用，配置完成后请将其设为`true` `appid`：申请到的QQ官方机器人的appid `secret`：申请到的QQ官方机器人的secret -`intents`：控制监听的事件类型，`public_guild_messages` 频道消息`direct_message` 频道私聊消息 `public_messages` Q群消息（需要权限） +`intents`：控制监听的事件类型：`public_guild_messages` 频道消息`direct_message` 频道私聊消息 `public_messages` Q群消息（需要权限） -## 配置 AI 模型provider.json +## provider.json -配置data/config/provider.json - -配置提供AI聊天接口的信息 - -```json -"enable-chat": true, -``` - -`enable-chat`：是否开启AI聊天功能 +修改此配置文件以设置所连接的 AI 提供商的相关信息，仅讲解必要的配置项，更多的配置项详解请查看[配置详解](../config-intro.md)。 ```json "openai-config": { @@ -176,18 +138,23 @@ date: 2024-02-18 }, ``` -`api-keys`：以列表的形式设置若干个api key，例如： +`api-keys`：支持以列表的形式设置若干个api key，例如： ```json "api-keys": [ - "sk-1234567890", + "sk-1234567890", "sk-23452354253", "sk-2352453674" ], ``` -`base_url`：设置接口地址，后面一定要加`/v1` +`base_url`：设置接口地址，如果你从第三方购买了key，或者需要使用反向代理时才需要修改这个参数，后面一定要加`/v1` -`model`：选择模型 +`model`：填写要使用的模型名称。通常来说直接填写模型名称即可，但如果要使用原生接口不是 ChatCompletion 但以 ChatCompletion 接口格式接入的模型，请在模型名称前方加一个 `OneAPI/` 前缀以进行区分。 +简单来说可以认为是：现阶段非 OpenAI 的模型接入都需要在模型名称前方加一个 `OneAPI/` 前缀。 + +例如： +1. 通过 OneAPI 等中转服务接入了 OpenAI 的 `gpt-4` 模型，由于 `gpt-4` 也是使用 ChatCompletion 接口格式进行请求，则可以直接填入 `gpt-4`； +2. 通过 OneAPI 等中转服务接入了 Google 的 `gemini-pro` 模型，由于 `gemini-pro` 原生接口格式并非 ChatCompletion，因此需要填入 `OneAPI/gemini-pro`。 `request-timeout`：设置请求超时时间，以秒为单位，对于耗时较长的模型(如GPT4)，建议设置较大值 \ No newline at end of file diff --git a/src/posts/deploy/platforms/README.md b/src/posts/deploy/platforms/README.md index 61246e852..c2833dba5 100644 --- a/src/posts/deploy/platforms/README.md +++ b/src/posts/deploy/platforms/README.md @@ -16,20 +16,12 @@ index: false ## 可选的平台 -以下平台任选（支持同时使用多平台）： +以下平台任选，也可以配置多个，QChatGPT支持同时接入一个或多个平台： -- mirai -- go-cqhttp -- shamrock -- QQ官方机器人 - -## [mirai部署教程](mirai.md) - -## [go-cqhttp部署教程](gocq.md) - -## [shamrock部署教程](shamrock.md) - -## [QQ官方机器人部署教程](official.md) +- Mirai（QQ）：[Mirai部署教程](mirai.md) +- go-cqhttp（QQ）：[go-cqhttp部署教程](gocq.md) +- Shamrock（QQ）：[Shamrock部署教程](shamrock.md) +- QQ官方机器人（QQ频道）：[QQ 官方 API 部署教程](official.md) ## 本项目交流 QQ 群 diff --git a/src/posts/deploy/qchatgpt/manual.md b/src/posts/deploy/qchatgpt/manual.md index f3f9bd835..ae4423057 100644 --- a/src/posts/deploy/qchatgpt/manual.md +++ b/src/posts/deploy/qchatgpt/manual.md @@ -46,11 +46,11 @@ pip3 install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple som python3 main.py ``` -> 如果输入上面的指令无反应，并且你确认你已经装了python，则输入`python main.py`，下同 +> 如果输入上面的指令无反应，并且你确认你已经装了python，则可以尝试使用`python main.py`，总之`python`是你启动的python的命令，可以使用 `python --version` 查看你的python版本。 提示如下信息 -```bash +``` ___ ___ _ _ ___ ___ _____ / _ \ / __| |_ __ _| |_ / __| _ \_ _| @@ -71,3 +71,5 @@ python3 main.py - data/config/sensitive-words.json - data/scenario/default.json ``` + +接下来请查看部署消息平台页。