message_toolkit.py 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. from typing import List, Dict
  2. from pqai_agent.logging import logger
  3. from pqai_agent.toolkit.base import BaseToolkit
  4. from pqai_agent.toolkit.function_tool import FunctionTool
  5. from pqai_agent.toolkit.tool_registry import register_toolkit
  6. @register_toolkit
  7. class MessageToolkit(BaseToolkit):
  8. def __init__(self):
  9. super().__init__()
  10. def message_notify_user(self, message: str) -> str:
  11. """Sends a message to the user.
  12. Args:
  13. message (str): The message to send.
  14. Returns:
  15. str: A confirmation message.
  16. """
  17. logger.info(f"Message to user: {message}")
  18. return 'success'
  19. def output_multimodal_message(self, message: Dict[str, str]) -> str:
  20. """Outputs a multimodal message to the user.
  21. Message schema:
  22. {
  23. "type": "text|image|gif|video|mini_program|link",
  24. "content": "text message content or url of the media",
  25. "title": "only needed if type in: video, link, mini_program",
  26. "cover_url": "cover image url, only needed if type in: mini_program",
  27. "desc": "description, optional if type in: link"
  28. }
  29. if message type is image, gif, video, link or mini_program, the content should be a URL.
  30. Args:
  31. message (Dict[str, str]): The message to output.
  32. Returns:
  33. str: A confirmation message.
  34. """
  35. msg_type = message.get("type", "")
  36. if msg_type not in ["text", "image", "gif", "video", "mini_program", "link"]:
  37. return f"Invalid message type: {msg_type}"
  38. if msg_type in ("video", "mini_program", "link") and "title" not in message:
  39. return f"Title is required for [{msg_type}] messages."
  40. if msg_type in ("mini_program", ) and "cover_url" not in message:
  41. return f"Cover image URL is required for [{msg_type}] messages."
  42. # if msg_type in ("link", ) and "desc" not in message:
  43. # return f"Description is required for [link] messages."
  44. logger.info(f"Multimodal message to user: {message}")
  45. return 'success'
  46. def get_tools(self):
  47. return [FunctionTool(self.message_notify_user),
  48. FunctionTool(self.output_multimodal_message)]