From 4996e2b0b68b213728de9988113bf571442c2d29 Mon Sep 17 00:00:00 2001 From: Changhua Date: Fri, 17 Nov 2023 22:55:23 +0800 Subject: [PATCH] Update instructions --- README.MD | 103 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 73 insertions(+), 30 deletions(-) diff --git a/README.MD b/README.MD index dd75fa0..5387419 100644 --- a/README.MD +++ b/README.MD @@ -9,9 +9,10 @@ |后台回复 `WeChatFerry` 加群交流|如果你觉得有用| ## Quick Start -0. 安装 Python，例如 [3.10.11](https://www.python.org/ftp/python/3.10.11/python-3.10.11-amd64.exe) -1. 安装微信 `3.9.2.23`，下载地址在 [这里](https://github.com/lich0821/WeChatFerry/releases/download/v39.0.0/WeChatSetup-3.9.2.23.exe)；也可以从 [WeChatSetup](https://gitee.com/lch0821/WeChatSetup) 找到。 -2. 克隆项目 +0. 遇到问题先看看上面的文档、教程、FAQ 和微信机器人】沙雕行为合集。 +1. 安装 Python，例如 [3.10.11](https://www.python.org/ftp/python/3.10.11/python-3.10.11-amd64.exe) +2. 安装微信 `3.9.2.23`，下载地址在 [这里](https://github.com/lich0821/WeChatFerry/releases/download/v39.0.0/WeChatSetup-3.9.2.23.exe)；也可以从 [WeChatSetup](https://gitee.com/lch0821/WeChatSetup) 找到。 +3. 克隆项目 ```sh git clone https://github.com/lich0821/WeChatRobot.git @@ -21,7 +22,7 @@ git clone https://gitee.com/lch0821/WeChatRobot.git 如果觉得克隆复杂，也可以直接下载[最新版](https://github.com/lich0821/WeChatRobot/releases/latest) (打不开试试[这个](https://gitee.com/lch0821/WeChatRobot/releases/latest)) 到本地解压。 -3. 安装依赖 +4. 安装依赖 ```sh # 升级 pip python -m pip install -U pip @@ -29,53 +30,95 @@ python -m pip install -U pip pip install -r requirements.txt ``` -4. 运行 +5. 运行 -我们需要运行两次main.py第一次是生成配置文件config.yaml, 第二次是真正跑你的机器人。 -直接运行程序会自动拉起微信,如果微信未打开，会自动打开微信；如果版本不对，也会有提示；其他报错，请进群交流。 +我们需要运行两次 main.py 第一次是生成配置文件 config.yaml, 第二次是真正跑你的机器人。 +直接运行程序会自动拉起微信，如果微信未打开，会自动打开微信；如果版本不对，也会有提示；其他报错，请进群交流。 + +下面代码为第一次运行：第一次运行 main.py 会在 WeChatRobot 目录下生成一个 config.yaml 文件，参照修改配置进行修改。 + +其中 chatgpt、tigerbot、chatglm 和 xinghuo_web 是四种模型的配置信息，你需要配置它们的参数，不知道的可以加群交流。 -下面代码为第一次运行: 第一次运行main.py会在WeChatRobot目录下生成一个config.yaml文件，参照修改配置进行修改。 -其中chatgpt、tigerbot和xinghuo_web是三种模型的配置信息, 你需要配置它们的参数, 不知道的可以加群交流。 ```sh python main.py + +# 需要停止按 Ctrl+C ``` +启动之后，可以正常接收消息但不会响应群消息。参考下方 [修改配置](#config) 进行配置，以便响应特定群聊。 -下面代码为第二次运行: 你可以通过命令行参数选择模型，默认是不选择, 这样你配置了什么参数就跑什么模型。正因如此你需要配置前面所说三种模型中的至少一种(当然也可以都配置, 想跑那个模型就选什么参数), 然后就可以开始使用你的机器人了。 +下面代码为第二次运行：你可以通过命令行参数选择模型，默认是不选择，这样你配置了什么参数就跑什么模型。正因如此你需要配置前面所说四种模型中的至少一种（当然也可以都配置，想跑那个模型就选什么参数）, 然后就可以开始使用你的机器人了。 ```sh python main.py + +# 需要停止按 Ctrl+C ``` -如果你配置了多个模型,下面的内容才对你有帮助否则略过, 通过参数可以选择要跑的模型。 + +如果你配置了多个模型，下面的内容才对你有帮助否则略过，通过参数可以选择要跑的模型。 ```sh # 例: 我想运行选择chatgpt的机器人 python main.py -c 2 -``` -> python main.py -c C 其中参数C可选择如下所示 ->> 1. tigerbot模型 ->> 2. chatgpt模型 ->> 3. 讯飞星火模型 ->> 4. chatglm模型 -### 修改配置 -配置文件 `config.yaml` 是运行程序后自动从模板复制过来的，以下功能默认关闭。 -* 为了响应群聊消息，需要添加相应的 `roomId`（打印的消息中方括号里的就是）： +# 需要停止按 Ctrl+C +``` + +> python main.py -c C 其中参数 C 可选择如下所示 +>> 1. tigerbot 模型 +>> 2. chatgpt 模型 +>> 3. 讯飞星火模型 +>> 4. chatglm 模型 + +6. 停止 + +不要那么粗暴，温柔点儿； +不要直接关闭窗口，温柔点儿。 + +输入：`Ctrl+C`。否则，会出现各种奇怪问题。 + +### 修改配置 +ℹ️ *修改配置后，需要重新启动，以便让配置生效。* + +配置文件 `config.yaml` 是运行程序后自动从模板复制过来的，功能默认关闭。 + +#### 响应被 @ 消息 +为了响应群聊消息，需要添加相应的 `roomId`。 + +第一次运行的时候，可以在手机上往需要响应的群里发消息，打印的消息中方括号里的就是；多个群用 `,` 分隔。 ```yaml groups: enable: [] # 允许响应的群 roomId，大概长这样：2xxxxxxxxx3@chatroom ``` -* 为了使用 ChatGPT，需要取消配置中 chatgpt 的注释， 并配置 OpenAI 的 Key（以及代理）： +#### 配置 AI 模型 +为了使用 AI 模型，需要对相应模型并进行配置。 + ```yaml -# 如果要使用 ChatGPT，取消下面的注释并填写相关内容 -chatgpt: - key: 填写你 ChatGPT 的 key - api: https://api.openai.com/v1 # 如果你不知道这是干嘛的，就不要改 - proxy: # 如果你在国内，你可能需要魔法，大概长这样：http://域名或者IP地址:端口号 - prompt: 你是智能聊天机器人，你叫wcferry # 根据需要对角色进行设定 +chatgpt: # -----chatgpt配置这行不填----- + key: # 填写你 ChatGPT 的 key + api: https://api.openai.com/v1 # 如果你不知道这是干嘛的，就不要改 + proxy: # 如果你在国内，你可能需要魔法，大概长这样：http://域名或者IP地址:端口号 + prompt: 你是智能聊天机器人，你叫 wcferry # 根据需要对角色进行设定 + +chatglm: # -----chatglm配置这行不填----- + key: # key 暂时没有 + api: http://localhost:8000/v1 # 根据自己的chatglm地址修改 + proxy: # 如果你在国内，你可能需要魔法，大概长这样：http://域名或者IP地址:端口号 + prompt: 你是智能聊天机器人，你叫小薇 # 根据需要对角色进行设定 + file_path: C:/Pictures/temp #设定生成图片和代码使用的文件夹路径 + +tigerbot: # -----tigerbot配置这行不填----- + key: # key + model: # tigerbot-7b-sft + +# 抓取方式详见文档：https://www.bilibili.com/read/cv27066577 +xinghuo_web: # -----讯飞星火web模式api配置这行不填----- + cookie: # cookie + fd: # fd + GtToken: # GtToken + prompt: 你是智能聊天机器人，你叫 wcferry。请用这个角色回答我的问题 # 根据需要对角色进行设定 ``` -* ~~为了暴露 HTTP 接口，需要取消配置中 http 的注释：~~ - -如有需要，推荐使用 [wcfhttp](https://wechatferry.readthedocs.io/zh/latest/?badge=latest) +## HTTP +如需要使用 HTTP 接口，请参考 [wcfhttp](https://wechatferry.readthedocs.io/zh/latest/?badge=latest)。 [![PyPi](https://img.shields.io/pypi/v/wcfhttp.svg)](https://pypi.python.org/pypi/wcfhttp) [![Downloads](https://static.pepy.tech/badge/wcfhttp)](https://pypi.python.org/pypi/wcfhttp) [![Documentation Status](https://readthedocs.org/projects/wechatferry/badge/?version=latest)](https://wechatferry.readthedocs.io/zh/latest/?badge=latest)