Camel.toolkits.message integration

​

ToolkitMessageIntegration

class ToolkitMessageIntegration:

​

init

def __init__(
    self,
    message_handler: Optional[Callable] = None,
    extract_params_callback: Optional[Callable[[dict], tuple]] = None
):

• message_handler (Optional[Callable]): Custom message handler function. If not provided, uses the built-in send_message_to_user. (default: :obj:None)
• extract_params_callback (Optional[Callable]): Function to extract parameters from kwargs for the custom message handler. Should return a tuple of arguments to pass to the message handler. If not provided, uses default extraction for built-in handler. (default: :obj:None)

​

_default_extract_params

def _default_extract_params(self, kwargs: dict):

​

send_message_to_user

def send_message_to_user(
    self,
    message_title: str,
    message_description: str,
    message_attachment: str = ''
):

• message_title (str): The title of the message.
• message_description (str): The short description message.
• message_attachment (str): The additional attachment of the message, which can be a file path or a URL.

​

get_message_tool

def get_message_tool(self):

​

add_messaging_to_toolkit

def add_messaging_to_toolkit(
    self,
    toolkit: BaseToolkit,
    tool_names: Optional[List[str]] = None
):

• message_title: Title of the status message
• message_description: Description of what the tool is doing
• message_attachment: Optional file path or URL

• toolkit: The toolkit to add messaging capabilities to
• tool_names: List of specific tool names to modify. If None, messaging is added to all tools.

​

add_messaging_to_functions

def add_messaging_to_functions(
    self,
    functions: Union[List[FunctionTool], List[Callable]],
    function_names: Optional[List[str]] = None
):

• functions (Union[List[FunctionTool], List[Callable]]): List of FunctionTool objects or callable functions to enhance.
• function_names (Optional[List[str]]): List of specific function names to modify. If None, messaging is added to all functions.

​

_add_messaging_to_tool

def _add_messaging_to_tool(self, func: Callable):

​

_find_docstring_insert_point

def _find_docstring_insert_point(self, lines: List[str]):

​

_get_docstring_indent

def _get_docstring_indent(self, lines: List[str], insert_idx: int):

​

_get_base_indent

def _get_base_indent(self, lines: List[str]):

​

_extract_param_docs_from_handler

def _extract_param_docs_from_handler(self):