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-bote0814db8bfb5
diff --git a/docs/reference/camel.toolkits.craw4ai_toolkit.md b/docs/reference/camel.toolkits.craw4ai_toolkit.md
new file mode 100644
index 000000000..75c0a6292
--- /dev/null
+++ b/docs/reference/camel.toolkits.craw4ai_toolkit.md
@@ -0,0 +1,32 @@
+<a id="camel.toolkits.craw4ai_toolkit"></a>
+
+<a id="camel.toolkits.craw4ai_toolkit.Crawl4AIToolkit"></a>
+
+## Crawl4AIToolkit
+
+```python
+class Crawl4AIToolkit(BaseToolkit):
+```
+
+A class representing a toolkit for Crawl4AI.
+
+<a id="camel.toolkits.craw4ai_toolkit.Crawl4AIToolkit.__init__"></a>
+
+### __init__
+
+```python
+def __init__(self, timeout: Optional[float] = None):
+```
+
+<a id="camel.toolkits.craw4ai_toolkit.Crawl4AIToolkit.get_tools"></a>
+
+### get_tools
+
+```python
+def get_tools(self):
+```
+
+**Returns:**
+
+ List[FunctionTool]: A list of FunctionTool objects
+representing the functions in the toolkit.
diff --git a/docs/reference/camel.toolkits.markitdown_toolkit.md b/docs/reference/camel.toolkits.markitdown_toolkit.md
new file mode 100644
index 000000000..dd1ab916e
--- /dev/null
+++ b/docs/reference/camel.toolkits.markitdown_toolkit.md
@@ -0,0 +1,68 @@
+<a id="camel.toolkits.markitdown_toolkit"></a>
+
+<a id="camel.toolkits.markitdown_toolkit.MarkItDownToolkit"></a>
+
+## MarkItDownToolkit
+
+```python
+class MarkItDownToolkit(BaseToolkit):
+```
+
+A class representing a toolkit for MarkItDown.
+
+<a id="camel.toolkits.markitdown_toolkit.MarkItDownToolkit.__init__"></a>
+
+### __init__
+
+```python
+def __init__(self, timeout: Optional[float] = None):
+```
+
+<a id="camel.toolkits.markitdown_toolkit.MarkItDownToolkit.load_files"></a>
+
+### load_files
+
+```python
+def load_files(self, file_paths: List[str]):
+```
+
+Scrapes content from a list of files and converts it to Markdown.
+
+This function takes a list of local file paths, attempts to convert
+each file into Markdown format, and returns the converted content.
+The conversion is performed in parallel for efficiency.
+
+Supported file formats include:
+- PDF (.pdf)
+- Microsoft Office: Word (.doc, .docx), Excel (.xls, .xlsx),
+PowerPoint (.ppt, .pptx)
+- EPUB (.epub)
+- HTML (.html, .htm)
+- Images (.jpg, .jpeg, .png) for OCR
+- Audio (.mp3, .wav) for transcription
+- Text-based formats (.csv, .json, .xml, .txt)
+- ZIP archives (.zip)
+
+**Parameters:**
+
+- **file_paths** (List[str]): A list of local file paths to be converted.
+
+**Returns:**
+
+ Dict[str, str]: A dictionary where keys are the input file paths
+and values are the corresponding content in Markdown format.
+If conversion of a file fails, the value will contain an
+error message.
+
+<a id="camel.toolkits.markitdown_toolkit.MarkItDownToolkit.get_tools"></a>
+
+### get_tools
+
+```python
+def get_tools(self):
+```
+
+**Returns:**
+
+ List[FunctionTool]: A list of FunctionTool objects
+representing the functions in the toolkit.