• 个人聊天中，需要以 "bot"或"@bot" 为开头的内容触发机器人，对应配置项 single_chat_prefix (如果不需要以前缀触发可以填写 "single_chat_prefix": [""])
• 机器人回复的内容会以 "[bot] " 作为前缀， 以区分真人，对应的配置项为 single_chat_reply_prefix (如果不需要前缀可以填写 "single_chat_reply_prefix": "")

• 群组聊天中，群名称需配置在 group_name_white_list 中才能开启群聊自动回复。如果想对所有群聊生效，可以直接填写 "group_name_white_list": ["ALL_GROUP"]
• 默认只要被人 @ 就会触发机器人自动回复；另外群聊天中只要检测到以 "@bot" 开头的内容，同样会自动回复（方便自己触发），这对应配置项 group_chat_prefix
• 可选配置: group_name_keyword_white_list配置项支持模糊匹配群名称，group_chat_keyword配置项则支持模糊匹配群消息内容，用法与上述两个配置项相同。（Contributed by evolay)
• group_chat_in_one_session：使群聊共享一个会话上下文，配置 ["ALL_GROUP"] 则作用于所有群聊

• 添加 "speech_recognition": true 将开启语音识别，默认使用openai的whisper模型识别为文字，同时以文字回复，该参数仅支持私聊 (注意由于语音消息无法匹配前缀，一旦开启将对所有语音自动回复，支持语音触发画图)；
• 添加 "group_speech_recognition": true 将开启群组语音识别，默认使用openai的whisper模型识别为文字，同时以文字回复，参数仅支持群聊 (会匹配group_chat_prefix和group_chat_keyword, 支持语音触发画图)；
• 添加 "voice_reply_voice": true 将开启语音回复语音（同时作用于私聊和群聊）

• model: 模型名称，目前支持 gpt-4o-mini, gpt-4.1, gpt-4o, gpt-3.5-turbo, wenxin , claude , gemini, glm-4, xunfei, moonshot等，全部模型名称参考common/const.py文件
• temperature,frequency_penalty,presence_penalty: Chat API接口参数，详情参考OpenAI官方文档。
• proxy：由于目前 openai 接口国内无法访问，需配置代理客户端的地址，详情参考 #351
• 对于图像生成，在满足个人或群组触发条件外，还需要额外的关键词前缀来触发，对应配置 image_create_prefix
• 关于OpenAI对话及图片接口的参数配置（内容自由度、回复字数限制、图片大小等），可以参考 对话接口 和 图像接口 文档，在config.py中检查哪些参数在本项目中是可配置的。
• conversation_max_tokens：表示能够记忆的上下文最大字数（一问一答为一组对话，如果累积的对话字数超出限制，就会优先移除最早的一组对话）
• rate_limit_chatgpt，rate_limit_dalle：每分钟最高问答速率、画图速率，超速后排队按序处理。
• clear_memory_commands: 对话内指令，主动清空前文记忆，字符串数组可自定义指令别名。
• hot_reload: 程序退出后，暂存等于状态，默认关闭。
• character_desc 配置中保存着你对机器人说的一段话，他会记住这段话并作为他的设定，你可以为他定制任何人格 (关于会话上下文的更多内容参考该 issue)
• subscribe_msg：订阅消息，公众号和企业微信channel中请填写，当被订阅时会自动回复， 可使用特殊占位符。目前支持的占位符有{trigger_prefix}，在程序中它会自动替换成bot的触发词。

• use_linkai: 是否使用LinkAI接口，默认关闭，设置为true后可对接LinkAI平台的Agent，使用知识库、工作流、联网搜索、Midjourney 绘画等能力, 参考 文档
• linkai_api_key: LinkAI Api Key，可在 控制台 创建
• linkai_app_code: LinkAI 应用或工作流的code，选填

1. API Key创建：在 OpenAI平台 创建API Key

2. 填写配置

{
    "model": "gpt-4.1-mini",
    "open_ai_api_key": "YOUR_API_KEY",
    "open_ai_api_base": "https://api.openai.com/v1",
    "bot_type": "chatGPT"
}

