config.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. # encoding:utf-8
  2. import json
  3. import logging
  4. import os
  5. import pickle
  6. from common.log import logger
  7. # 将所有可用的配置项写在字典里, 请使用小写字母
  8. # 此处的配置值无实际意义,程序不会读取此处的配置,仅用于提示格式,请将配置加入到config.json中
  9. available_setting = {
  10. # openai api配置
  11. "open_ai_api_key": "", # openai api key
  12. # openai apibase,当use_azure_chatgpt为true时,需要设置对应的api base
  13. "open_ai_api_base": "https://api.openai.com/v1",
  14. "proxy": "", # openai使用的代理
  15. # chatgpt模型, 当use_azure_chatgpt为true时,其名称为Azure上model deployment名称
  16. "model": "gpt-3.5-turbo", # 还支持 gpt-4, gpt-4-turbo, wenxin, xunfei, qwen
  17. "use_azure_chatgpt": False, # 是否使用azure的chatgpt
  18. "azure_deployment_id": "", # azure 模型部署名称
  19. "azure_api_version": "", # azure api版本
  20. # Bot触发配置
  21. "single_chat_prefix": ["bot", "@bot"], # 私聊时文本需要包含该前缀才能触发机器人回复
  22. "single_chat_reply_prefix": "[bot] ", # 私聊时自动回复的前缀,用于区分真人
  23. "single_chat_reply_suffix": "", # 私聊时自动回复的后缀,\n 可以换行
  24. "group_chat_prefix": ["@bot"], # 群聊时包含该前缀则会触发机器人回复
  25. "group_chat_reply_prefix": "", # 群聊时自动回复的前缀
  26. "group_chat_reply_suffix": "", # 群聊时自动回复的后缀,\n 可以换行
  27. "group_chat_keyword": [], # 群聊时包含该关键词则会触发机器人回复
  28. "group_at_off": False, # 是否关闭群聊时@bot的触发
  29. "group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"], # 开启自动回复的群名称列表
  30. "group_name_keyword_white_list": [], # 开启自动回复的群名称关键词列表
  31. "group_chat_in_one_session": ["ChatGPT测试群"], # 支持会话上下文共享的群名称
  32. "nick_name_black_list": [], # 用户昵称黑名单
  33. "group_welcome_msg": "", # 配置新人进群固定欢迎语,不配置则使用随机风格欢迎
  34. "trigger_by_self": False, # 是否允许机器人触发
  35. "text_to_image": "dall-e-2", # 图片生成模型,可选 dall-e-2, dall-e-3
  36. "image_proxy": True, # 是否需要图片代理,国内访问LinkAI时需要
  37. "image_create_prefix": ["画", "看", "找"], # 开启图片回复的前缀
  38. "concurrency_in_session": 1, # 同一会话最多有多少条消息在处理中,大于1可能乱序
  39. "image_create_size": "256x256", # 图片大小,可选有 256x256, 512x512, 1024x1024 (dall-e-3默认为1024x1024)
  40. "group_chat_exit_group": False,
  41. # chatgpt会话参数
  42. "expires_in_seconds": 3600, # 无操作会话的过期时间
  43. # 人格描述
  44. "character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题,并且可以使用多种语言与人交流。",
  45. "conversation_max_tokens": 1000, # 支持上下文记忆的最多字符数
  46. # chatgpt限流配置
  47. "rate_limit_chatgpt": 20, # chatgpt的调用频率限制
  48. "rate_limit_dalle": 50, # openai dalle的调用频率限制
  49. # chatgpt api参数 参考https://platform.openai.com/docs/api-reference/chat/create
  50. "temperature": 0.9,
  51. "top_p": 1,
  52. "frequency_penalty": 0,
  53. "presence_penalty": 0,
  54. "request_timeout": 180, # chatgpt请求超时时间,openai接口默认设置为600,对于难问题一般需要较长时间
  55. "timeout": 120, # chatgpt重试超时时间,在这个时间内,将会自动重试
  56. # Baidu 文心一言参数
  57. "baidu_wenxin_model": "eb-instant", # 默认使用ERNIE-Bot-turbo模型
  58. "baidu_wenxin_api_key": "", # Baidu api key
  59. "baidu_wenxin_secret_key": "", # Baidu secret key
  60. # 讯飞星火API
  61. "xunfei_app_id": "", # 讯飞应用ID
  62. "xunfei_api_key": "", # 讯飞 API key
  63. "xunfei_api_secret": "", # 讯飞 API secret
  64. # claude 配置
  65. "claude_api_cookie": "",
  66. "claude_uuid": "",
  67. # 通义千问API, 获取方式查看文档 https://help.aliyun.com/document_detail/2587494.html
  68. "qwen_access_key_id": "",
  69. "qwen_access_key_secret": "",
  70. "qwen_agent_key": "",
  71. "qwen_app_id": "",
  72. "qwen_node_id": "", # 流程编排模型用到的id,如果没有用到qwen_node_id,请务必保持为空字符串
  73. # Google Gemini Api Key
  74. "gemini_api_key": "",
  75. # wework的通用配置
  76. "wework_smart": True, # 配置wework是否使用已登录的企业微信,False为多开
  77. # 语音设置
  78. "speech_recognition": True, # 是否开启语音识别
  79. "group_speech_recognition": False, # 是否开启群组语音识别
  80. "voice_reply_voice": False, # 是否使用语音回复语音,需要设置对应语音合成引擎的api key
  81. "always_reply_voice": False, # 是否一直使用语音回复
  82. "voice_to_text": "openai", # 语音识别引擎,支持openai,baidu,google,azure
  83. "text_to_voice": "openai", # 语音合成引擎,支持openai,baidu,google,pytts(offline),azure,elevenlabs
  84. "text_to_voice_model": "tts-1",
  85. "tts_voice_id": "alloy",
  86. # baidu 语音api配置, 使用百度语音识别和语音合成时需要
  87. "baidu_app_id": "",
  88. "baidu_api_key": "",
  89. "baidu_secret_key": "",
  90. # 1536普通话(支持简单的英文识别) 1737英语 1637粤语 1837四川话 1936普通话远场
  91. "baidu_dev_pid": "1536",
  92. # azure 语音api配置, 使用azure语音识别和语音合成时需要
  93. "azure_voice_api_key": "",
  94. "azure_voice_region": "japaneast",
  95. # elevenlabs 语音api配置
  96. "xi_api_key": "", #获取ap的方法可以参考https://docs.elevenlabs.io/api-reference/quick-start/authentication
  97. "xi_voice_id": "", #ElevenLabs提供了9种英式、美式等英语发音id,分别是“Adam/Antoni/Arnold/Bella/Domi/Elli/Josh/Rachel/Sam”
  98. # 服务时间限制,目前支持itchat
  99. "chat_time_module": False, # 是否开启服务时间限制
  100. "chat_start_time": "00:00", # 服务开始时间
  101. "chat_stop_time": "24:00", # 服务结束时间
  102. # 翻译api
  103. "translate": "baidu", # 翻译api,支持baidu
  104. # baidu翻译api的配置
  105. "baidu_translate_app_id": "", # 百度翻译api的appid
  106. "baidu_translate_app_key": "", # 百度翻译api的秘钥
  107. # itchat的配置
  108. "hot_reload": False, # 是否开启热重载
  109. # wechaty的配置
  110. "wechaty_puppet_service_token": "", # wechaty的token
  111. # wechatmp的配置
  112. "wechatmp_token": "", # 微信公众平台的Token
  113. "wechatmp_port": 8080, # 微信公众平台的端口,需要端口转发到80或443
  114. "wechatmp_app_id": "", # 微信公众平台的appID
  115. "wechatmp_app_secret": "", # 微信公众平台的appsecret
  116. "wechatmp_aes_key": "", # 微信公众平台的EncodingAESKey,加密模式需要
  117. # wechatcom的通用配置
  118. "wechatcom_corp_id": "", # 企业微信公司的corpID
  119. # wechatcomapp的配置
  120. "wechatcomapp_token": "", # 企业微信app的token
  121. "wechatcomapp_port": 9898, # 企业微信app的服务端口,不需要端口转发
  122. "wechatcomapp_secret": "", # 企业微信app的secret
  123. "wechatcomapp_agent_id": "", # 企业微信app的agent_id
  124. "wechatcomapp_aes_key": "", # 企业微信app的aes_key
  125. # 飞书配置
  126. "feishu_port": 80, # 飞书bot监听端口
  127. "feishu_app_id": "", # 飞书机器人应用APP Id
  128. "feishu_app_secret": "", # 飞书机器人APP secret
  129. "feishu_token": "", # 飞书 verification token
  130. "feishu_bot_name": "", # 飞书机器人的名字
  131. # 钉钉配置
  132. "dingtalk_client_id": "", # 钉钉机器人Client ID
  133. "dingtalk_client_secret": "", # 钉钉机器人Client Secret
  134. # chatgpt指令自定义触发词
  135. "clear_memory_commands": ["#清除记忆"], # 重置会话指令,必须以#开头
  136. # channel配置
  137. "channel_type": "wx", # 通道类型,支持:{wx,wxy,terminal,wechatmp,wechatmp_service,wechatcom_app}
  138. "subscribe_msg": "", # 订阅消息, 支持: wechatmp, wechatmp_service, wechatcom_app
  139. "debug": False, # 是否开启debug模式,开启后会打印更多日志
  140. "appdata_dir": "", # 数据目录
  141. # 插件配置
  142. "plugin_trigger_prefix": "$", # 规范插件提供聊天相关指令的前缀,建议不要和管理员指令前缀"#"冲突
  143. # 是否使用全局插件配置
  144. "use_global_plugin_config": False,
  145. # 知识库平台配置
  146. "use_linkai": False,
  147. "linkai_api_key": "",
  148. "linkai_app_code": "",
  149. "linkai_api_base": "https://api.link-ai.chat", # linkAI服务地址,若国内无法访问或延迟较高可改为 https://api.link-ai.tech
  150. }
  151. class Config(dict):
  152. def __init__(self, d=None):
  153. super().__init__()
  154. if d is None:
  155. d = {}
  156. for k, v in d.items():
  157. self[k] = v
  158. # user_datas: 用户数据,key为用户名,value为用户数据,也是dict
  159. self.user_datas = {}
  160. def __getitem__(self, key):
  161. if key not in available_setting:
  162. raise Exception("key {} not in available_setting".format(key))
  163. return super().__getitem__(key)
  164. def __setitem__(self, key, value):
  165. if key not in available_setting:
  166. raise Exception("key {} not in available_setting".format(key))
  167. return super().__setitem__(key, value)
  168. def get(self, key, default=None):
  169. try:
  170. return self[key]
  171. except KeyError as e:
  172. return default
  173. except Exception as e:
  174. raise e
  175. # Make sure to return a dictionary to ensure atomic
  176. def get_user_data(self, user) -> dict:
  177. if self.user_datas.get(user) is None:
  178. self.user_datas[user] = {}
  179. return self.user_datas[user]
  180. def load_user_datas(self):
  181. try:
  182. with open(os.path.join(get_appdata_dir(), "user_datas.pkl"), "rb") as f:
  183. self.user_datas = pickle.load(f)
  184. logger.info("[Config] User datas loaded.")
  185. except FileNotFoundError as e:
  186. logger.info("[Config] User datas file not found, ignore.")
  187. except Exception as e:
  188. logger.info("[Config] User datas error: {}".format(e))
  189. self.user_datas = {}
  190. def save_user_datas(self):
  191. try:
  192. with open(os.path.join(get_appdata_dir(), "user_datas.pkl"), "wb") as f:
  193. pickle.dump(self.user_datas, f)
  194. logger.info("[Config] User datas saved.")
  195. except Exception as e:
  196. logger.info("[Config] User datas error: {}".format(e))
  197. config = Config()
  198. def load_config():
  199. global config
  200. config_path = "./config.json"
  201. if not os.path.exists(config_path):
  202. logger.info("配置文件不存在,将使用config-template.json模板")
  203. config_path = "./config-template.json"
  204. config_str = read_file(config_path)
  205. logger.debug("[INIT] config str: {}".format(config_str))
  206. # 将json字符串反序列化为dict类型
  207. config = Config(json.loads(config_str))
  208. # override config with environment variables.
  209. # 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.
  210. for name, value in os.environ.items():
  211. name = name.lower()
  212. if name in available_setting:
  213. logger.info("[INIT] override config by environ args: {}={}".format(name, value))
  214. try:
  215. config[name] = eval(value)
  216. except:
  217. if value == "false":
  218. config[name] = False
  219. elif value == "true":
  220. config[name] = True
  221. else:
  222. config[name] = value
  223. if config.get("debug", False):
  224. logger.setLevel(logging.DEBUG)
  225. logger.debug("[INIT] set log level to DEBUG")
  226. logger.info("[INIT] load config: {}".format(config))
  227. config.load_user_datas()
  228. def get_root():
  229. return os.path.dirname(os.path.abspath(__file__))
  230. def read_file(path):
  231. with open(path, mode="r", encoding="utf-8") as f:
  232. return f.read()
  233. def conf():
  234. return config
  235. def get_appdata_dir():
  236. data_path = os.path.join(get_root(), conf().get("appdata_dir", ""))
  237. if not os.path.exists(data_path):
  238. logger.info("[INIT] data path not exists, create it: {}".format(data_path))
  239. os.makedirs(data_path)
  240. return data_path
  241. def subscribe_msg():
  242. trigger_prefix = conf().get("single_chat_prefix", [""])[0]
  243. msg = conf().get("subscribe_msg", "")
  244. return msg.format(trigger_prefix=trigger_prefix)
  245. # global plugin config
  246. plugin_config = {}
  247. def write_plugin_config(pconf: dict):
  248. """
  249. 写入插件全局配置
  250. :param pconf: 全量插件配置
  251. """
  252. global plugin_config
  253. for k in pconf:
  254. plugin_config[k.lower()] = pconf[k]
  255. def pconf(plugin_name: str) -> dict:
  256. """
  257. 根据插件名称获取配置
  258. :param plugin_name: 插件名称
  259. :return: 该插件的配置项
  260. """
  261. return plugin_config.get(plugin_name.lower())
  262. # 全局配置,用于存放全局生效的状态
  263. global_config = {
  264. "admin_users": []
  265. }