Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

Auto-update documentation after merge [skip ci]

camel-docs-botda86121346e7
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.json
index 673c02ea0..40ac06e9e 100644
--- a/docs/mintlify/docs.json
+++ b/docs/mintlify/docs.json
@@ -499,6 +499,7 @@
"reference/camel.toolkits.memory_toolkit",
"reference/camel.toolkits.meshy_toolkit",
"reference/camel.toolkits.message_agent_toolkit",
+ "reference/camel.toolkits.message_integration",
"reference/camel.toolkits.mineru_toolkit",
"reference/camel.toolkits.networkx_toolkit",
"reference/camel.toolkits.note_taking_toolkit",
diff --git a/docs/mintlify/get_started/introduction.mdx b/docs/mintlify/get_started/introduction.mdx
index b6107bbe3..87aebf2a9 100644
--- a/docs/mintlify/get_started/introduction.mdx
+++ b/docs/mintlify/get_started/introduction.mdx
@@ -44,7 +44,8 @@ description: |
</Card>
<Card title="OWL 🦉" icon="brain-circuit" href="https://github.com/camel-ai/owl">
- Real‑world retrieval agents for Discord, support, and knowledge applications
+ OWL (Optimized Workforce Learning) is a multi-agent automation framework for real-world tasks. Built on CAMEL-AI,
+ it enables dynamic agent collaboration using tools like browsers, code interpreters, and multimodal models.
</Card>
</CardGroup>
diff --git a/docs/mintlify/reference/camel.toolkits.message_integration.mdx b/docs/mintlify/reference/camel.toolkits.message_integration.mdx
new file mode 100644
index 000000000..b570835b4
--- /dev/null
+++ b/docs/mintlify/reference/camel.toolkits.message_integration.mdx
@@ -0,0 +1,189 @@
+<a id="camel.toolkits.message_integration"></a>
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration"></a>
+
+## ToolkitMessageIntegration
+
+```python
+class ToolkitMessageIntegration:
+```
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration.__init__"></a>
+
+### __init__
+
+```python
+def __init__(
+ self,
+ message_handler: Optional[Callable] = None,
+ extract_params_callback: Optional[Callable[[dict], tuple]] = None
+):
+```
+
+Initialize the toolkit message integration.
+
+**Parameters:**
+
+- **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`)
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration._default_extract_params"></a>
+
+### _default_extract_params
+
+```python
+def _default_extract_params(self, kwargs: dict):
+```
+
+Default parameter extraction for built-in message handler.
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration.send_message_to_user"></a>
+
+### send_message_to_user
+
+```python
+def send_message_to_user(
+ self,
+ message_title: str,
+ message_description: str,
+ message_attachment: str = ''
+):
+```
+
+Built-in message handler that sends tidy messages to the user.
+
+This one-way tool keeps the user informed about agent progress,
+decisions, or actions. It does not require a response.
+
+**Parameters:**
+
+- **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.
+
+**Returns:**
+
+ str: Confirmation that the message was successfully sent.
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration.get_message_tool"></a>
+
+### get_message_tool
+
+```python
+def get_message_tool(self):
+```
+
+**Returns:**
+
+ FunctionTool: The message sending tool.
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration.add_messaging_to_toolkit"></a>
+
+### add_messaging_to_toolkit
+
+```python
+def add_messaging_to_toolkit(
+ self,
+ toolkit: BaseToolkit,
+ tool_names: Optional[List[str]] = None
+):
+```
+
+Add messaging capabilities to toolkit methods.
+
+This method modifies a toolkit so that specified tools can send
+status messages to users while executing their primary function.
+The tools will accept optional messaging parameters:
+- message_title: Title of the status message
+- message_description: Description of what the tool is doing
+- message_attachment: Optional file path or URL
+
+**Parameters:**
+
+- **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.
+
+**Returns:**
+
+ The toolkit with messaging capabilities added
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration.add_messaging_to_functions"></a>
+
+### add_messaging_to_functions
+
+```python
+def add_messaging_to_functions(
+ self,
+ functions: Union[List[FunctionTool], List[Callable]],
+ function_names: Optional[List[str]] = None
+):
+```
+
+Add messaging capabilities to a list of functions or FunctionTools.
+
+This method enhances functions so they can send status messages to
+users while executing. The enhanced functions will accept optional
+messaging parameters that trigger status updates.
+
+**Parameters:**
+
+- **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.
+
+**Returns:**
+
+ List[FunctionTool]: List of enhanced FunctionTool objects
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration._add_messaging_to_tool"></a>
+
+### _add_messaging_to_tool
+
+```python
+def _add_messaging_to_tool(self, func: Callable):
+```
+
+Add messaging parameters to a tool function.
+
+This internal method modifies the function signature and docstring
+to include optional messaging parameters that trigger status updates.
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration._find_docstring_insert_point"></a>
+
+### _find_docstring_insert_point
+
+```python
+def _find_docstring_insert_point(self, lines: List[str]):
+```
+
+Find where to insert parameters in a docstring.
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration._get_docstring_indent"></a>
+
+### _get_docstring_indent
+
+```python
+def _get_docstring_indent(self, lines: List[str], insert_idx: int):
+```
+
+Get the proper indentation for docstring parameters.
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration._get_base_indent"></a>
+
+### _get_base_indent
+
+```python
+def _get_base_indent(self, lines: List[str]):
+```
+
+Get the base indentation level of the docstring.
+
+<a id="camel.toolkits.message_integration.ToolkitMessageIntegration._extract_param_docs_from_handler"></a>
+
+### _extract_param_docs_from_handler
+
+```python
+def _extract_param_docs_from_handler(self):
+```
+
+Extract parameter documentation from the custom handler's
+docstring.