• model: 与OpenAI接口的 model参数 一致，支持包括 o系列、gpt-4系列、gpt-3.5系列等模型
• open_ai_api_base: 如果需要接入第三方代理接口，可通过修改该参数进行接入
• bot_type: 使用OpenAI相关模型时无需填写。当使用第三方代理接口接入Claude等非OpenAI官方模型时，该参数设为 chatGPT

1. API Key创建：在 LinkAI平台 创建API Key

2. 填写配置

{
 "use_linkai": true,
 "linkai_api_key": "YOUR API KEY",
 "linkai_app_code": "YOUR APP CODE"
}

• use_linkai: 是否使用LinkAI接口，默认关闭，设置为true后可对接LinkAI平台的智能体，使用知识库、工作流、数据库、联网搜索、MCP工具等丰富的Agent能力, 参考 文档
• linkai_api_key: LinkAI平台的API Key，可在 控制台 中创建
• linkai_app_code: LinkAI智能体 (应用或工作流) 的code，选填。智能体创建可参考 说明文档
• model: model字段填写空则直接使用智能体的模型，可在平台中灵活切换，模型列表中的全部模型均可使用

1. API Key创建：在 DeepSeek平台 创建API Key

2. 填写配置

{
  "bot_type": "chatGPT",
  "model": "deepseek-chat",
  "open_ai_api_key": "sk-xxxxxxxxxxx",
  "open_ai_api_base": "https://api.deepseek.com/v1"
}

• bot_type: OpenAI兼容方式
• model: 可填 deepseek-chat、deepseek-reasoner，分别对应的是 V3 和 R1 模型
• open_ai_api_key: DeepSeek平台的 API Key
• open_ai_api_base: DeepSeek平台 BASE URL

1. API Key创建：在 DeepSeek平台 创建API Key

2. 填写配置

{
  "model": "",
  "use_azure_chatgpt": true,
  "open_ai_api_key": "e7ffc5dd84f14521a53f14a40231ea78",
  "open_ai_api_base": "https://linkai-240917.openai.azure.com/",
  "azure_deployment_id": "gpt-4.1",
  "azure_api_version": "2025-01-01-preview"
}

• model: 留空即可
• use_azure_chatgpt: 设为 true
• open_ai_api_key: Azure平台的密钥
• open_ai_api_base: Azure平台的 BASE URL
• azure_deployment_id: Azure平台部署的模型名称
• azure_api_version: api版本以及以上参数可以在部署的 模型配置 界面查看

1. API Key创建：在 Claude控制台 创建API Key

2. 填写配置

{
    "model": "claude-sonnet-4-0",
    "claude_api_key": "YOUR_API_KEY"
}

• model: 参考 官方模型ID ，例如claude-opus-4-0、claude-3-7-sonnet-latest等

方式一：官方SDK接入，配置如下：

{
    "model": "qwen-turbo",
    "dashscope_api_key": "sk-qVxxxxG"
}

• model: 可填写qwen-turbo、qwen-plus、qwen-max
• dashscope_api_key: 通义千问的 API-KEY，参考 官方文档 ，在 控制台 创建

方式二：OpenAI兼容方式接入，配置如下：

{
  "bot_type": "chatGPT",
  "model": "qwen-turbo",
  "open_ai_api_base": "https://dashscope.aliyuncs.com/compatible-mode/v1",
  "open_ai_api_key": "sk-qVxxxxG"
}

• bot_type: OpenAI兼容方式
• model: 支持官方所有模型，参考模型列表
• open_ai_api_base: 通义千问API的 BASE URL
• open_ai_api_key: 通义千问的 API-KEY，参考 官方文档 ，在 控制台 创建

API Key创建：在 控制台 创建API Key ，配置如下

{
    "model": "gemini-2.5-pro",
    "gemini_api_key": ""
}

• model: 参考官方文档-模型列表

方式一：官方接入，配置如下：

