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-bot7e68a6614935
diff --git a/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx
index 0f345405b..fc5f43fe9 100644
--- a/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx
@@ -23,7 +23,7 @@ specialized formats.
```python
def __init__(
self,
- output_dir: str = './',
+ working_directory: Optional[str] = None,
timeout: Optional[float] = None,
default_encoding: str = 'utf-8',
backup_enabled: bool = True
@@ -34,7 +34,7 @@ Initialize the FileWriteToolkit.
**Parameters:**
-- **output_dir** (str): The default directory for output files. Defaults to the current working directory.
+- **working_directory** (str, optional): The default directory for output files. If not provided, it will be determined by the `CAMEL_WORKDIR` environment variable (if set). If the environment variable is not set, it defaults to `camel_working_dir`.
- **timeout** (Optional[float]): The timeout for the toolkit. (default: :obj:`None`)
- **default_encoding** (str): Default character encoding for text operations. (default: :obj:`utf-8`)
- **backup_enabled** (bool): Whether to create backups of existing files before overwriting. (default: :obj:`True`)
@@ -413,7 +413,7 @@ and HTML (.html, .htm).
- **title** (str): The title of the document.
- **content** (Union[str, List[List[str]]]): The content to write to the file. Content format varies by file type: - Text formats (txt, md, html, yaml): string - CSV: string or list of lists - JSON: string or serializable object
-- **filename** (str): The name or path of the file. If a relative path is supplied, it is resolved to self.output_dir.
+- **filename** (str): The name or path of the file. If a relative path is supplied, it is resolved to self.working_directory.
- **encoding** (Optional[str]): The character encoding to use. (default: :obj: `None`)
- **use_latex** (bool): Whether to use LaTeX for math rendering. (default: :obj:`False`)
diff --git a/docs/mintlify/reference/camel.toolkits.note_taking_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.note_taking_toolkit.mdx
index 070b54ed6..34c66f428 100644
--- a/docs/mintlify/reference/camel.toolkits.note_taking_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.note_taking_toolkit.mdx
@@ -20,7 +20,7 @@ Markdown file for note-taking purposes.
```python
def __init__(
self,
- note_file_path: str = 'notes/notes.md',
+ working_directory: Optional[str] = None,
timeout: Optional[float] = None
):
```
@@ -29,7 +29,7 @@ Initialize the NoteTakingToolkit.
**Parameters:**
-- **note_file_path** (str): The path to the note file. (default: :obj:`notes/notes.md`)
+- **working_directory** (str, optional): The path to the note file. If not provided, it will be determined by the `CAMEL_WORKDIR` environment variable (if set), saving the note as `notes.md` in that directory. If the environment variable is not set, it defaults to `camel_working_dir/notes.md`.
- **timeout** (Optional[float]): The timeout for the toolkit.
<a id="camel.toolkits.note_taking_toolkit.NoteTakingToolkit.append_note"></a>
diff --git a/docs/mintlify/reference/camel.toolkits.pptx_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.pptx_toolkit.mdx
index 9bd7b1ce4..8c1e23e74 100644
--- a/docs/mintlify/reference/camel.toolkits.pptx_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.pptx_toolkit.mdx
@@ -19,14 +19,18 @@ title slides, content slides, text formatting, and image embedding.
### __init__
```python
-def __init__(self, output_dir: str = './', timeout: Optional[float] = None):
+def __init__(
+ self,
+ working_directory: Optional[str] = None,
+ timeout: Optional[float] = None
+):
```
Initialize the PPTXToolkit.
**Parameters:**
-- **output_dir** (str): The default directory for output files. Defaults to the current working directory.
+- **working_directory** (str, optional): The default directory for output files. If not provided, it will be determined by the `CAMEL_WORKDIR` environment variable (if set). If the environment variable is not set, it defaults to `camel_working_dir`.
- **timeout** (Optional[float]): The timeout for the toolkit. (default: :obj:`None`)
<a id="camel.toolkits.pptx_toolkit.PPTXToolkit._resolve_filepath"></a>
@@ -190,7 +194,7 @@ Create a PowerPoint presentation (PPTX) file.
**Parameters:**
- **content** (str): The content to write to the PPTX file as a JSON string. Must represent a list of dictionaries with the following structure: - First dict: title slide `{"title": str, "subtitle": str}` - Other dicts: content slides, which can be one of: * Bullet/step slides: `{"heading": str, "bullet_points": list of str or nested lists, "img_keywords": str (optional)}` - If any bullet point starts with '&gt;> ', it will be rendered as a step-by-step process. - "img_keywords" can be a URL or search keywords for an image (optional). * Table slides: `{"heading": str, "table": {"headers": list of str, "rows": list of list of str}}`
-- **filename** (str): The name or path of the file. If a relative path is supplied, it is resolved to self.output_dir.
+- **filename** (str): The name or path of the file. If a relative path is supplied, it is resolved to self.working_directory.
- **template** (Optional[str]): The path to the template PPTX file. Initializes a presentation from a given template file Or PPTX file. (default: :obj:`None`)
**Returns:**