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

camel-docs-botf35834221f94
diff --git a/docs/reference/camel.agents.chat_agent.md b/docs/reference/camel.agents.chat_agent.md
index 7dafa6cae..47bb768f9 100644
--- a/docs/reference/camel.agents.chat_agent.md
+++ b/docs/reference/camel.agents.chat_agent.md
@@ -23,6 +23,7 @@ Class for managing conversations of CAMEL Chat Agents.
- **max_iteration** (Optional[int], optional): Maximum number of model calling iterations allowed per step. If `None` (default), there's no explicit limit. If `1`, it performs a single model call. If `N > 1`, it allows up to N model calls. (default: :obj:`None`)
- **agent_id** (str, optional): The ID of the agent. If not provided, a random UUID will be generated. (default: :obj:`None`)
- **stop_event** (Optional[threading.Event], optional): Event to signal termination of the agent's operation. When set, the agent will terminate its execution. (default: :obj:`None`)
+- **mask_tool_output** (Optional[bool]): Whether to return a sanitized placeholder instead of the raw tool output. (default: :obj:`False`)
<a id="camel.agents.chat_agent.ChatAgent.__init__"></a>
@@ -43,7 +44,8 @@ def __init__(
scheduling_strategy: str = 'round_robin',
max_iteration: Optional[int] = None,
agent_id: Optional[str] = None,
- stop_event: Optional[threading.Event] = None
+ stop_event: Optional[threading.Event] = None,
+ mask_tool_output: bool = False
):
```
@@ -760,13 +762,26 @@ def _record_tool_calling(
func_name: str,
args: Dict[str, Any],
result: Any,
- tool_call_id: str
+ tool_call_id: str,
+ mask_output: bool = False
):
```
Record the tool calling information in the memory, and return the
tool calling record.
+**Parameters:**
+
+- **func_name** (str): The name of the tool function called.
+- **args** (Dict[str, Any]): The arguments passed to the tool.
+- **result** (Any): The result returned by the tool execution.
+- **tool_call_id** (str): A unique identifier for the tool call.
+- **mask_output** (bool, optional): Whether to return a sanitized placeholder instead of the raw tool output. (default: :obj:`False`)
+
+**Returns:**
+
+ ToolCallingRecord: A struct containing information about this tool call.
+
<a id="camel.agents.chat_agent.ChatAgent.get_usage_dict"></a>
### get_usage_dict
diff --git a/docs/reference/camel.messages.func_message.md b/docs/reference/camel.messages.func_message.md
new file mode 100644
index 000000000..2681b76f7
--- /dev/null
+++ b/docs/reference/camel.messages.func_message.md
@@ -0,0 +1,90 @@
+<a id="camel.messages.func_message"></a>
+
+<a id="camel.messages.func_message.FunctionCallingMessage"></a>
+
+## FunctionCallingMessage
+
+```python
+class FunctionCallingMessage(BaseMessage):
+```
+
+Class for message objects used specifically for
+function-related messages.
+
+**Parameters:**
+
+- **func_name** (Optional[str]): The name of the function used. (default: :obj:`None`)
+- **args** (Optional[Dict]): The dictionary of arguments passed to the function. (default: :obj:`None`)
+- **result** (Optional[Any]): The result of function execution. (default: :obj:`None`)
+- **tool_call_id** (Optional[str]): The ID of the tool call, if available. (default: :obj:`None`)
+- **mask_output** (Optional[bool]): Whether to return a sanitized placeholder instead of the raw tool output. (default: :obj:`False`)
+
+<a id="camel.messages.func_message.FunctionCallingMessage.to_openai_message"></a>
+
+### to_openai_message
+
+```python
+def to_openai_message(self, role_at_backend: OpenAIBackendRole):
+```
+
+Converts the message to an :obj:`OpenAIMessage` object.
+
+**Parameters:**
+
+- **role_at_backend** (OpenAIBackendRole): The role of the message in OpenAI chat system.
+
+**Returns:**
+
+ OpenAIMessage: The converted :obj:`OpenAIMessage` object.
+
+<a id="camel.messages.func_message.FunctionCallingMessage.to_sharegpt"></a>
+
+### to_sharegpt
+
+```python
+def to_sharegpt(
+ self,
+ function_format: Optional[FunctionCallFormatter[ToolCall, ToolResponse]] = None
+):
+```
+
+Convert FunctionCallingMessage to ShareGPT message.
+
+<a id="camel.messages.func_message.FunctionCallingMessage.to_openai_assistant_message"></a>
+
+### to_openai_assistant_message
+
+```python
+def to_openai_assistant_message(self):
+```
+
+**Returns:**
+
+ OpenAIAssistantMessage: The converted :obj:`OpenAIAssistantMessage`
+object.
+
+<a id="camel.messages.func_message.FunctionCallingMessage.to_openai_tool_message"></a>
+
+### to_openai_tool_message
+
+```python
+def to_openai_tool_message(self):
+```
+
+**Returns:**
+
+ OpenAIToolMessageParam: The converted
+:obj:`OpenAIToolMessageParam` object with its role being
+"tool".
+
+<a id="camel.messages.func_message.FunctionCallingMessage.to_dict"></a>
+
+### to_dict
+
+```python
+def to_dict(self):
+```
+
+**Returns:**
+
+ dict: The converted dictionary.