请阅读！

关于运行此特定机器人遇到的任何问题： Discord 项目帖子

关于 OpenAI API 的一般性问题或疑问： Discord API 讨论区

关于模板代码中的错误： 请创建一个 Issue

关于功能请求： 此仓库目前不接受功能请求，您可以在 Discord 项目帖子 中讨论潜在的功能。

关于 Pull Request： 只接受修复 bug 的 PR。如果您要实现新功能，请先 fork 此仓库。

感谢您的支持！

---

GPT Discord 机器人

这是一个用 Python 编写的示例 Discord 机器人，它使用 聊天完成 API 与 gpt-3.5-turbo 模型进行对话，并利用 内容审核 API 对消息进行过滤。

该机器人使用了 OpenAI Python 库 和 discord.py。

功能

• /chat 命令会启动一个公开线程，并接受一个 message 参数作为用户发送给机器人的第一条消息。您还可以选择调整 temperature 和 max_tokens 参数。
• 对于通过 /chat 命令开启的任何线程中的每一条用户消息，模型都会生成回复。
• 每次请求时，整个线程的内容都会被传递给模型，因此模型能够记住线程中之前的对话内容。
• 当上下文长度达到上限，或者线程中的消息数量达到最大值时，机器人将关闭该线程。
• 您可以通过修改 config.yaml 文件来自定义机器人的指令。
• 您可以更改使用的模型，默认为 gpt-3.5-turbo。

设置步骤

1. 将 .env.example 文件复制为 .env，并按照以下说明填写相应值。
2. 前往 https://beta.openai.com/account/api-keys，创建一个新的 API 密钥，并将其填入 OPENAI_API_KEY。
3. 在 https://discord.com/developers/applications 上创建您自己的 Discord 应用程序。
4. 切换到“Bot”选项卡，点击“Add Bot”：
   • 点击“Reset Token”，并将生成的令牌填入 DISCORD_BOT_TOKEN。
   • 如果您不希望机器人对所有人可见，请取消勾选“Public Bot”。
   • 在“Privileged Gateway Intents”中启用“Message Content Intent”。
5. 切换到“OAuth2”选项卡，复制您的“Client ID”，并将其填入 DISCORD_CLIENT_ID。
6. 右键单击您希望允许机器人加入的服务器图标，选择“Copy ID”，并将服务器 ID 填入 ALLOWED_SERVER_IDS。如果需要允许多个服务器，ID 之间用逗号分隔，例如 server_id_1,server_id_2。
7. 安装依赖并运行机器人：

   pip install -r requirements.txt
   python -m src.main
   

   控制台中应显示一个邀请链接。将其复制并粘贴到浏览器中，即可将机器人添加到您的服务器。 注意：请确保您使用的是 Python 3.9 或更高版本（可通过 python --version 检查）。

可选配置

1. 如果您希望接收内容审核消息，请为每个需要接收审核消息的服务器创建对应的频道 ID，并将其填入 SERVER_TO_MODERATION_CHANNEL。格式应为：server_id:channel_id,server_id_2:channel_id_2。
2. 如果您想改变机器人的个性设定，请前往 src/config.yaml 编辑相关指令。
3. 如果您想调整内容审核的设置，以决定哪些消息会被标记或屏蔽，请编辑 src/constants.py 中的数值。数值越高，触发审核的概率越低；数值为 1.0 时表示完全不进行该类别的审核。

常见问题解答

为什么我的机器人无法响应命令？

请确保机器人所处的频道具备以下权限：

• 发送消息
• 在线程中发送消息
• 创建公开线程
• 管理消息（仅用于审核时删除被屏蔽的消息）
• 管理线程
• 阅读消息历史
• 使用应用命令

gpt-discord-bot 快速上手指南

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统：Windows、macOS 或 Linux
• Python 版本：Python 3.9 或更高版本（可通过 python --version 检查）
• 账号准备：
  • OpenAI 账号（需拥有 API Key）
  • Discord 开发者账号
• 网络环境：由于 OpenAI 和 Discord 服务在国内访问受限，请确保已配置好稳定的网络代理或加速方案。

安装步骤

1. 克隆项目代码

   git clone https://github.com/openai/gpt-discord-bot.git
   cd gpt-discord-bot
   

2. 安装 Python 依赖 建议使用国内镜像源加速安装：

   pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
   

3. 配置环境变量 复制示例配置文件并填入关键信息：

   cp .env.example .env
   

   编辑 .env 文件，填入以下内容：

   • OPENAI_API_KEY：从 OpenAI API Keys 页面 获取。
   • DISCORD_BOT_TOKEN：在 Discord 开发者门户的 "Bot" 标签页重置令牌获取。
   • DISCORD_CLIENT_ID：在 Discord 开发者门户的 "OAuth2" 标签页获取。
   • ALLOWED_SERVER_IDS：右键点击 Discord 服务器图标选择“复制 ID"填入；多服务器用逗号分隔（如 id1,id2）。

   注意：在 Discord 开发者门户创建 Bot 时，务必启用 "Message Content Intent"（特权网关意图），否则机器人无法读取消息内容。

4. 邀请机器人加入服务器 运行以下命令启动程序，控制台将输出邀请链接：

   python -m src.main
   

   复制输出的 URL 到浏览器打开，授权机器人加入指定的 Discord 服务器。

基本使用

配置完成后，即可在 Discord 中与 AI 进行对话：

1. 发起对话 在任何文本频道中输入斜杠命令：

   /chat message:你好，请介绍一下你自己
   

   机器人会自动创建一个公开线程（Thread），并在其中回复你的消息。

2. 持续交流 在该线程中发送的任何消息，机器人都会自动读取上下文并生成回复。它会记住整个线程的历史记录。

3. 高级参数（可选） 你可以在命令中调整生成参数：

   /chat message:写一首诗 temperature:0.8 max_tokens:200
   

   • temperature：控制回复的随机性（0-2）。
   • max_tokens：限制回复的最大长度。

4. 自定义行为 如需修改机器人的性格指令或模型版本，可编辑 src/config.yaml 文件（默认模型为 gpt-3.5-turbo）。