config.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383
  1. # encoding:utf-8
  2. import json
  3. import logging
  4. import os
  5. import pickle
  6. import copy
  7. from common.log import logger
  8. # 将所有可用的配置项写在字典里, 请使用小写字母
  9. # 此处的配置值无实际意义,程序不会读取此处的配置,仅用于提示格式,请将配置加入到config.json中
  10. available_setting = {
  11. # webui配置
  12. "web_ui_port": 7860,
  13. "web_ui_username": "dow",
  14. "web_ui_password": "dify-on-wechat",
  15. # 错误回复消息
  16. "error_reply": "我暂时遇到了一些问题,请您稍后重试~",
  17. # openai api配置
  18. "open_ai_api_key": "", # openai api key
  19. # openai apibase,当use_azure_chatgpt为true时,需要设置对应的api base
  20. "open_ai_api_base": "https://api.openai.com/v1",
  21. "proxy": "", # openai使用的代理
  22. # chatgpt模型, 当use_azure_chatgpt为true时,其名称为Azure上model deployment名称
  23. "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文件
  24. "bot_type": "", # 可选配置,使用兼容openai格式的三方服务时候,需填"chatGPT"。bot具体名称详见common/const.py文件列出的bot_type,如不填根据model名称判断,
  25. "use_azure_chatgpt": False, # 是否使用azure的chatgpt
  26. "azure_deployment_id": "", # azure 模型部署名称
  27. "azure_api_version": "", # azure api版本
  28. # Bot触发配置
  29. "single_chat_prefix": ["bot", "@bot"], # 私聊时文本需要包含该前缀才能触发机器人回复
  30. "single_chat_reply_prefix": "[bot] ", # 私聊时自动回复的前缀,用于区分真人
  31. "single_chat_reply_suffix": "", # 私聊时自动回复的后缀,\n 可以换行
  32. "accept_friend_commands": ["加好友"], # 自动接受好友请求的申请信息
  33. "group_chat_prefix": ["@bot"], # 群聊时包含该前缀则会触发机器人回复
  34. "no_need_at": False, # 群聊回复时是否不需要艾特
  35. "group_chat_reply_prefix": "", # 群聊时自动回复的前缀
  36. "group_chat_reply_suffix": "", # 群聊时自动回复的后缀,\n 可以换行
  37. "group_chat_keyword": [], # 群聊时包含该关键词则会触发机器人回复
  38. "group_at_off": False, # 是否关闭群聊时@bot的触发
  39. "group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"], # 开启自动回复的群名称列表
  40. "group_name_keyword_white_list": [], # 开启自动回复的群名称关键词列表
  41. "group_chat_in_one_session": ["ChatGPT测试群"], # 支持会话上下文共享的群名称
  42. "nick_name_black_list": [], # 用户昵称黑名单
  43. "group_welcome_msg": "", # 配置新人进群固定欢迎语,不配置则使用随机风格欢迎
  44. "trigger_by_self": False, # 是否允许机器人触发
  45. "text_to_image": "dall-e-2", # 图片生成模型,可选 dall-e-2, dall-e-3
  46. # Azure OpenAI dall-e-3 配置
  47. "dalle3_image_style": "vivid", # 图片生成dalle3的风格,可选有 vivid, natural
  48. "dalle3_image_quality": "hd", # 图片生成dalle3的质量,可选有 standard, hd
  49. # Azure OpenAI DALL-E API 配置, 当use_azure_chatgpt为true时,用于将文字回复的资源和Dall-E的资源分开.
  50. "azure_openai_dalle_api_base": "", # [可选] azure openai 用于回复图片的资源 endpoint,默认使用 open_ai_api_base
  51. "azure_openai_dalle_api_key": "", # [可选] azure openai 用于回复图片的资源 key,默认使用 open_ai_api_key
  52. "azure_openai_dalle_deployment_id":"", # [可选] azure openai 用于回复图片的资源 deployment id,默认使用 text_to_image
  53. "image_proxy": True, # 是否需要图片代理,国内访问LinkAI时需要
  54. "image_create_prefix": ["画", "看", "找"], # 开启图片回复的前缀
  55. "concurrency_in_session": 1, # 同一会话最多有多少条消息在处理中,大于1可能乱序
  56. "image_create_size": "256x256", # 图片大小,可选有 256x256, 512x512, 1024x1024 (dall-e-3默认为1024x1024)
  57. "group_chat_exit_group": False,
  58. "group_exit_msg": "", # 退出群聊的消息
  59. "accept_friend_msg": "", # 接受好友请求后发送的消息
  60. # chatgpt会话参数
  61. "expires_in_seconds": 3600, # 无操作会话的过期时间
  62. # 人格描述
  63. "character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题,并且可以使用多种语言与人交流。",
  64. "conversation_max_tokens": 1000, # 支持上下文记忆的最多字符数
  65. # chatgpt限流配置
  66. "rate_limit_chatgpt": 20, # chatgpt的调用频率限制
  67. "rate_limit_dalle": 50, # openai dalle的调用频率限制
  68. # chatgpt api参数 参考https://platform.openai.com/docs/api-reference/chat/create
  69. "temperature": 0.9,
  70. "top_p": 1,
  71. "frequency_penalty": 0,
  72. "presence_penalty": 0,
  73. "request_timeout": 180, # chatgpt请求超时时间,openai接口默认设置为600,对于难问题一般需要较长时间
  74. "timeout": 120, # chatgpt重试超时时间,在这个时间内,将会自动重试
  75. # Baidu 文心一言参数
  76. "baidu_wenxin_model": "eb-instant", # 默认使用ERNIE-Bot-turbo模型
  77. "baidu_wenxin_api_key": "", # Baidu api key
  78. "baidu_wenxin_secret_key": "", # Baidu secret key
  79. "baidu_wenxin_prompt_enabled": False, # Enable prompt if you are using ernie character model
  80. # 讯飞星火API
  81. "xunfei_app_id": "", # 讯飞应用ID
  82. "xunfei_api_key": "", # 讯飞 API key
  83. "xunfei_api_secret": "", # 讯飞 API secret
  84. "xunfei_domain": "", # 讯飞模型对应的domain参数,Spark4.0 Ultra为 4.0Ultra,其他模型详见: https://www.xfyun.cn/doc/spark/Web.html
  85. "xunfei_spark_url": "", # 讯飞模型对应的请求地址,Spark4.0 Ultra为 wss://spark-api.xf-yun.com/v4.0/chat,其他模型参考详见: https://www.xfyun.cn/doc/spark/Web.html
  86. # claude 配置
  87. "claude_api_cookie": "",
  88. "claude_uuid": "",
  89. # claude api key
  90. "claude_api_key": "",
  91. # 通义千问API, 获取方式查看文档 https://help.aliyun.com/document_detail/2587494.html
  92. "qwen_access_key_id": "",
  93. "qwen_access_key_secret": "",
  94. "qwen_agent_key": "",
  95. "qwen_app_id": "",
  96. "qwen_node_id": "", # 流程编排模型用到的id,如果没有用到qwen_node_id,请务必保持为空字符串
  97. # 阿里灵积(通义新版sdk)模型api key
  98. "dashscope_api_key": "",
  99. # Google Gemini Api Key
  100. "gemini_api_key": "",
  101. # dify配置
  102. "dify_api_base": "https://api.dify.ai/v1",
  103. "dify_api_key": "app-xxx",
  104. "dify_app_type": "chatbot", # dify助手类型 chatbot(对应聊天助手)/agent(对应Agent)/workflow(对应工作流),默认为chatbot
  105. "dify_conversation_max_messages": 5, # dify目前不支持设置历史消息长度,暂时使用超过最大消息数清空会话的策略,缺点是没有滑动窗口,会突然丢失历史消息,当设置的值小于等于0,则不限制历史消息长度
  106. # coze配置
  107. "coze_api_base": "https://api.coze.cn",
  108. "coze_api_key": "xxx",
  109. "coze_bot_id": "xxx",
  110. "coze_return_show_img": "false",
  111. # wework的通用配置
  112. "wework_smart": True, # 配置wework是否使用已登录的企业微信,False为多开
  113. # 语音设置
  114. "speech_recognition": False, # 是否开启语音识别
  115. "group_speech_recognition": False, # 是否开启群组语音识别
  116. "voice_reply_voice": False, # 是否使用语音回复语音,需要设置对应语音合成引擎的api key
  117. "always_reply_voice": False, # 是否一直使用语音回复
  118. "voice_to_text": "openai", # 语音识别引擎,支持openai,baidu,google,azure,xunfei,ali
  119. "text_to_voice": "openai", # 语音合成引擎,支持openai,baidu,google,azure,xunfei,ali,pytts(offline),elevenlabs,edge(online)
  120. "text_to_voice_model": "tts-1",
  121. "tts_voice_id": "alloy",
  122. # baidu 语音api配置, 使用百度语音识别和语音合成时需要
  123. "baidu_app_id": "",
  124. "baidu_api_key": "",
  125. "baidu_secret_key": "",
  126. # 1536普通话(支持简单的英文识别) 1737英语 1637粤语 1837四川话 1936普通话远场
  127. "baidu_dev_pid": 1536,
  128. # azure 语音api配置, 使用azure语音识别和语音合成时需要
  129. "azure_voice_api_key": "",
  130. "azure_voice_region": "japaneast",
  131. # elevenlabs 语音api配置
  132. "xi_api_key": "", #获取ap的方法可以参考https://docs.elevenlabs.io/api-reference/quick-start/authentication
  133. "xi_voice_id": "", #ElevenLabs提供了9种英式、美式等英语发音id,分别是“Adam/Antoni/Arnold/Bella/Domi/Elli/Josh/Rachel/Sam”
  134. # 图像模型设置
  135. "image_recognition": False, # 是否开启图片识别
  136. # 服务时间限制,目前支持itchat
  137. "chat_time_module": False, # 是否开启服务时间限制
  138. "chat_start_time": "00:00", # 服务开始时间
  139. "chat_stop_time": "24:00", # 服务结束时间
  140. # 翻译api
  141. "translate": "baidu", # 翻译api,支持baidu
  142. # baidu翻译api的配置
  143. "baidu_translate_app_id": "", # 百度翻译api的appid
  144. "baidu_translate_app_key": "", # 百度翻译api的秘钥
  145. # itchat的配置
  146. "hot_reload": False, # 是否开启热重载
  147. # wechaty的配置
  148. "wechaty_puppet_service_token": "", # wechaty的token
  149. # wechatmp的配置
  150. "wechatmp_token": "", # 微信公众平台的Token
  151. "wechatmp_port": 8080, # 微信公众平台的端口,需要端口转发到80或443
  152. "wechatmp_app_id": "", # 微信公众平台的appID
  153. "wechatmp_app_secret": "", # 微信公众平台的appsecret
  154. "wechatmp_aes_key": "", # 微信公众平台的EncodingAESKey,加密模式需要
  155. # wechatcom的通用配置
  156. "wechatcom_corp_id": "", # 企业微信公司的corpID
  157. # wechatcomapp的配置
  158. "wechatcomapp_token": "", # 企业微信app的token
  159. "wechatcomapp_port": 9898, # 企业微信app的服务端口,不需要端口转发
  160. "wechatcomapp_secret": "", # 企业微信app的secret
  161. "wechatcomapp_agent_id": "", # 企业微信app的agent_id
  162. "wechatcomapp_aes_key": "", # 企业微信app的aes_key
  163. # 飞书配置
  164. "feishu_port": 80, # 飞书bot监听端口
  165. "feishu_app_id": "", # 飞书机器人应用APP Id
  166. "feishu_app_secret": "", # 飞书机器人APP secret
  167. "feishu_token": "", # 飞书 verification token
  168. "feishu_bot_name": "", # 飞书机器人的名字
  169. # 钉钉配置
  170. "dingtalk_client_id": "", # 钉钉机器人Client ID
  171. "dingtalk_client_secret": "", # 钉钉机器人Client Secret
  172. "dingtalk_card_enabled": False,
  173. ## gewechat配置
  174. "gewechat_base_url": "",
  175. "gewechat_download_url": "",
  176. "gewechat_token": "",
  177. "gewechat_app_id": "",
  178. "gewechat_callback_server_port": 9919,
  179. # chatgpt指令自定义触发词
  180. "clear_memory_commands": ["#清除记忆"], # 重置会话指令,必须以#开头
  181. # channel配置
  182. "channel_type": "", # 通道类型,支持:{wx,wxy,terminal,wechatmp,wechatmp_service,wechatcom_app,dingtalk}
  183. "subscribe_msg": "", # 订阅消息, 支持: wechatmp, wechatmp_service, wechatcom_app
  184. "debug": False, # 是否开启debug模式,开启后会打印更多日志
  185. "appdata_dir": "", # 数据目录
  186. # 插件配置
  187. "plugin_trigger_prefix": "$", # 规范插件提供聊天相关指令的前缀,建议不要和管理员指令前缀"#"冲突
  188. # 是否使用全局插件配置
  189. "use_global_plugin_config": False,
  190. "max_media_send_count": 3, # 单次最大发送媒体资源的个数
  191. "media_send_interval": 1, # 发送图片的事件间隔,单位秒
  192. # 智谱AI 平台配置
  193. "zhipu_ai_api_key": "",
  194. "zhipu_ai_api_base": "https://open.bigmodel.cn/api/paas/v4",
  195. "moonshot_api_key": "",
  196. "moonshot_base_url": "https://api.moonshot.cn/v1/chat/completions",
  197. # LinkAI平台配置
  198. "use_linkai": False,
  199. "linkai_api_key": "",
  200. "linkai_app_code": "",
  201. "linkai_api_base": "https://api.link-ai.tech", # linkAI服务地址
  202. "Minimax_api_key": "",
  203. "Minimax_group_id": "",
  204. "Minimax_base_url": "",
  205. }
  206. class Config(dict):
  207. def __init__(self, d=None):
  208. super().__init__()
  209. if d is None:
  210. d = {}
  211. for k, v in d.items():
  212. self[k] = v
  213. # user_datas: 用户数据,key为用户名,value为用户数据,也是dict
  214. self.user_datas = {}
  215. def __getitem__(self, key):
  216. if key not in available_setting:
  217. raise Exception("key {} not in available_setting".format(key))
  218. return super().__getitem__(key)
  219. def __setitem__(self, key, value):
  220. if key not in available_setting:
  221. raise Exception("key {} not in available_setting".format(key))
  222. return super().__setitem__(key, value)
  223. def get(self, key, default=None):
  224. try:
  225. return self[key]
  226. except KeyError as e:
  227. return default
  228. except Exception as e:
  229. raise e
  230. # Make sure to return a dictionary to ensure atomic
  231. def get_user_data(self, user) -> dict:
  232. if self.user_datas.get(user) is None:
  233. self.user_datas[user] = {}
  234. return self.user_datas[user]
  235. def load_user_datas(self):
  236. try:
  237. with open(os.path.join(get_appdata_dir(), "user_datas.pkl"), "rb") as f:
  238. self.user_datas = pickle.load(f)
  239. logger.info("[Config] User datas loaded.")
  240. except FileNotFoundError as e:
  241. logger.info("[Config] User datas file not found, ignore.")
  242. except Exception as e:
  243. logger.info("[Config] User datas error: {}".format(e))
  244. self.user_datas = {}
  245. def save_user_datas(self):
  246. try:
  247. with open(os.path.join(get_appdata_dir(), "user_datas.pkl"), "wb") as f:
  248. pickle.dump(self.user_datas, f)
  249. logger.info("[Config] User datas saved.")
  250. except Exception as e:
  251. logger.info("[Config] User datas error: {}".format(e))
  252. config = Config()
  253. def drag_sensitive(config):
  254. try:
  255. if isinstance(config, str):
  256. conf_dict: dict = json.loads(config)
  257. conf_dict_copy = copy.deepcopy(conf_dict)
  258. for key in conf_dict_copy:
  259. if "key" in key or "secret" in key:
  260. if isinstance(conf_dict_copy[key], str):
  261. conf_dict_copy[key] = conf_dict_copy[key][0:3] + "*" * 5 + conf_dict_copy[key][-3:]
  262. return json.dumps(conf_dict_copy, indent=4)
  263. elif isinstance(config, dict):
  264. config_copy = copy.deepcopy(config)
  265. for key in config:
  266. if "key" in key or "secret" in key:
  267. if isinstance(config_copy[key], str):
  268. config_copy[key] = config_copy[key][0:3] + "*" * 5 + config_copy[key][-3:]
  269. return config_copy
  270. except Exception as e:
  271. logger.exception(e)
  272. return config
  273. return config
  274. def load_config():
  275. global config
  276. config_path = "./config.json"
  277. if not os.path.exists(config_path):
  278. logger.info("配置文件不存在,将使用config-template.json模板")
  279. config_path = "./config-template.json"
  280. config_str = read_file(config_path)
  281. logger.debug("[INIT] config str: {}".format(drag_sensitive(config_str)))
  282. # 将json字符串反序列化为dict类型
  283. config = Config(json.loads(config_str))
  284. # override config with environment variables.
  285. # 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.
  286. for name, value in os.environ.items():
  287. name = name.lower()
  288. if name in available_setting:
  289. logger.info("[INIT] override config by environ args: {}={}".format(name, value))
  290. try:
  291. config[name] = eval(value)
  292. except:
  293. if value == "false":
  294. config[name] = False
  295. elif value == "true":
  296. config[name] = True
  297. else:
  298. config[name] = value
  299. if config.get("debug", False):
  300. logger.setLevel(logging.DEBUG)
  301. logger.debug("[INIT] set log level to DEBUG")
  302. logger.info("[INIT] load config: {}".format(drag_sensitive(config)))
  303. config.load_user_datas()
  304. def get_root():
  305. return os.path.dirname(os.path.abspath(__file__))
  306. def read_file(path):
  307. with open(path, mode="r", encoding="utf-8") as f:
  308. return f.read()
  309. def conf():
  310. return config
  311. def get_appdata_dir():
  312. data_path = os.path.join(get_root(), conf().get("appdata_dir", ""))
  313. if not os.path.exists(data_path):
  314. logger.info("[INIT] data path not exists, create it: {}".format(data_path))
  315. os.makedirs(data_path)
  316. return data_path
  317. def subscribe_msg():
  318. trigger_prefix = conf().get("single_chat_prefix", [""])[0]
  319. msg = conf().get("subscribe_msg", "")
  320. return msg.format(trigger_prefix=trigger_prefix)
  321. # global plugin config
  322. plugin_config = {}
  323. def write_plugin_config(pconf: dict):
  324. """
  325. 写入插件全局配置
  326. :param pconf: 全量插件配置
  327. """
  328. global plugin_config
  329. for k in pconf:
  330. plugin_config[k.lower()] = pconf[k]
  331. def pconf(plugin_name: str) -> dict:
  332. """
  333. 根据插件名称获取配置
  334. :param plugin_name: 插件名称
  335. :return: 该插件的配置项
  336. """
  337. # 如果插件名称作为key获取不到,则尝试使用小写名称
  338. return plugin_config.get(plugin_name) or plugin_config.get(plugin_name.lower())
  339. # 全局配置,用于存放全局生效的状态
  340. global_config = {"admin_users": []}