[English] | [中文]

Bot on Anything 是一款功能强大的 AI 聊天机器人构建工具，可帮助您快速搭建聊天机器人，并将其部署到任何地方运行。

简介

开发者只需通过轻量级配置，即可在各类 AI 大模型与应用渠道之间进行选择并建立连接，从而构建和运行智能对话机器人。它支持在一个项目中轻松切换多种路径。这种架构具有很强的扩展性：每个应用都可以复用现有的模型能力，而每新增一个模型也可以在所有应用渠道上运行。

模型：

• ChatGPT
• Claude
• Gemini

应用：

• 终端
• Web
• 订阅号
• 服务号
• 企业微信
• Telegram
• QQ
• 钉钉
• 飞书
• Gmail
• Slack

快速入门

1. 运行环境

支持 Linux、MacOS 和 Windows 系统，且需安装 Python。建议使用 Python 3.7.1 至 3.10 版本。

克隆项目代码并安装依赖：

git clone https://github.com/zhayujie/bot-on-anything
cd bot-on-anything/
pip3 install -r requirements.txt

2. 配置说明

核心配置文件为 config.json，项目中提供了一个模板文件 config-template.json，可将其复制生成最终有效的 config.json 文件：

cp config-template.json config.json

每个模型和渠道都有各自的配置块，共同组成完整的配置文件。整体结构如下所示：

{
  "model": {
    "type" : "openai",             # 所选 AI 模型
    "openai": {
      # openAI 配置
    }
  },
  "channel": {
    "type": "slack",            # 要集成的渠道
    "slack": {
        # slack 配置
    },
    "telegram": {
        # telegram 配置
    }
  }
}

配置文件最外层分为 model 和 channel 两部分。其中，model 部分用于模型配置，type 字段指定了要使用的模型；channel 部分则包含应用渠道的配置，type 字段指定了要集成的应用。

使用时，只需更改模型和渠道配置块下的 type 字段，即可在任意模型和应用之间切换，实现不同路径的连接。接下来将依次介绍各模型及应用的配置与运行流程。

3. 运行

在项目根目录下运行以下命令，默认渠道为终端：

python3 app.py

II. 选择模型

1. ChatGPT

默认模型为 gpt-3.5-turbo。详情请参阅官方文档。它也支持 gpt-4.0，只需修改模型类型参数即可。

(1) 安装依赖

pip3 install --upgrade openai

注意：openai 版本需高于 0.27.0。若安装失败，可先通过 pip3 install --upgrade pip 升级 pip。

(2) 配置项说明

