Matrix ChatGPT 机器人使用指南

1. 项目介绍

Matrix ChatGPT 机器人是一个基于 Matrix 网络的开源项目，它使用了 OpenAI 的 ChatGPT API 来实现与用户聊天。用户可以通过 Matrix 客户端与机器人进行交流，机器人支持显示输入状态、加密消息以及存储对话上下文等功能。

2. 项目快速启动

环境准备

• Matrix 账号：在 Matrix.org 或其他 Matrix 服务器上创建一个账号用于机器人。
• OpenAI 账号：在 openai.com 创建账号并创建一个 API Key。

配置环境变量

创建一个 .env 文件，并设置以下环境变量：

MATRIX_BOT_USERNAME=你的机器人用户名
MATRIX_BOT_PASSWORD=你的机器人密码
OPENAI_API_KEY=你的OpenAI API Key
MATRIX_ENCRYPTION=是否启用加密（true/false）
CHATGPT_API_MODEL=ChatGPT 的模型（默认为 gpt-3.5-turbo）

运行机器人

使用 Docker

推荐使用 Docker 运行机器人，以下为 Docker 运行命令：

docker run -it -v storage:/storage --env-file=./.env --name matrix-chatgpt-bot ghcr.io/matrixgpt/matrix-chatgpt-bot:latest

如果你想从源代码构建，可以执行以下命令：

docker build . -t matrix-chatgpt-bot
docker run -it -v storage:/storage --env-file=./.env --name matrix-chatgpt-bot matrix-chatgpt-bot

不使用 Docker

如果不使用 Docker，确保安装了 yarn、Node.js 和其他必要的依赖包，然后运行以下命令：

yarn
yarn build
yarn start

获取访问令牌

启动后，从控制台输出中复制 MATRIX_ACCESS_TOKEN 并将其设置为环境变量，之后可以移除 MATRIX_BOT_PASSWORD。

3. 应用案例和最佳实践

• 创建聊天室：创建一个新的 Matrix 聊天室。
• 添加机器人：在聊天室中邀请机器人。
• 开始聊天：与机器人开始聊天，机器人将显示输入状态并存储对话上下文。

最佳实践：

• 在 .env 文件中设置黑白名单来限制访问。
• 使用环境变量 CHATGPT_REVERSE_PROXY 来指定非官方的 OpenAI API 端点。
• 如果出现加密问题，可以设置 MATRIX_ENCRYPTION=false 来禁用加密。

4. 典型生态项目

Matrix 社区中有许多其他开源项目，例如：

• Matrix 客户端：Element、 Quaternion 等。
• Matrix 服务器：Synapse、Dendrite 等。
• 机器人框架：Matrix-Bot、Autopilot 等。

以上是 Matrix ChatGPT 机器人的基本使用指南，希望对您有所帮助。