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-bot21b486b79f9d
diff --git a/docs/reference/camel.loaders.base_loader.md b/docs/reference/camel.loaders.base_loader.md
new file mode 100644
index 000000000..321225416
--- /dev/null
+++ b/docs/reference/camel.loaders.base_loader.md
@@ -0,0 +1,64 @@
+<a id="camel.loaders.base_loader"></a>
+
+<a id="camel.loaders.base_loader.BaseLoader"></a>
+
+## BaseLoader
+
+```python
+class BaseLoader(ABC):
+```
+
+Abstract base class for all data loaders in CAMEL.
+
+<a id="camel.loaders.base_loader.BaseLoader._load_single"></a>
+
+### _load_single
+
+```python
+def _load_single(self, source: Union[str, Path]):
+```
+
+Load data from a single source.
+
+**Parameters:**
+
+- **source** (Union[str, Path]): The data source to load from.
+
+**Returns:**
+
+ Dict[str, Any]: A dictionary containing the loaded data. It is
+recommended that the dictionary includes a "content" key with
+the primary data and optional metadata keys.
+
+<a id="camel.loaders.base_loader.BaseLoader.load"></a>
+
+### load
+
+```python
+def load(self, source: Union[str, Path, List[Union[str, Path]]]):
+```
+
+Load data from one or multiple sources.
+
+**Parameters:**
+
+- **source** (Union[str, Path, List[Union[str, Path]]]): The data source (s) to load from. Can be: - A single path/URL (str or Path) - A list of paths/URLs
+
+**Returns:**
+
+ Dict[str, List[Dict[str, Any]]]: A dictionary with a single key
+"contents" containing a list of loaded data. If a single source
+is provided, the list will contain a single item.
+
+<a id="camel.loaders.base_loader.BaseLoader.supported_formats"></a>
+
+### supported_formats
+
+```python
+def supported_formats(self):
+```
+
+**Returns:**
+
+ set[str]: A set of strings representing the supported formats/
+sources.