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-bot4bfa16428672
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.json
index 1f33399d5..875ee3fbb 100644
--- a/docs/mintlify/docs.json
+++ b/docs/mintlify/docs.json
@@ -498,6 +498,7 @@
"reference/camel.toolkits.meshy_toolkit",
"reference/camel.toolkits.mineru_toolkit",
"reference/camel.toolkits.networkx_toolkit",
+ "reference/camel.toolkits.note_taking_toolkit",
"reference/camel.toolkits.notion_toolkit",
"reference/camel.toolkits.open_api_toolkit",
"reference/camel.toolkits.openai_agent_toolkit",
diff --git a/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx
index 3c47186d6..69090340a 100644
--- a/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx
@@ -132,7 +132,7 @@ Write text content to a PDF file with default formatting.
- **file_path** (Path): The target file path.
- **title** (str): The title of the document.
- **content** (str): The text content to write.
-- **use_latex** (bool): Whether to use LaTeX for rendering. (requires LaTeX toolchain). If False, uses PyMuPDF for simpler PDF generation. (default: :obj:`False`)
+- **use_latex** (bool): Whether to use LaTeX for rendering. Only Recommended for documents with mathematical formulas or complex typesetting needs. (default: :obj:`False`)
<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._write_csv_file"></a>
@@ -267,7 +267,7 @@ and HTML (.html, .htm).
- **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.
- **encoding** (Optional[str]): The character encoding to use. (default: :obj: `None`)
-- **use_latex** (bool): For PDF files, whether to use LaTeX rendering (True) or simple FPDF rendering (False). (default: :obj: `False`)
+- **use_latex** (bool): For PDF files, whether to use LaTeX rendering. Only recommended for documents with mathematical formulas or complex typesetting needs. (default: :obj:`False`)
**Returns:**
diff --git a/docs/mintlify/reference/camel.toolkits.note_taking_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.note_taking_toolkit.mdx
new file mode 100644
index 000000000..0893344f8
--- /dev/null
+++ b/docs/mintlify/reference/camel.toolkits.note_taking_toolkit.mdx
@@ -0,0 +1,77 @@
+<a id="camel.toolkits.note_taking_toolkit"></a>
+
+<a id="camel.toolkits.note_taking_toolkit.NoteTakingToolkit"></a>
+
+## NoteTakingToolkit
+
+```python
+class NoteTakingToolkit(BaseToolkit):
+```
+
+A toolkit for taking notes in a Markdown file.
+
+This toolkit allows an agent to create, append to, and update a specific
+Markdown file for note-taking purposes.
+
+<a id="camel.toolkits.note_taking_toolkit.NoteTakingToolkit.__init__"></a>
+
+### __init__
+
+```python
+def __init__(
+ self,
+ note_file_path: str = 'notes/notes.md',
+ timeout: Optional[float] = None
+):
+```
+
+Initialize the NoteTakingToolkit.
+
+**Parameters:**
+
+- **note_file_path** (str): The path to the note file. (default: :obj:`notes/notes.md`)
+- **timeout** (Optional[float]): The timeout for the toolkit.
+
+<a id="camel.toolkits.note_taking_toolkit.NoteTakingToolkit.take_note"></a>
+
+### take_note
+
+```python
+def take_note(self, content: str, update: bool = False):
+```
+
+Takes a note and saves it to the note file.
+
+**Parameters:**
+
+- **content** (str): The content of the note to be saved.
+- **update** (bool): If True, the existing note file will be overwritten with the new content. If False, the new content will be appended to the end of the file. (default: :obj:`False`)
+
+**Returns:**
+
+ str: A message indicating the result of the operation.
+
+<a id="camel.toolkits.note_taking_toolkit.NoteTakingToolkit.read_note"></a>
+
+### read_note
+
+```python
+def read_note(self):
+```
+
+**Returns:**
+
+ str: The content of the note file, or an error message if the
+file cannot be read.
+
+<a id="camel.toolkits.note_taking_toolkit.NoteTakingToolkit.get_tools"></a>
+
+### get_tools
+
+```python
+def get_tools(self):
+```
+
+**Returns:**
+
+ List[FunctionTool]: A list of FunctionTool objects.