{
    "model": "moonshot-v1-8k",
    "moonshot_api_key": "moonshot-v1-8k"
}

• model: 可填写moonshot-v1-8k、 moonshot-v1-32k、 moonshot-v1-128k
• moonshot_api_key: Moonshot的API-KEY，在 控制台 创建

方式二：OpenAI兼容方式接入，配置如下：

{
  "bot_type": "chatGPT",
  "model": "moonshot-v1-8k",
  "open_ai_api_base": "https://api.moonshot.cn/v1",
  "open_ai_api_key": ""
}

• bot_type: OpenAI兼容方式
• model: 可填写moonshot-v1-8k、 moonshot-v1-32k、 moonshot-v1-128k
• open_ai_api_base: Moonshot的 BASE URL
• open_ai_api_key: Moonshot的 API-KEY，在 控制台 创建

{
    "model": "wenxin", 
    "baidu_wenxin_api_key": "IajztZ0bDxgnP9bEykU7lBer",
    "baidu_wenxin_secret_key": "EDPZn6L24uAS9d8RWFfotK47dPvkjD6G"
}

• model: 可填 wenxin和wenxin-4，对应模型为 文心-3.5 和 文心-4.0
• baidu_wenxin_api_key：参考 千帆平台-access_token鉴权 文档获取 API Key
• baidu_wenxin_secret_key：参考 千帆平台-access_token鉴权 文档获取 Secret Key

方式二：OpenAI兼容方式接入，配置如下：

{
  "bot_type": "chatGPT",
  "model": "qwen-turbo",
  "open_ai_api_base": "https://qianfan.baidubce.com/v2",
  "open_ai_api_key": "bce-v3/ALTxxxxxxd2b"
}

• bot_type: OpenAI兼容方式
• model: 支持官方所有模型，参考模型列表
• open_ai_api_base: 百度文心API的 BASE URL
• open_ai_api_key: 百度文心的 API-KEY，参考 官方文档 ，在 控制台 创建API Key

方式一：官方接入，配置如下： 参考 官方文档-快速指引 获取 APPID、 APISecret、 APIKey 三个参数

{
  "model": "xunfei",
  "xunfei_app_id": "",
  "xunfei_api_key": "",
  "xunfei_api_secret": "",
  "xunfei_domain": "4.0Ultra",
  "xunfei_spark_url": "wss://spark-api.xf-yun.com/v4.0/chat"
}

• model: å¡« xunfei
• xunfei_domain: 可填写 4.0Ultra、 generalv3.5、 max-32k、 generalv3、 pro-128k、 lite
• xunfei_spark_url: 填写参考 官方文档-请求地址 的说明

方式二：OpenAI兼容方式接入，配置如下：

{
  "bot_type": "chatGPT",
  "model": "4.0Ultra",
  "open_ai_api_base": "https://spark-api-open.xf-yun.com/v1",
  "open_ai_api_key": ""
}

• bot_type: OpenAI兼容方式
• model: 可填写 4.0Ultra、 generalv3.5、 max-32k、 generalv3、 pro-128k、 lite
• open_ai_api_base: 讯飞星火平台的 BASE URL
• open_ai_api_key: 讯飞星火平台的APIPassword ，因模型而已

方式一：官方接入，配置如下：

{
  "model": "glm-4-plus",
  "zhipu_ai_api_key": ""
}

• model: 可填 glm-4-plus、glm-4-air-250414、glm-4-airx、glm-4-long 、glm-4-flashx 、glm-4-flash-250414, 参考 glm-4系列模型编码
• zhipu_ai_api_key: 智谱AI平台的 API KEY，在 控制台 创建

方式二：OpenAI兼容方式接入，配置如下：

{
  "bot_type": "chatGPT",
  "model": "glm-4-plus",
  "open_ai_api_base": "https://open.bigmodel.cn/api/paas/v4",
  "open_ai_api_key": ""
}

