kaiyuan/chatgpt-on-wechat
1
0
Fork 0
mirror of https://github.com/zhayujie/chatgpt-on-wechat.git synced 2026-06-02 00:57:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(channel): add Discord channel

Browse Source
This commit is contained in:
zhayujie
2026-05-30 18:20:27 +08:00
parent 54a20bca92
commit c5b8e06891
18 changed files with 1055 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files

364
config.py
View File

@@ -8,211 +8,215 @@ import pickle
from common.log import logger
# 将所有可用的配置项写在字典里, 请使用小写字母
# 此处的配置值无实际意义，程序不会读取此处的配置，仅用于提示格式，请将配置加入到config.json中
# All available config keys are listed in this dict (use lowercase keys).
# The values here are placeholders only; the program does NOT read them.
# They merely document the expected format — put real values in config.json.
available_setting = {
# openai api配置
# openai api config
"open_ai_api_key": "", # openai api key
# openai apibase，当use_azure_chatgpt为true时，需要设置对应的api base
# openai api base; when use_azure_chatgpt is true, set the matching api base
"open_ai_api_base": "https://api.openai.com/v1",
"claude_api_base": "https://api.anthropic.com/v1", # claude api base
"gemini_api_base": "https://generativelanguage.googleapis.com", # gemini api base
"custom_api_key": "", # custom OpenAI-compatible provider api key (used when bot_type is "custom")
"custom_api_base": "", # custom OpenAI-compatible provider api base (used when bot_type is "custom")
"proxy": "", # openai使用的代理
# chatgpt模型， 当use_azure_chatgpt为true时，其名称为Azure上model deployment名称
"model": "gpt-3.5-turbo", # 可选择: gpt-4o, pt-4o-mini, gpt-4-turbo, claude-3-sonnet, wenxin, moonshot, qwen-turbo, xunfei, glm-4, minimax, gemini等模型，全部可选模型详见common/const.py文件
"bot_type": "", # 可选配置，使用兼容openai格式的三方服务时候，需填"openai"或"custom"（custom模式下切换模型不会自动切换bot_type）。bot具体名称详见common/const.py文件，如不填根据model名称判断
"use_azure_chatgpt": False, # 是否使用azure的chatgpt
"azure_deployment_id": "", # azure 模型部署名称
"azure_api_version": "", # azure api版本
# Bot触发配置
"single_chat_prefix": ["bot", "@bot"], # 私聊时文本需要包含该前缀才能触发机器人回复
"single_chat_reply_prefix": "[bot] ", # 私聊时自动回复的前缀，用于区分真人
"single_chat_reply_suffix": "", # 私聊时自动回复的后缀，\n 可以换行
"group_chat_prefix": ["@bot"], # 群聊时包含该前缀则会触发机器人回复
"no_need_at": False, # 群聊回复时是否不需要艾特
"group_chat_reply_prefix": "", # 群聊时自动回复的前缀
"group_chat_reply_suffix": "", # 群聊时自动回复的后缀，\n 可以换行
"group_chat_keyword": [], # 群聊时包含该关键词则会触发机器人回复
"group_at_off": False, # 是否关闭群聊时@bot的触发
"group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"], # 开启自动回复的群名称列表
"group_name_keyword_white_list": [], # 开启自动回复的群名称关键词列表
"group_chat_in_one_session": ["ChatGPT测试群"], # 支持会话上下文共享的群名称
"group_shared_session": False, # 群聊是否共享会话上下文（所有成员共享）。False时每个用户在群内有独立会话
"nick_name_black_list": [], # 用户昵称黑名单
"group_welcome_msg": "", # 配置新人进群固定欢迎语，不配置则使用随机风格欢迎
"trigger_by_self": False, # 是否允许机器人触发
"text_to_image": "dall-e-2", # 图片生成模型，可选 dall-e-2, dall-e-3
# Azure OpenAI dall-e-3 配置
"dalle3_image_style": "vivid", # 图片生成dalle3的风格，可选有 vivid, natural
"dalle3_image_quality": "hd", # 图片生成dalle3的质量，可选有 standard, hd
# Azure OpenAI DALL-E API 配置, 当use_azure_chatgpt为true时,用于将文字回复的资源和Dall-E的资源分开.
"azure_openai_dalle_api_base": "", # [可选] azure openai 用于回复图片的资源 endpoint，默认使用 open_ai_api_base
"azure_openai_dalle_api_key": "", # [可选] azure openai 用于回复图片的资源 key，默认使用 open_ai_api_key
"azure_openai_dalle_deployment_id":"", # [可选] azure openai 用于回复图片的资源 deployment id，默认使用 text_to_image
"image_proxy": True, # 是否需要图片代理，国内访问LinkAI时需要
"image_create_prefix": ["画", "看", "找"], # 开启图片回复的前缀
"concurrency_in_session": 1, # 同一会话最多有多少条消息在处理中，大于1可能乱序
"image_create_size": "256x256", # 图片大小,可选有 256x256, 512x512, 1024x1024 (dall-e-3默认为1024x1024)
"proxy": "", # proxy used by openai
# chatgpt model; when use_azure_chatgpt is true, this is the Azure model deployment name
"model": "gpt-3.5-turbo", # options: gpt-4o, gpt-4o-mini, gpt-4-turbo, claude-3-sonnet, wenxin, moonshot, qwen-turbo, xunfei, glm-4, minimax, gemini, etc. See common/const.py for the full list
"bot_type": "", # optional; for OpenAI-compatible third-party services set "openai" or "custom" (in custom mode switching model won't auto-switch bot_type). See common/const.py for bot names; inferred from model name if left empty
"use_azure_chatgpt": False, # whether to use Azure chatgpt
"azure_deployment_id": "", # azure model deployment name
"azure_api_version": "", # azure api version
# Bot trigger config
"single_chat_prefix": ["bot", "@bot"], # text must contain this prefix to trigger a reply in single chat
"single_chat_reply_prefix": "[bot] ", # auto-reply prefix in single chat, used to distinguish from a real person
"single_chat_reply_suffix": "", # auto-reply suffix in single chat; \n inserts a line break
"group_chat_prefix": ["@bot"], # messages containing this prefix trigger a reply in group chat
"no_need_at": False, # whether replying in group chat does not require an @mention
"group_chat_reply_prefix": "", # auto-reply prefix in group chat
"group_chat_reply_suffix": "", # auto-reply suffix in group chat; \n inserts a line break
"group_chat_keyword": [], # messages containing this keyword trigger a reply in group chat
"group_at_off": False, # whether to disable @bot triggering in group chat
"group_name_white_list": ["group1", "group2"], # group names where auto-reply is enabled
"group_name_keyword_white_list": [], # group-name keywords where auto-reply is enabled
"group_chat_in_one_session": ["group1"], # group names that share conversation context
"group_shared_session": False, # whether group chat shares conversation context (all members share). When False each user has an independent session in the group
"nick_name_black_list": [], # user nickname blacklist
"group_welcome_msg": "", # fixed welcome message for new group members; uses a random style when empty
"trigger_by_self": False, # whether the bot can be triggered by itself
"text_to_image": "dall-e-2", # image generation model, options: dall-e-2, dall-e-3
# Azure OpenAI dall-e-3 config
"dalle3_image_style": "vivid", # dalle3 image style, options: vivid, natural
"dalle3_image_quality": "hd", # dalle3 image quality, options: standard, hd
# Azure OpenAI DALL-E API config; when use_azure_chatgpt is true, separates the text-reply resource from the DALL-E resource
"azure_openai_dalle_api_base": "", # [optional] azure openai endpoint for image replies; defaults to open_ai_api_base
"azure_openai_dalle_api_key": "", # [optional] azure openai key for image replies; defaults to open_ai_api_key
"azure_openai_dalle_deployment_id":"", # [optional] azure openai deployment id for image replies; defaults to text_to_image
"image_proxy": True, # whether an image proxy is needed; required when accessing LinkAI from mainland China
"image_create_prefix": ["画", "看", "找"], # prefixes that enable image replies
"concurrency_in_session": 1, # max number of in-flight messages per session; values >1 may cause out-of-order replies
"image_create_size": "256x256", # image size, options: 256x256, 512x512, 1024x1024 (dall-e-3 defaults to 1024x1024)
"group_chat_exit_group": False,
# chatgpt会话参数
"expires_in_seconds": 3600, # 无操作会话的过期时间
# 人格描述
"character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。",
"conversation_max_tokens": 1000, # 支持上下文记忆的最多字符数
# chatgpt限流配置
"rate_limit_chatgpt": 20, # chatgpt的调用频率限制
"rate_limit_dalle": 50, # openai dalle的调用频率限制
# chatgpt api参数 参考https://platform.openai.com/docs/api-reference/chat/create
# chatgpt session params
"expires_in_seconds": 3600, # idle session expiry time
# persona description (only used in chat mode)
"character_desc": "You are a helpful AI assistant. You aim to answer and solve any questions people have, and can communicate in multiple languages.",
"conversation_max_tokens": 1000, # max characters of context memory
# chatgpt rate limit config
"rate_limit_chatgpt": 20, # chatgpt call rate limit
"rate_limit_dalle": 50, # openai dalle call rate limit
# chatgpt api params, see https://platform.openai.com/docs/api-reference/chat/create
"temperature": 0.9,
"top_p": 1,
"frequency_penalty": 0,
"presence_penalty": 0,
"request_timeout": 180, # chatgpt请求超时时间，openai接口默认设置为600，对于难问题一般需要较长时间
"timeout": 120, # chatgpt重试超时时间，在这个时间内，将会自动重试
# Baidu 文心一言参数
"baidu_wenxin_model": "eb-instant", # 默认使用ERNIE-Bot-turbo模型
"request_timeout": 180, # chatgpt request timeout; the openai api defaults to 600, hard questions usually need longer
"timeout": 120, # chatgpt retry timeout; will auto-retry within this window
# Baidu Wenxin (ERNIE) params
"baidu_wenxin_model": "eb-instant", # defaults to the ERNIE-Bot-turbo model
"baidu_wenxin_api_key": "", # Baidu api key
"baidu_wenxin_secret_key": "", # Baidu secret key
"baidu_wenxin_prompt_enabled": False, # Enable prompt if you are using ernie character model
# Baidu Qianfan / ERNIE OpenAI-compatible API
"qianfan_api_key": "", # Baidu Qianfan API key in bce-v3 format
"qianfan_api_base": "https://qianfan.baidubce.com/v2", # Qianfan OpenAI-compatible API base
# 讯飞星火API
"xunfei_app_id": "", # 讯飞应用ID
"xunfei_api_key": "", # 讯飞 API key
"xunfei_api_secret": "", # 讯飞 API secret
"xunfei_domain": "", # 讯飞模型对应的domain参数，Spark4.0 Ultra为 4.0Ultra，其他模型详见: https://www.xfyun.cn/doc/spark/Web.html
"xunfei_spark_url": "", # 讯飞模型对应的请求地址，Spark4.0 Ultra为 wss://spark-api.xf-yun.com/v4.0/chat，其他模型参考详见: https://www.xfyun.cn/doc/spark/Web.html
# claude 配置
# Xunfei Spark API
"xunfei_app_id": "", # Xunfei app id
"xunfei_api_key": "", # Xunfei API key
"xunfei_api_secret": "", # Xunfei API secret
"xunfei_domain": "", # Xunfei model domain param; for Spark4.0 Ultra it is 4.0Ultra, see https://www.xfyun.cn/doc/spark/Web.html for others
"xunfei_spark_url": "", # Xunfei model request url; for Spark4.0 Ultra it is wss://spark-api.xf-yun.com/v4.0/chat, see https://www.xfyun.cn/doc/spark/Web.html for others
# claude config
"claude_api_cookie": "",
"claude_uuid": "",
# claude api key
"claude_api_key": "",
# 通义千问API, 获取方式查看文档 https://help.aliyun.com/document_detail/2587494.html
# Tongyi Qianwen API, see https://help.aliyun.com/document_detail/2587494.html for how to obtain
"qwen_access_key_id": "",
"qwen_access_key_secret": "",
"qwen_agent_key": "",
"qwen_app_id": "",
"qwen_node_id": "", # 流程编排模型用到的id，如果没有用到qwen_node_id，请务必保持为空字符串
# 阿里灵积(通义新版sdk)模型api key
"qwen_node_id": "", # id used by workflow-orchestration models; keep it an empty string if qwen_node_id is unused
# Alibaba Lingji (Tongyi new sdk) model api key
"dashscope_api_key": "",
# Google Gemini Api Key
"gemini_api_key": "",
# Embedding 模型设置
"embedding_provider": "", # 显式指定厂商：openai / linkai / dashscope / doubao / zhipu (与 bot_type 命名一致)
"embedding_model": "", # 留空使用厂商默认 model
"embedding_dimensions": 0, # 留空/0 使用厂商默认维度（推荐统一 1024）
# 语音设置
"speech_recognition": True, # 是否开启语音识别
"group_speech_recognition": False, # 是否开启群组语音识别
"voice_reply_voice": False, # 是否使用语音回复语音，需要设置对应语音合成引擎的api key
"always_reply_voice": False, # 是否一直使用语音回复
"voice_to_text": "openai", # 语音识别引擎，支持openai,baidu,google,azure,xunfei,ali
"text_to_voice": "openai", # 语音合成引擎，支持openai,baidu,google,azure,xunfei,ali,pytts(offline),elevenlabs,edge(online)
# Embedding model config
"embedding_provider": "", # explicitly set the provider: openai / linkai / dashscope / doubao / zhipu (aligned with bot_type naming)
"embedding_model": "", # leave empty to use the provider's default model
"embedding_dimensions": 0, # leave empty/0 to use the provider's default dimension (1024 recommended for consistency)
# voice config
"speech_recognition": True, # whether to enable speech recognition
"group_speech_recognition": False, # whether to enable group speech recognition
"voice_reply_voice": False, # whether to reply to voice with voice; requires the matching TTS engine api key
"always_reply_voice": False, # whether to always reply with voice
"voice_to_text": "openai", # speech recognition engine: openai,baidu,google,azure,xunfei,ali
"text_to_voice": "openai", # TTS engine: openai,baidu,google,azure,xunfei,ali,pytts(offline),elevenlabs,edge(online)
"text_to_voice_model": "tts-1",
"tts_voice_id": "alloy",
# baidu 语音api配置， 使用百度语音识别和语音合成时需要
# baidu voice api config; required when using Baidu speech recognition and TTS
"baidu_app_id": "",
"baidu_api_key": "",
"baidu_secret_key": "",
# 1536普通话(支持简单的英文识别) 1737英语 1637粤语 1837四川话 1936普通话远场
# 1536 Mandarin (with basic English) 1737 English 1637 Cantonese 1837 Sichuanese 1936 Mandarin far-field
"baidu_dev_pid": 1536,
# azure 语音api配置， 使用azure语音识别和语音合成时需要
# azure voice api config; required when using Azure speech recognition and TTS
"azure_voice_api_key": "",
"azure_voice_region": "japaneast",
# elevenlabs 语音api配置
"xi_api_key": "", # 获取ap的方法可以参考https://docs.elevenlabs.io/api-reference/quick-start/authentication
"xi_voice_id": "", # ElevenLabs提供了9种英式、美式等英语发音id，分别是“Adam/Antoni/Arnold/Bella/Domi/Elli/Josh/Rachel/Sam”
# 服务时间限制
"chat_time_module": False, # 是否开启服务时间限制
"chat_start_time": "00:00", # 服务开始时间
"chat_stop_time": "24:00", # 服务结束时间
# 翻译api
"translate": "baidu", # 翻译api，支持baidu, youdao
# baidu翻译api的配置
"baidu_translate_app_id": "", # 百度翻译api的appid
"baidu_translate_app_key": "", # 百度翻译api的秘钥
# youdao翻译api的配置
"youdao_translate_app_key": "", # 有道翻译api的应用ID
"youdao_translate_app_secret": "", # 有道翻译api的应用密钥
# wechatmp的配置
"wechatmp_token": "", # 微信公众平台的Token
"wechatmp_port": 8080, # 微信公众平台的端口,需要端口转发到80或443
"wechatmp_app_id": "", # 微信公众平台的appID
"wechatmp_app_secret": "", # 微信公众平台的appsecret
"wechatmp_aes_key": "", # 微信公众平台的EncodingAESKey，加密模式需要
# wechatcom的通用配置
"wechatcom_corp_id": "", # 企业微信公司的corpID
# wechatcomapp的配置
"wechatcomapp_token": "", # 企业微信app的token
"wechatcomapp_port": 9898, # 企业微信app的服务端口,不需要端口转发
"wechatcomapp_secret": "", # 企业微信app的secret
"wechatcomapp_agent_id": "", # 企业微信app的agent_id
"wechatcomapp_aes_key": "", # 企业微信app的aes_key
# 微信客服(wechat_kf)的配置
"wechat_kf_corp_id": "", # 微信客服所在企业的corp_id
"wechat_kf_token": "", # 微信客服回调token
"wechat_kf_port": 9888, # 微信客服回调服务端口
"wechat_kf_secret": "", # 微信客服应用的secret
"wechat_kf_aes_key": "", # 微信客服回调aes_key
"wechat_kf_cursor_path": "~/.wechat_kf_cursors.json", # 微信客服sync_msg游标持久化文件路径
# 飞书配置
"feishu_port": 80, # 飞书bot监听端口，仅webhook模式需要
"feishu_app_id": "", # 飞书机器人应用APP Id
"feishu_app_secret": "", # 飞书机器人APP secret
"feishu_token": "", # 飞书 verification token，仅webhook模式需要
"feishu_event_mode": "websocket", # 飞书事件接收模式: webhook(HTTP服务器) 或 websocket(长连接)
# 飞书流式回复（基于官方 cardkit 流式卡片 API，需要机器人开通 cardkit:card:write 权限，且飞书客户端 7.20+）
"feishu_stream_reply": True, # 是否开启流式回复（打字机效果）。失败/老客户端自动降级为非流式或升级提示
# 钉钉配置
"dingtalk_client_id": "", # 钉钉机器人Client ID
"dingtalk_client_secret": "", # 钉钉机器人Client Secret
# elevenlabs voice api config
"xi_api_key": "", # see https://docs.elevenlabs.io/api-reference/quick-start/authentication for how to obtain the api key
"xi_voice_id": "", # ElevenLabs offers 9 English voice ids: Adam/Antoni/Arnold/Bella/Domi/Elli/Josh/Rachel/Sam
# service time limit
"chat_time_module": False, # whether to enable service-time limiting
"chat_start_time": "00:00", # service start time
"chat_stop_time": "24:00", # service stop time
# translation api
"translate": "baidu", # translation api: baidu, youdao
# baidu translation api config
"baidu_translate_app_id": "", # baidu translation api appid
"baidu_translate_app_key": "", # baidu translation api secret key
# youdao translation api config
"youdao_translate_app_key": "", # youdao translation api app id
"youdao_translate_app_secret": "", # youdao translation api app secret
# wechatmp config
"wechatmp_token": "", # WeChat Official Account token
"wechatmp_port": 8080, # WeChat Official Account port; needs port forwarding to 80 or 443
"wechatmp_app_id": "", # WeChat Official Account appID
"wechatmp_app_secret": "", # WeChat Official Account appsecret
"wechatmp_aes_key": "", # WeChat Official Account EncodingAESKey; required in encrypted mode
# wechatcom shared config
"wechatcom_corp_id": "", # WeCom corp id
# wechatcomapp config
"wechatcomapp_token": "", # WeCom app token
"wechatcomapp_port": 9898, # WeCom app service port; no port forwarding needed
"wechatcomapp_secret": "", # WeCom app secret
"wechatcomapp_agent_id": "", # WeCom app agent_id
"wechatcomapp_aes_key": "", # WeCom app aes_key
# WeCom Customer Service (wechat_kf) config
"wechat_kf_corp_id": "", # corp_id of the company the WeCom Customer Service belongs to
"wechat_kf_token": "", # WeCom Customer Service callback token
"wechat_kf_port": 9888, # WeCom Customer Service callback service port
"wechat_kf_secret": "", # WeCom Customer Service app secret
"wechat_kf_aes_key": "", # WeCom Customer Service callback aes_key
"wechat_kf_cursor_path": "~/.wechat_kf_cursors.json", # path for persisting the WeCom Customer Service sync_msg cursor
# Feishu config
"feishu_port": 80, # Feishu bot listening port; only needed in webhook mode
"feishu_app_id": "", # Feishu bot app id
"feishu_app_secret": "", # Feishu bot app secret
"feishu_token": "", # Feishu verification token; only needed in webhook mode
"feishu_event_mode": "websocket", # Feishu event mode: webhook(HTTP server) or websocket(long connection)
# Feishu streaming reply (based on the official cardkit streaming-card API; requires the cardkit:card:write permission and Feishu client 7.20+)
"feishu_stream_reply": True, # whether to enable streaming reply (typewriter effect); auto-downgrades to non-streaming or shows an upgrade prompt on failure/old clients
# DingTalk config
"dingtalk_client_id": "", # DingTalk bot Client ID
"dingtalk_client_secret": "", # DingTalk bot Client Secret
"dingtalk_card_enabled": False,
# 企微智能机器人配置(长连接模式)
"wecom_bot_id": "", # 企微智能机器人BotID
"wecom_bot_secret": "", # 企微智能机器人长连接Secret
# Telegram 配置
"telegram_token": "", # 从 @BotFather 申请的 bot token
"telegram_proxy": "", # 可选的 HTTP/SOCKS5 代理，例如 http://127.0.0.1:7890 或 socks5://127.0.0.1:1080（留空则走系统环境变量）
"telegram_group_trigger": "mention_or_reply", # 群聊触发方式: mention_or_reply(@或回复触发,推荐) | mention_only(仅@) | all(所有消息)
"telegram_register_commands": True, # 启动时是否自动向 BotFather 注册命令菜单（与 web 端 slash 命令一致）
# Slack 配置（Socket Mode，无需公网 IP）
"slack_bot_token": "", # Bot User OAuth Token，形如 xoxb-...
"slack_app_token": "", # App-Level Token（开启 Socket Mode 后生成），形如 xapp-...
"slack_group_trigger": "mention_or_reply", # 频道触发方式: mention_or_reply(@或线程内回复,推荐) | mention_only(仅@) | all(所有消息)
# 微信配置
"weixin_token": "", # 微信登录后获取的bot_token，留空则启动时自动扫码登录
# WeCom smart bot config (long connection mode)
"wecom_bot_id": "", # WeCom smart bot BotID
"wecom_bot_secret": "", # WeCom smart bot long-connection secret
# Telegram config
"telegram_token": "", # Bot token from @BotFather
"telegram_proxy": "", # Optional HTTP/SOCKS5 proxy, e.g. http://127.0.0.1:7890 or socks5://127.0.0.1:1080 (empty falls back to env vars)
"telegram_group_trigger": "mention_or_reply", # Group trigger: mention_or_reply(@ or reply, recommended) | mention_only(@ only) | all(every message)
"telegram_register_commands": True, # Auto-register the BotFather command menu on startup (aligned with web slash commands)
# Slack config (Socket Mode, no public IP required)
"slack_bot_token": "", # Bot User OAuth Token, like xoxb-...
"slack_app_token": "", # App-Level Token (generated after enabling Socket Mode), like xapp-...
"slack_group_trigger": "mention_or_reply", # Channel trigger: mention_or_reply(@ or reply in thread, recommended) | mention_only(@ only) | all(every message)
# Discord config (Gateway connection, no public IP required)
"discord_token": "", # Discord Bot Token (generated on the Bot page of the Developer Portal)
"discord_group_trigger": "mention_or_reply", # Channel trigger: mention_or_reply(@ or reply to bot, recommended) | mention_only(@ only) | all(every message)
# WeChat config
"weixin_token": "", # bot_token obtained after WeChat login; leave empty to auto scan-login on startup
"weixin_base_url": "https://ilinkai.weixin.qq.com", # Weixin ilink API base URL
"weixin_cdn_base_url": "https://novac2c.cdn.weixin.qq.com/c2c", # CDN base URL
"weixin_credentials_path": "~/.weixin_cow_credentials.json", # credentials file path
# chatgpt指令自定义触发词
"clear_memory_commands": ["#清除记忆"], # 重置会话指令，必须以#开头
# channel配置
"channel_type": "", # 通道类型，支持多渠道同时运行。单个: "feishu"，多个: "feishu, dingtalk" 或 ["feishu", "dingtalk"]。可选值: web,feishu,dingtalk,wecom_bot,weixin,wechatmp,wechatmp_service,wechatcom_app,wechat_kf,telegram,slack
"web_console": True, # 是否自动启动Web控制台（默认启动）。设为False可禁用
"subscribe_msg": "", # 订阅消息, 支持: wechatmp, wechatmp_service, wechatcom_app
"debug": False, # 是否开启debug模式，开启后会打印更多日志
"appdata_dir": "", # 数据目录
# 插件配置
"plugin_trigger_prefix": "$", # 规范插件提供聊天相关指令的前缀，建议不要和管理员指令前缀"#"冲突
# 是否使用全局插件配置
# custom trigger words for chatgpt commands
"clear_memory_commands": ["#清除记忆"], # session-reset command; must start with #
# channel config
"channel_type": "", # channel type; supports running multiple channels at once. Single: "feishu", multiple: "feishu, dingtalk" or ["feishu", "dingtalk"]. Options: web,feishu,dingtalk,wecom_bot,weixin,wechatmp,wechatmp_service,wechatcom_app,wechat_kf,telegram,slack,discord
"web_console": True, # whether to auto-start the Web console (on by default). Set False to disable
"subscribe_msg": "", # subscribe message; supported by: wechatmp, wechatmp_service, wechatcom_app
"debug": False, # whether to enable debug mode; prints more logs when on
"appdata_dir": "", # data directory
# plugin config
"plugin_trigger_prefix": "$", # prefix for plugin chat commands; avoid clashing with the admin command prefix "#"
# whether to use the global plugin config
"use_global_plugin_config": False,
"max_media_send_count": 3, # 单次最大发送媒体资源的个数
"media_send_interval": 1, # 发送图片的事件间隔，单位秒
# 智谱AI 平台配置
"max_media_send_count": 3, # max number of media resources sent at once
"media_send_interval": 1, # interval between sending images, in seconds
# Zhipu AI platform config
"zhipu_ai_api_key": "",
"zhipu_ai_api_base": "https://open.bigmodel.cn/api/paas/v4",
"moonshot_api_key": "",
"moonshot_base_url": "https://api.moonshot.cn/v1",
# 豆包(火山方舟) 平台配置
# Doubao (Volcano Ark) platform config
"ark_api_key": "",
"ark_base_url": "https://ark.cn-beijing.volces.com/api/v3",
# 魔搭社区 平台配置
# ModelScope community platform config
"modelscope_api_key": "",
"modelscope_base_url": "https://api-inference.modelscope.cn/v1/chat/completions",
# LinkAI平台配置
# LinkAI platform config
"use_linkai": False,
"linkai_api_key": "",
"linkai_app_code": "",
@@ -225,7 +229,7 @@ available_setting = {
"Minimax_base_url": "",
"deepseek_api_key": "",
"deepseek_api_base": "https://api.deepseek.com/v1",
# 小米 MiMo 大模型
# Xiaomi MiMo LLM
"mimo_api_key": "",
"mimo_api_base": "https://api.xiaomimimo.com/v1",
"web_host": "", # Web console bind address; empty means auto
@@ -233,14 +237,14 @@ available_setting = {
"web_password": "", # Web console password; empty means no authentication required
"web_session_expire_days": 30, # Auth session expiry in days
"web_file_serve_root": "~", # Root dir the /api/file endpoint may serve; "/" allows the whole filesystem
"agent": True, # 是否开启Agent模式
"agent_workspace": "~/cow", # agent工作空间路径，用于存储skills、memory等
"agent_max_context_tokens": 50000, # Agent模式下最大上下文tokens
"agent_max_context_turns": 20, # Agent模式下最大上下文记忆轮次
"agent_max_steps": 20, # Agent模式下单次运行最大决策步数
"agent": True, # whether to enable Agent mode
"agent_workspace": "~/cow", # agent workspace path, used to store skills, memory, etc.
"agent_max_context_tokens": 50000, # max context tokens in Agent mode
"agent_max_context_turns": 20, # max context memory turns in Agent mode
"agent_max_steps": 20, # max decision steps per run in Agent mode
"enable_thinking": False, # Enable deep-thinking mode for thinking-capable models
"reasoning_effort": "high", # Reasoning depth under thinking mode: "high" or "max"
"knowledge": True, # 是否开启知识库功能
"knowledge": True, # whether to enable the knowledge base feature
"skill": {}, # Per-skill runtime config; nested keys flatten to SKILL_<NAME>_<KEY> env vars at startup
"mcp_servers": [], # MCP server list; each entry supports type "stdio" (local process) or "sse" (remote URL)
}
@@ -253,7 +257,7 @@ class Config(dict):
d = {}
for k, v in d.items():
self[k] = v
# user_datas: 用户数据，key为用户名，value为用户数据，也是dict
# user_datas: per-user data; key is the username, value is the user's data (also a dict)
self.user_datas = {}
def __getitem__(self, key):
@@ -263,11 +267,11 @@ class Config(dict):
return super().__setitem__(key, value)
def get(self, key, default=None):
# 跳过以下划线开头的注释字段
# skip comment fields starting with an underscore
if key.startswith("_"):
return super().get(key, default)
# 如果key不在available_setting中，直接走dict的get，返回config.json中实际加载的值（如不存在则返回default）
# if the key is not in available_setting, fall back to dict.get and return the value actually loaded from config.json (or default if absent)
if key not in available_setting:
return super().get(key, default)
@@ -334,7 +338,7 @@ def drag_sensitive(config):
def load_config():
global config
# 打印 ASCII Logo
# print ASCII logo
logger.info(" ____ _ _ ")
logger.info(" / ___|_____ __ / \\ __ _ ___ _ __ | |_ ")
logger.info("| | / _ \\ \\ /\\ / // _ \\ / _` |/ _ \\ '_ \\| __|")
@@ -344,13 +348,13 @@ def load_config():
logger.info("")
config_path = "./config.json"
if not os.path.exists(config_path):
logger.info("配置文件不存在，将使用config-template.json模板")
logger.info("config file not found, falling back to config-template.json")
config_path = "./config-template.json"
config_str = read_file(config_path)
logger.debug("[INIT] config str: {}".format(drag_sensitive(config_str)))
# 将json字符串反序列化为dict类型。
# Deserialize the json string into a dict.
# `object_pairs_hook` lets us catch users who accidentally typed the
# same key twice (e.g. two `"tools"` blocks) — json.loads would
# otherwise silently drop all but the last occurrence.
@@ -367,7 +371,7 @@ def load_config():
# Some online deployment platforms (e.g. Railway) deploy project from github directly. So you shouldn't put your secrets like api key in a config file, instead use environment variables to override the default config.
for name, value in os.environ.items():
name = name.lower()
# 跳过以下划线开头的注释字段
# skip comment fields starting with an underscore
if name.startswith("_"):
continue
if name in available_setting:
@@ -388,19 +392,19 @@ def load_config():
logger.info("[INIT] load config: {}".format(drag_sensitive(config)))
# 打印系统初始化信息
# print system initialization info
logger.info("[INIT] ========================================")
logger.info("[INIT] System Initialization")
logger.info("[INIT] ========================================")
logger.info("[INIT] Channel: {}".format(config.get("channel_type", "unknown")))
logger.info("[INIT] Model: {}".format(config.get("model", "unknown")))
# Agent模式信息
# Agent mode info
if config.get("agent", True):
workspace = config.get("agent_workspace", "~/cow")
logger.info("[INIT] Mode: Agent (workspace: {})".format(workspace))
else:
logger.info("[INIT] Mode: Chat (在config.json中设置 \"agent\":true 可启用Agent模式)")
logger.info("[INIT] Mode: Chat (set \"agent\":true in config.json to enable Agent mode)")
logger.info("[INIT] Debug: {}".format(config.get("debug", False)))
logger.info("[INIT] ========================================")
@@ -609,8 +613,8 @@ plugin_config = {}
def write_plugin_config(pconf: dict):
"""
写入插件全局配置
:param pconf: 全量插件配置
Write the global plugin config.
:param pconf: the full plugin config
"""
global plugin_config
for k in pconf:
@@ -618,8 +622,8 @@ def write_plugin_config(pconf: dict):
def remove_plugin_config(name: str):
"""
移除待重新加载的插件全局配置
:param name: 待重载的插件名
Remove the global config of a plugin pending reload.
:param name: name of the plugin to reload
"""
global plugin_config
plugin_config.pop(name.lower(), None)
@@ -627,12 +631,12 @@ def remove_plugin_config(name: str):
def pconf(plugin_name: str) -> dict:
"""
根据插件名称获取配置
:param plugin_name: 插件名称
:return: 该插件的配置项
Get the config for a plugin by name.
:param plugin_name: plugin name
:return: the plugin's config
"""
return plugin_config.get(plugin_name.lower())
# 全局配置，用于存放全局生效的状态
# global config holding globally-effective state
global_config = {"admin_users": []}