🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
Auto-update documentation after merge
camel-docs-bot23a7fe9d25f4
diff --git a/docs/reference/camel.toolkits.file_write_toolkit.md b/docs/reference/camel.toolkits.file_write_toolkit.mdindex b1abdb08a..0f345405b 100644--- a/docs/reference/camel.toolkits.file_write_toolkit.md+++ b/docs/reference/camel.toolkits.file_write_toolkit.md@@ -62,6 +62,27 @@ in downstream processing.Path: A fully resolved (absolute) and sanitized Path object.+<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._sanitize_filename"></a>++### _sanitize_filename++```python+def _sanitize_filename(self, filename: str):+```++Sanitize a filename by replacing any character that is not+alphanumeric, a dot (.), hyphen (-), or underscore (_) with an+underscore (_).++**Parameters:**++- **filename** (str): The original filename which may contain spaces or special characters.++**Returns:**++ str: The sanitized filename with disallowed characters replaced by+underscores.+<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._write_text_file"></a>### _write_text_file@@ -345,33 +366,12 @@ Write JSON content to a file.- **content** (str): The JSON content as a string.- **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8)-<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._write_yaml_file"></a>--### _write_yaml_file--```python-def _write_yaml_file(- self,- file_path: Path,- content: str,- encoding: str = 'utf-8'-):-```--Write YAML content to a file.--**Parameters:**--- **file_path** (Path): The target file path.-- **content** (str): The YAML content as a string.-- **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8)--<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._write_html_file"></a>+<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._write_simple_text_file"></a>-### _write_html_file+### _write_simple_text_file```python-def _write_html_file(+def _write_simple_text_file(self,file_path: Path,content: str,@@ -379,33 +379,12 @@ def _write_html_file():```-Write text content to an HTML file.+Write text content to a file (used for HTML, Markdown, YAML, etc.).**Parameters:**- **file_path** (Path): The target file path.-- **content** (str): The HTML content to write.-- **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8)--<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._write_markdown_file"></a>--### _write_markdown_file--```python-def _write_markdown_file(- self,- file_path: Path,- content: str,- encoding: str = 'utf-8'-):-```--Write text content to a Markdown file.--**Parameters:**--- **file_path** (Path): The target file path.-- **content** (str): The Markdown content to write.+- **content** (str): The content to write.- **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8)<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit.write_to_file"></a>@@ -454,24 +433,3 @@ def get_tools(self):List[FunctionTool]: A list of FunctionTool objects representingthe available functions in this toolkit.--<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._sanitize_filename"></a>--### _sanitize_filename--```python-def _sanitize_filename(self, filename: str):-```--Sanitize a filename by replacing any character that is not-alphanumeric, a dot (.), hyphen (-), or underscore (_) with an-underscore (_).--**Parameters:**--- **filename** (str): The original filename which may contain spaces or special characters.--**Returns:**-- str: The sanitized filename with disallowed characters replaced by-underscores.