J1147
/
ai-on-wechat
Segui 1
Vota 0
Forka 0
Codice Problemi 0 Pull Requests 0 Rilasci 0 Wiki Attività
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1167 Commit
3 Rami (Branch)
10MB
Albero (Tree): 55ca652ad8
Rami (Branch) Tag
${ item.name }
Crea branch ${ searchTerm }
da '55ca652ad8'
${ noResults }
ai-on-wechat/plugins/tool/tool.py

251 lines
14KB
Originale Blame Cronologia 

  1. from chatgpt_tool_hub.apps import AppFactory

  2. from chatgpt_tool_hub.apps.app import App

  3. from chatgpt_tool_hub.tools.tool_register import main_tool_register

  4. 

  5. import plugins

  6. from bridge.bridge import Bridge

  7. from bridge.context import ContextType

  8. from bridge.reply import Reply, ReplyType

  9. from common import const

  10. from config import conf, get_appdata_dir

  11. from plugins import *

  12. 

  13. 

  14. @plugins.register(

  15.     name="tool",

  16.     desc="Arming your ChatGPT bot with various tools",

  17.     version="0.5",

  18.     author="goldfishh",

  19.     desire_priority=0,

  20. )

  21. class Tool(Plugin):

  22.     def __init__(self):

  23.         super().__init__()

  24.         try:

  25.             self.handlers[Event.ON_HANDLE_CONTEXT] = self.on_handle_context

  26.             self.app = self._reset_app()

  27.             if not self.tool_config.get("tools"):

  28.                 raise Exception("config.json not found")

  29.             logger.info("[tool] inited")

  30.         except Exception as e:

  31.             logger.warn("[tool] init failed, ignore ")

  32.             raise e

  33. 

  34.     def get_help_text(self, verbose=False, **kwargs):

  35.         help_text = "这是一个能让chatgpt联网，搜索，数字运算的插件，将赋予强大且丰富的扩展能力。"

  36.         trigger_prefix = conf().get("plugin_trigger_prefix", "$")

  37.         if not verbose:

  38.             return help_text

  39.         help_text += "\n使用说明：\n"

  40.         help_text += f"{trigger_prefix}tool " + "命令: 根据给出的{命令}模型来选择使用哪些工具尽力为你得到结果。\n"

  41.         help_text += f"{trigger_prefix}tool 工具名 " + "命令: 根据给出的{命令}使用指定工具尽力为你得到结果。\n"

  42.         help_text += f"{trigger_prefix}tool reset: 重置工具。\n\n"

  43. 

  44.         help_text += f"已加载工具列表: \n"

  45.         for idx, tool in enumerate(main_tool_register.get_registered_tool_names()):

  46.             if idx != 0:

  47.                 help_text += ", "

  48.             help_text += f"{tool}"

  49.         return help_text

  50. 

  51.     def on_handle_context(self, e_context: EventContext):

  52.         if e_context["context"].type != ContextType.TEXT:

  53.             return

  54. 

  55.         # 暂时不支持未来扩展的bot

  56.         if Bridge().get_bot_type("chat") not in (

  57.             const.CHATGPT,

  58.             const.OPEN_AI,

  59.             const.CHATGPTONAZURE,

  60.             const.LINKAI,

  61.         ):

  62.             return

  63. 

  64.         content = e_context["context"].content

  65.         content_list = e_context["context"].content.split(maxsplit=1)

  66. 

  67.         if not content or len(content_list) < 1:

  68.             e_context.action = EventAction.CONTINUE

  69.             return

  70. 

  71.         logger.debug("[tool] on_handle_context. content: %s" % content)

  72.         reply = Reply()

  73.         reply.type = ReplyType.TEXT

  74.         trigger_prefix = conf().get("plugin_trigger_prefix", "$")

  75.         # todo: 有些工具必须要api-key，需要修改config文件，所以这里没有实现query增删tool的功能

  76.         if content.startswith(f"{trigger_prefix}tool"):

  77.             if len(content_list) == 1:

  78.                 logger.debug("[tool]: get help")

  79.                 reply.content = self.get_help_text()

  80.                 e_context["reply"] = reply

  81.                 e_context.action = EventAction.BREAK_PASS

  82.                 return

  83.             elif len(content_list) > 1:

  84.                 if content_list[1].strip() == "reset":

  85.                     logger.debug("[tool]: reset config")

  86.                     self.app = self._reset_app()

  87.                     reply.content = "重置工具成功"

  88.                     e_context["reply"] = reply

  89.                     e_context.action = EventAction.BREAK_PASS

  90.                     return

  91.                 elif content_list[1].startswith("reset"):

  92.                     logger.debug("[tool]: remind")

  93.                     e_context["context"].content = "请你随机用一种聊天风格，提醒用户：如果想重置tool插件，reset之后不要加任何字符"

  94. 

  95.                     e_context.action = EventAction.BREAK

  96.                     return

  97.                 query = content_list[1].strip()

  98.                 

  99.                 use_one_tool = False

  100.                 for tool_name in main_tool_register.get_registered_tool_names():

  101.                     if query.startswith(tool_name):

  102.                         use_one_tool = True

  103.                         query = query[len(tool_name):]

  104.                         break

  105. 

  106.                 # Don't modify bot name

  107.                 all_sessions = Bridge().get_bot("chat").sessions

  108.                 user_session = all_sessions.session_query(query, e_context["context"]["session_id"]).messages

  109. 

  110.                 logger.debug("[tool]: just-go")

  111.                 try:

  112.                     if use_one_tool:

  113.                         _func, _ = main_tool_register.get_registered_tool()[tool_name]

  114.                         tool = _func(**self.app_kwargs)

  115.                         _reply = tool.run(query)

  116.                     else:

  117.                         # chatgpt-tool-hub will reply you with many tools

  118.                         _reply = self.app.ask(query, user_session)

  119.                     e_context.action = EventAction.BREAK_PASS

  120.                     all_sessions.session_reply(_reply, e_context["context"]["session_id"])

  121.                 except Exception as e:

  122.                     logger.exception(e)

  123.                     logger.error(str(e))

  124. 

  125.                     e_context["context"].content = "请你随机用一种聊天风格，提醒用户：这个问题tool插件暂时无法处理"

  126.                     reply.type = ReplyType.ERROR

  127.                     e_context.action = EventAction.BREAK

  128.                     return

  129. 

  130.                 reply.content = _reply

  131.                 e_context["reply"] = reply

  132.         return

  133. 

  134.     def _read_json(self) -> dict:

  135.         default_config = {"tools": [], "kwargs": {}}

  136.         return super().load_config() or default_config

  137. 

  138.     def _build_tool_kwargs(self, kwargs: dict):

  139.         tool_model_name = kwargs.get("model_name")

  140.         request_timeout = kwargs.get("request_timeout")

  141. 

  142.         return {

  143.             # 全局配置相关

  144.             "log": False,  # tool 日志开关

  145.             "debug": kwargs.get("debug", False),  # 输出更多日志

  146.             "no_default": kwargs.get("no_default", False),  # 不要默认的工具，只加载自己导入的工具

  147.             "think_depth": kwargs.get("think_depth", 2),  # 一个问题最多使用多少次工具

  148.             "proxy": conf().get("proxy", ""),  # 科学上网

  149.             "request_timeout": request_timeout if request_timeout else conf().get("request_timeout", 120),

  150.             "temperature": kwargs.get("temperature", 0),  # llm 温度，建议设置0

  151.             # LLM配置相关

  152.             "llm_api_key": conf().get("open_ai_api_key", ""),  # 如果llm api用key鉴权，传入这里

  153.             "llm_api_base_url": conf().get("open_ai_api_base", "https://api.openai.com/v1"),  # 支持openai接口的llm服务地址前缀

  154.             "deployment_id": conf().get("azure_deployment_id", ""),  # azure openai会用到

  155.             # note: 目前tool暂未对其他模型测试，但这里仍对配置来源做了优先级区分，一般插件配置可覆盖全局配置

  156.             "model_name": tool_model_name if tool_model_name else conf().get("model", const.GPT35),

  157.             # 工具配置相关

  158.             # for arxiv tool

  159.             "arxiv_simple": kwargs.get("arxiv_simple", True),  # 返回内容更精简

  160.             "arxiv_top_k_results": kwargs.get("arxiv_top_k_results", 2),  # 只返回前k个搜索结果

  161.             "arxiv_sort_by": kwargs.get("arxiv_sort_by", "relevance"),  # 搜索排序方式 ["relevance","lastUpdatedDate","submittedDate"]

  162.             "arxiv_sort_order": kwargs.get("arxiv_sort_order", "descending"),  # 搜索排序方式 ["ascending", "descending"]

  163.             "arxiv_output_type": kwargs.get("arxiv_output_type", "text"),  # 搜索结果类型 ["text", "pdf", "all"]

  164.             # for bing-search tool

  165.             "bing_subscription_key": kwargs.get("bing_subscription_key", ""),

  166.             "bing_search_url": kwargs.get("bing_search_url", "https://api.bing.microsoft.com/v7.0/search"),  # 必应搜索的endpoint地址，无需修改

  167.             "bing_search_top_k_results": kwargs.get("bing_search_top_k_results", 2),  # 只返回前k个搜索结果

  168.             "bing_search_simple": kwargs.get("bing_search_simple", True),  # 返回内容更精简

  169.             "bing_search_output_type": kwargs.get("bing_search_output_type", "text"),  # 搜索结果类型 ["text", "json"]

  170.             # for email tool

  171.             "email_nickname_mapping": kwargs.get("email_nickname_mapping", "{}"),  # 关于人的代号对应的邮箱地址，可以不输入邮箱地址发送邮件。键为代号值为邮箱地址

  172.             "email_smtp_host": kwargs.get("email_smtp_host", ""),  # 例如 'smtp.qq.com'

  173.             "email_smtp_port": kwargs.get("email_smtp_port", ""),  # 例如 587

  174.             "email_sender": kwargs.get("email_sender", ""),  # 发送者的邮件地址

  175.             "email_authorization_code": kwargs.get("email_authorization_code", ""),  # 发送者验证秘钥（可能不是登录密码）

  176.             # for google-search tool

  177.             "google_api_key": kwargs.get("google_api_key", ""),

  178.             "google_cse_id": kwargs.get("google_cse_id", ""),

  179.             "google_simple": kwargs.get("google_simple", True),   # 返回内容更精简

  180.             "google_output_type": kwargs.get("google_output_type", "text"),  # 搜索结果类型 ["text", "json"]

  181.             # for finance-news tool

  182.             "finance_news_filter": kwargs.get("finance_news_filter", False),  # 是否开启过滤

  183.             "finance_news_filter_list": kwargs.get("finance_news_filter_list", []),  # 过滤词列表

  184.             "finance_news_simple": kwargs.get("finance_news_simple", True),   # 返回内容更精简

  185.             "finance_news_repeat_news": kwargs.get("finance_news_repeat_news", False),  # 是否过滤不返回。该tool每次返回约50条新闻，可能有重复新闻

  186.             # for morning-news tool

  187.             "morning_news_api_key": kwargs.get("morning_news_api_key", ""),   # api-key

  188.             "morning_news_simple": kwargs.get("morning_news_simple", True),   # 返回内容更精简

  189.             "morning_news_output_type": kwargs.get("morning_news_output_type", "text"),  # 搜索结果类型 ["text", "image"]

  190.             # for news-api tool

  191.             "news_api_key": kwargs.get("news_api_key", ""),

  192.             # for searxng-search tool

  193.             "searxng_search_host": kwargs.get("searxng_search_host", ""),

  194.             "searxng_search_top_k_results": kwargs.get("searxng_search_top_k_results", 2),  # 只返回前k个搜索结果

  195.             "searxng_search_output_type": kwargs.get("searxng_search_output_type", "text"),  # 搜索结果类型 ["text", "json"]

  196.             # for sms tool

  197.             "sms_nickname_mapping": kwargs.get("sms_nickname_mapping", "{}"),  # 关于人的代号对应的手机号，可以不输入手机号发送sms。键为代号值为手机号

  198.             "sms_username": kwargs.get("sms_username", ""),  # smsbao用户名

  199.             "sms_apikey": kwargs.get("sms_apikey", ""),  # smsbao

  200.             # for stt tool

  201.             "stt_api_key": kwargs.get("stt_api_key", ""),  # azure

  202.             "stt_api_region": kwargs.get("stt_api_region", ""),  # azure

  203.             "stt_recognition_language": kwargs.get("stt_recognition_language", "zh-CN"),  # 识别的语言类型 部分：en-US ja-JP ko-KR yue-CN zh-CN

  204.             # for tts tool

  205.             "tts_api_key": kwargs.get("tts_api_key", ""),  # azure

  206.             "tts_api_region": kwargs.get("tts_api_region", ""),  # azure

  207.             "tts_auto_detect": kwargs.get("tts_auto_detect", True),  # 是否自动检测语音的语言

  208.             "tts_speech_id": kwargs.get("tts_speech_id", "zh-CN-XiaozhenNeural"),  # 输出语音ID

  209.             # for summary tool

  210.             "summary_max_segment_length": kwargs.get("summary_max_segment_length", 2500),  # 每2500tokens分段，多段触发总结tool

  211.             # for terminal tool

  212.             "terminal_nsfc_filter": kwargs.get("terminal_nsfc_filter", True),  # 是否过滤llm输出的危险命令

  213.             "terminal_return_err_output": kwargs.get("terminal_return_err_output", True),  # 是否输出错误信息

  214.             "terminal_timeout": kwargs.get("terminal_timeout", 20),  # 允许命令最长执行时间

  215.             # for visual tool

  216.             "caption_api_key": kwargs.get("caption_api_key", ""),  # ali dashscope apikey

  217.             # for browser tool

  218.             "browser_use_summary": kwargs.get("browser_use_summary", True),  # 是否对返回结果使用tool功能

  219.             # for url-get tool

  220.             "url_get_use_summary": kwargs.get("url_get_use_summary", True),  # 是否对返回结果使用tool功能

  221.             # for wechat tool

  222.             "wechat_hot_reload": kwargs.get("wechat_hot_reload", True),  # 是否使用热重载的方式发送wechat

  223.             "wechat_cpt_path": kwargs.get("wechat_cpt_path", os.path.join(get_appdata_dir(), "itchat.pkl")),  # wechat 配置文件（`itchat.pkl`）

  224.             "wechat_send_group": kwargs.get("wechat_send_group", False),  # 是否向群组发送消息

  225.             "wechat_nickname_mapping": kwargs.get("wechat_nickname_mapping", "{}"),  # 关于人的代号映射关系。键为代号值为微信名（昵称、备注名均可）

  226.             # for wikipedia tool

  227.             "wikipedia_top_k_results": kwargs.get("wikipedia_top_k_results", 2),  # 只返回前k个搜索结果

  228.             # for wolfram-alpha tool

  229.             "wolfram_alpha_appid": kwargs.get("wolfram_alpha_appid", ""),

  230.         }

  231. 

  232.     def _filter_tool_list(self, tool_list: list):

  233.         valid_list = []

  234.         for tool in tool_list:

  235.             if tool in main_tool_register.get_registered_tool_names():

  236.                 valid_list.append(tool)

  237.             else:

  238.                 logger.warning("[tool] filter invalid tool: " + repr(tool))

  239.         return valid_list

  240. 

  241.     def _reset_app(self) -> App:

  242.         self.tool_config = self._read_json()

  243.         self.app_kwargs = self._build_tool_kwargs(self.tool_config.get("kwargs", {}))

  244. 

  245.         app = AppFactory()

  246.         app.init_env(**self.app_kwargs)

  247.         # filter not support tool

  248.         tool_list = self._filter_tool_list(self.tool_config.get("tools", []))

  249. 

  250.         return app.create_app(tools_list=tool_list, **self.app_kwargs)