• bot_type: OpenAI兼容方式
• model: 可填 glm-4-plus、glm-4-air-250414、glm-4-airx、glm-4-long 、glm-4-flashx 、glm-4-flash-250414, 参考 glm-4系列模型编码
• open_ai_api_base: 智谱AI平台的 BASE URL
• open_ai_api_key: 智谱AI平台的 API KEY，在 控制台 创建

方式一：官方接入，配置如下：

{
    "model": "abab6.5-chat",
    "Minimax_api_key": "",
    "Minimax_group_id": ""
}

• model: 可填写abab6.5-chat
• Minimax_api_key：MiniMax平台的API-KEY，在 控制台 创建
• Minimax_group_id: 在 账户信息 右上角获取

方式二：OpenAI兼容方式接入，配置如下：

{
  "bot_type": "chatGPT",
  "model": "MiniMax-M1",
  "open_ai_api_base": "https://api.minimaxi.com/v1",
  "open_ai_api_key": ""
}

• bot_type: OpenAI兼容方式
• model: 可填MiniMax-M1、MiniMax-Text-01，参考API文档
• open_ai_api_base: MiniMax平台API的 BASE URL
• open_ai_api_key: MiniMax平台的API-KEY，在 控制台 创建

{
  "bot_type": "modelscope",
  "model": "Qwen/QwQ-32B",
  "modelscope_api_key": "your_api_key",
  "modelscope_base_url": "https://api-inference.modelscope.cn/v1/chat/completions",
  "text_to_image": "MusePublic/489_ckpt_FLUX_1"
}

• bot_type: modelscope接口格式
• model: 参考模型列表
• modelscope_api_key: 参考 官方文档-访问令牌 ，在 控制台
• modelscope_base_url: modelscope平台的 BASE URL
• text_to_image: 图像生成模型，参考模型列表

项目启动后默认运行web通道，配置如下：

{
    "channel_type": "web",
    "web_port": 9899
}

• web_port: 默认为 9899，可按需更改，需要服务器防火墙和安全组放行该端口
• 如本地运行，启动后请访问 http://localhost:port/chat ；如服务器运行，请访问 http://ip:port/chat

注：请将上述 url 中的 ip 或者 port 替换为实际的值

修改 config.json 中的 channel_type 字段：

{
    "channel_type": "terminal"
}

运行后可在终端与机器人进行对话。

本项目支持订阅号和服务号两种公众号，通过服务号(wechatmp_service)体验更佳。将下列配置加入 config.json：

{
    "channel_type": "wechatmp",
    "wechatmp_token": "TOKEN",
    "wechatmp_port": 80,
    "wechatmp_app_id": "APPID",
    "wechatmp_app_secret": "APPSECRET",
    "wechatmp_aes_key": ""
}

• channel_type: 个人订阅号为wechatmp，企业服务号为wechatmp_service

详细步骤和参数说明参考 微信公众号接入

企业微信自建应用接入需在后台创建应用并启用消息回调，配置示例：

{
    "channel_type": "wechatcom_app",
    "wechatcom_corp_id": "CORPID",
    "wechatcomapp_token": "TOKEN",
    "wechatcomapp_port": 9898,
    "wechatcomapp_secret": "SECRET",
    "wechatcomapp_agent_id": "AGENTID",
    "wechatcomapp_aes_key": "AESKEY"
}

详细步骤和参数说明参考 企微自建应用接入

钉钉需要在开放平台创建智能机器人应用，将以下配置填入 config.json：

{
    "channel_type": "dingtalk",
    "dingtalk_client_id": "CLIENT_ID",
    "dingtalk_client_secret": "CLIENT_SECRET"
}

详细步骤和参数说明参考 钉钉接入

通过自建应用接入AI相关能力到飞书应用中，默认已是飞书的企业用户，且具有企业管理权限，将以下配置填入 config.json：：

{
    "channel_type": "feishu",
    "feishu_app_id": "APP_ID",
    "feishu_app_secret": "APP_SECRET",
    "feishu_token": "VERIFICATION_TOKEN",
    "feishu_port": 80
}

详细步骤和参数说明参考 飞书接入