{
  "model": {
    "type" : "chatgpt",
    "openai": {
      "api_key": "YOUR API KEY",
      "model": "gpt-3.5-turbo",                         # 模型名称
      "proxy": "http://127.0.0.1:7890",                 # 代理地址
      "character_desc": "你是 ChatGPT，由 OpenAI 训练的大型语言模型，旨在回答和解决人们提出的任何问题，并能用多种语言交流。当被问及你是谁时，你也应告知提问者，输入 #clear_memory 可开始新的主题探讨。输入 draw xx 可为你生成一幅图片。",
      "conversation_max_tokens": 1000,                  # 回复的最大字符数，包括输入和输出总和
      "temperature":0.75,     # 熵值，范围在 [0,1] 之间，值越大，候选词选择越随机，回复不确定性越高；建议与 top_p 参数二选一，创造性任务推荐使用较高值，精确性任务则推荐较低值
      "top_p":0.7,            # 候选词列表。0.7 表示仅考虑前 70% 的候选词，建议与 temperature 参数二选一
      "frequency_penalty":0.0,            # 范围在 [-2,2] 之间，该值越大，越能减少模型输出中词语的重复，倾向于生成不同的内容
      "presence_penalty":1.0,             # 范围在 [-2,2] 之间，该值越大，模型受输入限制越小，鼓励生成未出现在输入中的新词，倾向于生成不同内容
    }
  }

• api_key: 填写注册账号时创建的 OpenAI API KEY。
• model: 模型名称，目前支持 gpt-3.5-turbo、gpt-4、gpt-4-32k（gpt-4 API 尚未开放）。
• proxy: 代理客户端地址，详情请参阅 #56。
• character_desc: 此配置保存一段您对 ChatGPT 所说的文本，ChatGPT 会将其作为自身设定记住；您可以为其自定义任何个性。
• max_history_num[可选]: 对话的最大记忆长度，超过此长度将清除之前的记忆。

---

2. LinkAI

配置项说明

{
  "model": {
    "type" : "linkai",
    "linkai": {
      "api_key": "",
      "api_base": "https://api.link-ai.tech",
      "app_code":  "",
      "model": "",
      "conversation_max_tokens": 1000,
      "temperature":0.75,
      "top_p":0.7,
      "frequency_penalty":0.0,
      "presence_penalty":1.0,
      "character_desc": "你是一个智能助手。"
    },
  }

• api_key: 调用 LinkAI 服务的密钥，可在控制台创建。
• app_code: LinkAI 应用程序或工作流的代码，可选，详情请参阅应用创建。
• model: 支持国内外常用模型，详情请参阅模型列表。可留空，应用程序的默认模型可在LinkAI 平台中修改。
• 其他参数含义与 ChatGPT 模型中的参数相同。

III. 选择通道

1. 命令行终端

配置模板中默认启动的应用程序是终端模式，无需额外配置。您可以在项目目录下直接执行 python3 app.py 启动程序。用户通过命令行输入与对话模型交互，并支持流式响应效果。

---

2. Web

贡献者: RegimenArsenic

依赖

pip3 install PyJWT flask flask_socketio

配置

"channel": {
    "type": "http",
    "http": {
      "http_auth_secret_key": "6d25a684-9558-11e9-aa94-efccd7a0659b",    // JWT 认证密钥
      "http_auth_password": "6.67428e-11",        // 认证密码，仅供个人使用，作为初步防御他人扫描端口和 DDOS 攻击浪费 token
      "port": "80"       // 端口
    }
  }

本地运行：执行 python3 app.py 后，访问 http://127.0.0.1:80。

服务器部署：部署完成后，访问 http://公网域名或IP:端口。

---

3. 个人订阅号

要求： 一台服务器和一个订阅号。

3.1 安装依赖

安装 werobot 依赖：

pip3 install werobot

3.2 配置

"channel": {
    "type": "wechat_mp",

    "wechat_mp": {
      "token": "YOUR TOKEN",           # Token值
      "port": "8088"                   # 程序监听的端口
    }
}

3.3 运行程序

在项目目录下运行 python3 app.py。如果终端显示以下内容，则表示运行成功：

[INFO][2023-02-16 01:39:53][app.py:12] - [INIT] load config: ...
[INFO][2023-02-16 01:39:53][wechat_mp_channel.py:25] - [WX_Public] 微信公众号服务启动！
Bottle v0.12.23 server starting up (using AutoServer())...
Listening on http://127.0.0.1:8088/
Hit Ctrl-C to quit.

2.2 设置订阅号的回调URL

前往 微信公众平台 的个人订阅号，启用服务器配置：

服务器地址（URL）配置：如果通过浏览器访问服务器上的 Python 程序时能够正常打开配置的 URL（默认监听 8088 端口），则说明配置有效。由于订阅号仅支持配置 80 或 443 端口，您可以将配置修改为直接监听 80 端口（需 sudo 权限）或使用反向代理转发（如 nginx）。根据官方文档，此处可填写公网 IP 或域名。

Token 配置：必须与 config.json 中的 token 保持一致。

详细操作流程请参考 官方文档。

2.3 使用方法

用户关注订阅号后，即可发送消息。

注意：用户发送消息后，微信后台会推送至配置的 URL 地址，但如果 5 秒内未回复，连接将会断开，并重试 3 次。然而，调用 OpenAI 接口通常需要超过 5 秒的时间。在本项目中，通过异步和缓存机制已将 5 秒的超时限制优化至 15 秒，但若超过此时间仍无法正常回复。同时，每次连接因 5 秒超时而断开时，Web 框架都会报错，后续将进一步优化。

---

4. 企业服务号

要求： 一台服务器和一个认证的服务号。

在企业服务号中，通过先异步访问 OpenAI 接口，再利用客服接口主动推送消息的方式，解决了个人订阅号 15 秒超时的问题。服务号的开发者模式配置与订阅号类似，详情请参阅 官方文档。

企业服务号的 config.json 配置只需将类型改为 wechat_mp_service，但配置块仍沿用 wechat_mp，此外还需添加两个配置项：app_id 和 app_secret。

"channel": {
    "type": "wechat_mp_service",

    "wechat_mp": {
      "token": "YOUR TOKEN",            # Token值
      "port": "8088",                   # 程序监听的端口
      "app_id": "YOUR APP ID",          # App ID
      "app_secret": "YOUR APP SECRET"   # App secret
    }
}

注意：服务器 IP 必须配置到“IP 白名单”中，否则用户将无法接收到主动推送的消息。

---

5. QQ

要求： 一台 PC 或服务器（国内网络）以及一个 QQ 账号。

运行 QQ 机器人需要额外运行一个 go-cqhttp 程序，该程序负责接收和发送 QQ 消息，而我们的 bot-on-anything 程序则负责调用 OpenAI 生成对话内容。

5.1 下载 go-cqhttp

从 go-cqhttp Release 下载对应系统的程序，解压后将 go-cqhttp 可执行文件放置于我们的 bot-on-anything/channel/qq 目录中。此处已准备好 config.yml 配置文件，您只需填写 QQ 账号配置（账号 UIN）即可。

5.2 安装 aiocqhttp

使用 aiocqhttp 与 go-cqhttp 进行交互，执行以下命令安装依赖：

pip3 install aiocqhttp

5.3 配置

只需将 config.json 配置文件中 channel 块的 type 改为 qq 即可：

"channel": {
    "type": "qq"
}

5.4 运行

首先，进入 bot-on-anything 项目的根目录，在终端 1 中运行：

python3 app.py    # 此时将监听 8080 端口

第二步，打开终端 2，进入 cqhttp 所在的目录，运行：

cd channel/qq
./go-cqhttp

注意：

• 目前尚未设置关键词匹配或群聊白名单；所有私聊均会自动回复，在群聊中只要被 @ 到也会自动回复。
• 如果遇到账号被封禁等异常情况，可以将 go-cqhttp 同级目录下 device.json 文件中的 protocol 值由 5 改为 2，具体可参考此 Issue。

---

6. Telegram

贡献者：brucelt1993

6.1 获取 Token

申请 Telegram 机器人可以在 Google 上轻松找到相关信息，关键是要获取机器人的 Token ID。

6.2 安装依赖

pip install pyTelegramBotAPI

6.3 配置

"channel": {
    "type": "telegram",
    "telegram":{
      "bot_token": "YOUR BOT TOKEN ID"
    }
}

---

7. Gmail

要求： 一台服务器和一个 Gmail 账号。

贡献者： Simon

按照 官方文档 为您的 Google 账号创建应用专用密码，按如下方式配置，即可开始使用！！！

"channel": {
    "type": "gmail",
    "gmail": {
      "subject_keyword": ["bot", "@bot"],
      "host_email": "xxxx@gmail.com",
      "host_password": "GMAIL ACCESS KEY"
    }
  }

---

8. Slack

❉ 不再需要服务器或公网IP

贡献者: amaoo

依赖项

pip3 install slack_bolt

配置

"channel": {
    "type": "slack",
    "slack": {
      "slack_bot_token": "xoxb-xxxx",
      "slack_app_token": "xapp-xxxx"
    }
  }

设置 Bot Token 范围 - OAuth & 权限

将 Bot 用户的 OAuth Token 写入配置文件 slack_bot_token。

app_mentions:read
chat:write

启用 Socket 模式 - Socket Mode

如果您尚未创建应用级别的 Token，系统会提示您创建一个。请将生成的 Token 写入配置文件 slack_app_token。

事件订阅（Event Subscriptions）- 订阅机器人事件

app_mention

参考文档

https://slack.dev/bolt-python/tutorial/getting-started

---

10. 钉钉

要求：

• 企业内部开发机器人。

依赖项

pip3 install requests flask

配置

"channel": {
    "type": "dingtalk",
    "dingtalk": {
      "image_create_prefix": ["draw", "draw", "Draw"],
      "port": "8081",                  # 外部端口
      "dingtalk_token": "xx",          # Webhook 地址的访问令牌
      "dingtalk_post_token": "xx",     # 钉钉回传消息时头部携带的验证令牌
      "dingtalk_secret": "xx"          # 群机器人中的安全加密签名字符串
    }
  }

参考文档：

• 钉钉内部机器人教程
• 自定义机器人接入文档
• 企业内部开发机器人教程文档

生成机器人

地址：https://open-dev.dingtalk.com/fe/app#/corp/robot
添加机器人，在开发管理中设置服务器的出站 IP 和消息接收地址（即配置中的外部地址，如 https://xx.xx.com:8081）。

---

11. 飞书

依赖项

pip3 install requests flask

配置

"channel": {
    "type": "feishu",
    "feishu": {
        "image_create_prefix": [
            "draw",
            "draw",
            "Draw"
        ],
        "port": "8082",                  # 外部端口
        "app_id": "xxx",                 # 应用程序的 app_id
        "app_secret": "xxx",             # 应用程序的 Secret
        "verification_token": "xxx"      # 事件订阅的验证令牌
    }
}

生成机器人

地址：https://open.feishu.cn/app/

1. 为企业添加一个自建应用。
2. 开启以下权限：
   • im:message
   • im:message.group_at_msg
   • im:message.group_at_msg:readonly
   • im:message.p2p_msg
   • im:message.p2p_msg:readonly
   • im:message:send_as_bot
3. 在菜单中订阅“接收消息 v2.0”事件，并配置请求地址（即配置中的外部地址，如 https://xx.xx.com:8081）。
4. 在版本管理和发布中上线应用，待审核通过后，即可在群聊中使用该自建应用。

---

12. 企业微信

要求： 一台服务器和一个已认证的企业微信账号。

企业微信的 config.json 配置只需将类型改为 wechat_com，默认的消息接收服务器 URL 为：http://ip:8888/wechat。

"channel": {
    "type": "wechat_com",
    "wechat_com": {
      "wechat_token": "YOUR TOKEN",            # Token 值
      "port": "8888",                          # 程序监听的端口
      "app_id": "YOUR APP ID",                 # 应用 ID
      "app_secret": "YOUR APP SECRET",          # 应用 Secret
      "wechat_corp_id": "YOUR CORP ID",
      "wechat_encoding_aes_key": "YOUR AES KEY"
    }
}

注意：服务器 IP 必须配置到“企业可信 IP 列表”中，否则用户将无法接收到主动推送的消息。

参考文档：

• 企业微信配置教程

通用配置

• clear_memory_commands: 对话中的内部命令，用于主动清除之前的记忆，字符串数组可以自定义命令别名。
  • 默认值：["#clear_memory"]

Bot-On-Anything 快速上手指南

Bot-On-Anything 是一个强大的 AI 聊天机器人构建工具，支持通过轻量级配置连接多种大模型（如 ChatGPT、LinkAI）与多个应用渠道（微信、钉钉、飞书、Telegram 等），实现“一次配置，随处运行”。

1. 环境准备

系统要求

支持 Linux、macOS 和 Windows 系统。

前置依赖

• Python: 必须安装，推荐版本 3.7.1 - 3.10。
• Git: 用于克隆项目代码。

国内加速建议：若下载依赖较慢，可配置 pip 使用国内镜像源（如清华源）：

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

2. 安装步骤

第一步：克隆项目

git clone https://github.com/zhayujie/bot-on-anything
cd bot-on-anything/

第二步：安装依赖

pip3 install -r requirements.txt

注：若需使用 Web 渠道，需额外安装：pip3 install PyJWT flask flask_socketio；若需使用微信公众号，需安装：pip3 install werobot。

第三步：初始化配置文件

复制模板文件生成正式配置文件：

cp config-template.json config.json

3. 基本使用

配置模型与渠道

编辑 config.json 文件，核心结构如下：

{
  "model": {
    "type": "chatgpt",           // 选择模型类型，如 chatgpt, linkai
    "openai": {
      "api_key": "YOUR_API_KEY", // 填入你的 API Key
      "model": "gpt-3.5-turbo",  // 模型名称
      "proxy": "http://127.0.0.1:7890" // 如有需要配置代理
    }
  },
  "channel": {
    "type": "terminal",          // 选择渠道类型，默认为 terminal (命令行)
    "terminal": {}               // 对应渠道的具体配置
  }
}

• 切换模型：修改 model.type 及对应的配置块（如 openai 或 linkai）。
• 切换渠道：修改 channel.type 及对应的配置块（如 wechat_mp, dingtalk, web 等）。

启动程序

在项目根目录执行以下命令即可启动，默认使用命令行终端进行交互：

python3 app.py

启动成功后，直接在终端输入消息即可与 AI 对话。若配置了其他渠道（如 Web 或微信公众号），请根据对应渠道文档访问指定端口或 URL。