🐫 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-bot64057ec26aa9
diff --git a/docs/mintlify/reference/camel.runtimes.configs.mdx b/docs/mintlify/reference/camel.runtimes.configs.mdxindex 625bc8023..5c5a90740 100644--- a/docs/mintlify/reference/camel.runtimes.configs.mdx+++ b/docs/mintlify/reference/camel.runtimes.configs.mdx@@ -12,21 +12,21 @@ A configuration for a task to run a command inside the container.Arttributes:cmd (str or list): Command to be executed-stdout (bool): Attach to stdout. (default: :obj: `True`)-stderr (bool): Attach to stderr. (default: :obj: `True`)-stdin (bool): Attach to stdin. (default: :obj: `False`)-tty (bool): Allocate a pseudo-TTY. (default: :obj: `False`)-privileged (bool): Run as privileged. (default: :obj: `False`)-user (str): User to execute command as. (default: :obj: `""`)+stdout (bool): Attach to stdout. (default: :obj:`True`)+stderr (bool): Attach to stderr. (default: :obj:`True`)+stdin (bool): Attach to stdin. (default: :obj:`False`)+tty (bool): Allocate a pseudo-TTY. (default: :obj:`False`)+privileged (bool): Run as privileged. (default: :obj:`False`)+user (str): User to execute command as. (default: :obj:`""`)detach (bool): If true, detach from the exec command.-(default: :obj: `False`)-stream (bool): Stream response data. (default: :obj: `False`)+(default: :obj:`False`)+stream (bool): Stream response data. (default: :obj:`False`)socket (bool): Return the connection socket to allow custom-read/write operations. (default: :obj: `False`)+read/write operations. (default: :obj:`False`)environment (dict or list): A dictionary or a list of strings inthe following format `__INLINE_CODE_9__` or`__INLINE_CODE_10____INLINE_CODE_11__None`)workdir (str): Path to working directory for this exec session.-(default: :obj: `None`)+(default: :obj:`None`)demux (bool): Return stdout and stderr separately. (default: :obj:`False`)diff --git a/docs/mintlify/reference/camel.runtimes.daytona_runtime.mdx b/docs/mintlify/reference/camel.runtimes.daytona_runtime.mdxindex b256a7e5d..3309b9a3d 100644--- a/docs/mintlify/reference/camel.runtimes.daytona_runtime.mdx+++ b/docs/mintlify/reference/camel.runtimes.daytona_runtime.mdx@@ -13,9 +13,9 @@ Requires the Daytona server to be running and an API key configured.**Parameters:**-- **api_key** (Optional[str]): The Daytona API key for authentication. If not provided, it will try to use the DAYTONA_API_KEY environment variable. (default: :obj: `None`)-- **api_url** (Optional[str]): The URL of the Daytona server. If not provided, it will try to use the DAYTONA_API_URL environment variable. If none is provided, it will use "http://localhost:8000". (default: :obj: `None`)-- **language** (Optional[str]): The programming language for the sandbox. (default: :obj: `"python"`)+- **api_key** (Optional[str]): The Daytona API key for authentication. If not provided, it will try to use the DAYTONA_API_KEY environment variable. (default: :obj:`None`)+- **api_url** (Optional[str]): The URL of the Daytona server. If not provided, it will try to use the DAYTONA_API_URL environment variable. If none is provided, it will use "http://localhost:8000". (default: :obj:`None`)+- **language** (Optional[str]): The programming language for the sandbox. (default: :obj:`"python"`)<a id="camel.runtimes.daytona_runtime.DaytonaRuntime.__init__"></a>@@ -71,7 +71,7 @@ Add a function or list of functions to the runtime.- **funcs** (Union[FunctionTool, List[FunctionTool]]): The function or list of functions to add.- **entrypoint** (str): The entrypoint for the function.-- **arguments** (Optional[Dict[str, Any]]): The arguments for the function. (default: :obj: `None`)+- **arguments** (Optional[Dict[str, Any]]): The arguments for the function. (default: :obj:`None`)**Returns:**diff --git a/docs/mintlify/reference/camel.runtimes.docker_runtime.mdx b/docs/mintlify/reference/camel.runtimes.docker_runtime.mdxindex 190a8639d..85d58534f 100644--- a/docs/mintlify/reference/camel.runtimes.docker_runtime.mdx+++ b/docs/mintlify/reference/camel.runtimes.docker_runtime.mdx@@ -16,7 +16,7 @@ in a Docker container.- **image** (str): The name of the Docker image to use for the runtime.- **port** (int): The port number to use for the runtime API. (default: :obj: `8000`)-- **remove** (bool): Whether to remove the container after stopping it. ' (default: :obj: `True`)+- **remove** (bool): Whether to remove the container after stopping it. ' (default: :obj:`True`)- **kwargs** (dict): Additional keyword arguments to pass to the Docker client.<a id="camel.runtimes.docker_runtime.DockerRuntime.__init__"></a>@@ -128,7 +128,7 @@ Build the Docker container and start it.**Parameters:**-- **time_out** (int): The number of seconds to wait for the container to start. (default: :obj: `15`)+- **time_out** (int): The number of seconds to wait for the container to start. (default: :obj:`15`)**Returns:**@@ -154,8 +154,8 @@ Add a function or list of functions to the runtime.- **funcs** (Union[FunctionTool, List[FunctionTool]]): The function or list of functions to add.- **entrypoint** (str): The entrypoint for the function.-- **redirect_stdout** (bool): Whether to return the stdout of the function. (default: :obj: `False`)-- **arguments** (Optional[Dict[str, Any]]): The arguments for the function. (default: :obj: `None`)+- **redirect_stdout** (bool): Whether to return the stdout of the function. (default: :obj:`False`)+- **arguments** (Optional[Dict[str, Any]]): The arguments for the function. (default: :obj:`None`)**Returns:**@@ -185,7 +185,7 @@ stop the Docker container.**Parameters:**-- **remove** (Optional[bool]): Whether to remove the container after stopping it. (default: :obj: `None`)+- **remove** (Optional[bool]): Whether to remove the container after stopping it. (default: :obj:`None`)**Returns:**@@ -215,7 +215,7 @@ Wait for the API Server to be ready.**Parameters:**-- **timeout** (int): The number of seconds to wait. (default: :obj: `10`) (default: 10)+- **timeout** (int): The number of seconds to wait. (default: :obj:`10`) (default: 10)**Returns:**diff --git a/docs/mintlify/reference/camel.runtimes.remote_http_runtime.mdx b/docs/mintlify/reference/camel.runtimes.remote_http_runtime.mdxindex 24e63a40b..91f19a909 100644--- a/docs/mintlify/reference/camel.runtimes.remote_http_runtime.mdx+++ b/docs/mintlify/reference/camel.runtimes.remote_http_runtime.mdx@@ -14,8 +14,8 @@ You need to run the API server in the remote server first.**Parameters:**- **host** (str): The host of the remote server.-- **port** (int): The port of the remote server. (default: :obj: `8000`) (default: 8000)-- **python_exec** (str): The python executable to run the API server. (default: :obj: `python3`)+- **port** (int): The port of the remote server. (default: :obj:`8000`) (default: 8000)+- **python_exec** (str): The python executable to run the API server. (default: :obj:`python3`)<a id="camel.runtimes.remote_http_runtime.RemoteHttpRuntime.__init__"></a>@@ -72,8 +72,8 @@ Add a function or list of functions to the runtime.- **funcs** (Union[FunctionTool, List[FunctionTool]]): The function or list of functions to add.- **entrypoint** (str): The entrypoint for the function.-- **redirect_stdout** (bool): Whether to return the stdout of the function. (default: :obj: `False`)-- **arguments** (Optional[Dict[str, Any]]): The arguments for the function. (default: :obj: `None`)+- **redirect_stdout** (bool): Whether to return the stdout of the function. (default: :obj:`False`)+- **arguments** (Optional[Dict[str, Any]]): The arguments for the function. (default: :obj:`None`)**Returns:**@@ -103,7 +103,7 @@ Wait for the API Server to be ready.**Parameters:**-- **timeout** (int): The number of seconds to wait. (default: :obj: `10`) (default: 10)+- **timeout** (int): The number of seconds to wait. (default: :obj:`10`) (default: 10)**Returns:**diff --git a/docs/mintlify/reference/camel.societies.workforce.single_agent_worker.mdx b/docs/mintlify/reference/camel.societies.workforce.single_agent_worker.mdxindex 1dc83058b..2ebc1cd4f 100644--- a/docs/mintlify/reference/camel.societies.workforce.single_agent_worker.mdx+++ b/docs/mintlify/reference/camel.societies.workforce.single_agent_worker.mdx@@ -1,5 +1,73 @@<a id="camel.societies.workforce.single_agent_worker"></a>+<a id="camel.societies.workforce.single_agent_worker.AgentPool"></a>++## AgentPool++```python+class AgentPool:+```++A pool of agent instances for efficient reuse.++This pool manages a collection of pre-cloned agents. It supports+auto-scaling based ondemand and intelligent reuse of existing agents.++**Parameters:**++- **base_agent** (ChatAgent): The base agent to clone from.+- **initial_size** (int): Initial number of agents in the pool. (default: :obj:`1`)+- **max_size** (int): Maximum number of agents in the pool. (default: :obj:`10`)+- **auto_scale** (bool): Whether to automatically scale the pool size. (default: :obj:`True`)+- **scale_factor** (float): Factor by which to scale the pool when needed. (default: :obj:`1.5`)+- **idle_timeout** (float): Time in seconds after which idle agents are removed. (default: :obj:`180.0`)++<a id="camel.societies.workforce.single_agent_worker.AgentPool.__init__"></a>++### __init__++```python+def __init__(+ self,+ base_agent: ChatAgent,+ initial_size: int = 1,+ max_size: int = 10,+ auto_scale: bool = True,+ scale_factor: float = 1.5,+ idle_timeout: float = 180.0+):+```++<a id="camel.societies.workforce.single_agent_worker.AgentPool._initialize_pool"></a>++### _initialize_pool++```python+def _initialize_pool(self, size: int):+```++Initialize the pool with the specified number of agents.++<a id="camel.societies.workforce.single_agent_worker.AgentPool._create_fresh_agent"></a>++### _create_fresh_agent++```python+def _create_fresh_agent(self):+```++Create a fresh agent instance.++<a id="camel.societies.workforce.single_agent_worker.AgentPool.get_stats"></a>++### get_stats++```python+def get_stats(self):+```++Get pool statistics.+<a id="camel.societies.workforce.single_agent_worker.SingleAgentWorker"></a>## SingleAgentWorker@@ -14,7 +82,10 @@ A worker node that consists of a single agent.- **description** (str): Description of the node.- **worker** (ChatAgent): Worker of the node. A single agent.-- **max_concurrent_tasks** (int): Maximum number of tasks this worker can process concurrently. (default: :obj:`10`)+- **use_agent_pool** (bool): Whether to use agent pool for efficiency. (default: :obj:`True`)+- **pool_initial_size** (int): Initial size of the agent pool. (default: :obj:`1`)+- **pool_max_size** (int): Maximum size of the agent pool. (default: :obj:`10`)+- **auto_scale_pool** (bool): Whether to auto-scale the agent pool. (default: :obj:`True`)<a id="camel.societies.workforce.single_agent_worker.SingleAgentWorker.__init__"></a>@@ -25,7 +96,10 @@ def __init__(self,description: str,worker: ChatAgent,- max_concurrent_tasks: int = 10+ use_agent_pool: bool = True,+ pool_initial_size: int = 1,+ pool_max_size: int = 10,+ auto_scale_pool: bool = True):```@@ -38,3 +112,13 @@ def reset(self):```Resets the worker to its initial state.++<a id="camel.societies.workforce.single_agent_worker.SingleAgentWorker.get_pool_stats"></a>++### get_pool_stats++```python+def get_pool_stats(self):+```++Get agent pool statistics if pool is enabled.diff --git a/docs/mintlify/reference/camel.societies.workforce.worker.mdx b/docs/mintlify/reference/camel.societies.workforce.worker.mdxindex 1db57550e..ce7498fdb 100644--- a/docs/mintlify/reference/camel.societies.workforce.worker.mdx+++ b/docs/mintlify/reference/camel.societies.workforce.worker.mdx@@ -15,19 +15,13 @@ processing in the workforce system.- **description** (str): Description of the node.- **node_id** (Optional[str]): ID of the node. If not provided, it will be generated automatically. (default: :obj:`None`)-- **max_concurrent_tasks** (int): Maximum number of tasks this worker can process concurrently. (default: :obj:`10`)<a id="camel.societies.workforce.worker.Worker.__init__"></a>### __init__```python-def __init__(- self,- description: str,- node_id: Optional[str] = None,- max_concurrent_tasks: int = 10-):+def __init__(self, description: str, node_id: Optional[str] = None):```<a id="camel.societies.workforce.worker.Worker.__repr__"></a>diff --git a/docs/mintlify/reference/camel.societies.workforce.workforce.mdx b/docs/mintlify/reference/camel.societies.workforce.workforce.mdxindex 46c0f3a6c..03689a2e2 100644--- a/docs/mintlify/reference/camel.societies.workforce.workforce.mdx+++ b/docs/mintlify/reference/camel.societies.workforce.workforce.mdx@@ -358,7 +358,7 @@ def add_single_agent_worker(self,description: str,worker: ChatAgent,- max_concurrent_tasks: int = 10+ pool_max_size: int = 10):```@@ -368,7 +368,7 @@ Add a worker node to the workforce that uses a single agent.- **description** (str): Description of the worker node.- **worker** (ChatAgent): The agent to be added.-- **max_concurrent_tasks** (int): Maximum number of tasks this worker can process concurrently. (default: :obj:`10`)+- **pool_max_size** (int): Maximum size of the agent pool. (default: :obj:`10`)**Returns:**diff --git a/docs/mintlify/reference/camel.tasks.task.mdx b/docs/mintlify/reference/camel.tasks.task.mdxindex f5a3e0e2a..5e9ae310a 100644--- a/docs/mintlify/reference/camel.tasks.task.mdx+++ b/docs/mintlify/reference/camel.tasks.task.mdx@@ -70,14 +70,14 @@ Task is specific assignment that can be passed to a agent.**Parameters:**- **content** (str): string content for task.-- **id** (str): An unique string identifier for the task. This should ideally be provided by the provider/model which created the task. (default: :obj: `""`)-- **state** (TaskState): The state which should be OPEN, RUNNING, DONE or DELETED. (default: :obj: `TaskState.OPEN`)-- **type** (Optional[str]): task type. (default: :obj: `None`) (default: None)-- **parent** (Optional[Task]): The parent task, None for root task. (default: :obj: `None`)-- **subtasks** (List[Task]): The childrent sub-tasks for the task. (default: :obj: `[]`)-- **result** (Optional[str]): The answer for the task. (default: :obj: `""`)-- **failure_count** (int): The failure count for the task. (default: :obj: `0`)-- **additional_info** (Optional[Dict[str, Any]]): Additional information for the task. (default: :obj: `None`)+- **id** (str): An unique string identifier for the task. This should ideally be provided by the provider/model which created the task. (default: :obj:`uuid.uuid4()`)+- **state** (TaskState): The state which should be OPEN, RUNNING, DONE or DELETED. (default: :obj:`TaskState.FAILED`)+- **type** (Optional[str]): task type. (default: :obj:`None`)+- **parent** (Optional[Task]): The parent task, None for root task. (default: :obj:`None`)+- **subtasks** (List[Task]): The childrent sub-tasks for the task. (default: :obj:`[]`)+- **result** (Optional[str]): The answer for the task. (default: :obj:`""`)+- **failure_count** (int): The failure count for the task. (default: :obj:`0`)+- **additional_info** (Optional[Dict[str, Any]]): Additional information for the task. (default: :obj:`None`)<a id="camel.tasks.task.Task.__repr__"></a>diff --git a/docs/mintlify/reference/camel.toolkits.aci_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.aci_toolkit.mdxindex e3a710b86..522f19577 100644--- a/docs/mintlify/reference/camel.toolkits.aci_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.aci_toolkit.mdx@@ -28,10 +28,10 @@ Initialize the ACI toolkit.**Parameters:**-- **api_key** (Optional[str]): The API key for authentication. (default: :obj: `None`)-- **base_url** (Optional[str]): The base URL for the ACI API. (default: :obj: `None`)-- **linked_account_owner_id** (Optional[str]): ID of the owner of the linked account, e.g., "johndoe" (default: :obj: `None`)-- **timeout** (Optional[float]): Request timeout. (default: :obj: `None`)+- **api_key** (Optional[str]): The API key for authentication. (default: :obj:`None`)+- **base_url** (Optional[str]): The base URL for the ACI API. (default: :obj:`None`)+- **linked_account_owner_id** (Optional[str]): ID of the owner of the linked account, e.g., "johndoe" (default: :obj:`None`)+- **timeout** (Optional[float]): Request timeout. (default: :obj:`None`)<a id="camel.toolkits.aci_toolkit.ACIToolkit.search_tool"></a>@@ -53,12 +53,12 @@ Search for apps based on intent.**Parameters:**-- **intent** (Optional[str]): Search results will be sorted by relevance to this intent. (default: :obj: `None`)-- **allowed_app_only** (bool): If true, only return apps that are allowed by the agent/accessor, identified by the api key. (default: :obj: `True`)-- **include_functions** (bool): If true, include functions (name and description) in the search results. (default: :obj: `False`)-- **categories** (Optional[List[str]]): List of categories to filter the search results. Defaults to an empty list. (default: :obj: `None`)-- **limit** (Optional[int]): Maximum number of results to return. (default: :obj: `10`)-- **offset** (Optional[int]): Offset for pagination. (default: :obj: `0`)+- **intent** (Optional[str]): Search results will be sorted by relevance to this intent. (default: :obj:`None`)+- **allowed_app_only** (bool): If true, only return apps that are allowed by the agent/accessor, identified by the api key. (default: :obj:`True`)+- **include_functions** (bool): If true, include functions (name and description) in the search results. (default: :obj:`False`)+- **categories** (Optional[List[str]]): List of categories to filter the search results. Defaults to an empty list. (default: :obj:`None`)+- **limit** (Optional[int]): Maximum number of results to return. (default: :obj:`10`)+- **offset** (Optional[int]): Offset for pagination. (default: :obj:`0`)**Returns:**@@ -82,9 +82,9 @@ List all configured apps.**Parameters:**-- **app_names** (Optional[List[str]]): List of app names to filter the results. (default: :obj: `None`)-- **limit** (Optional[int]): Maximum number of results to return. (default: :obj: `10`)-- **offset** (Optional[int]): Offset for pagination. (default: :obj: `0`) (default: 0)+- **app_names** (Optional[List[str]]): List of app names to filter the results. (default: :obj:`None`)+- **limit** (Optional[int]): Maximum number of results to return. (default: :obj:`10`)+- **offset** (Optional[int]): Offset for pagination. (default: :obj:`0`) (default: 0)**Returns:**@@ -295,11 +295,11 @@ Search for functions based on intent.**Parameters:**-- **app_names** (Optional[List[str]]): List of app names to filter the search results. (default: :obj: `None`)-- **intent** (Optional[str]): The search query/intent. (default: :obj: `None`)-- **allowed_apps_only** (bool): If true, only return functions from allowed apps. (default: :obj: `True`)-- **limit** (Optional[int]): Maximum number of results to return. (default: :obj: `10`)-- **offset** (Optional[int]): Offset for pagination. (default: :obj: `0`)+- **app_names** (Optional[List[str]]): List of app names to filter the search results. (default: :obj:`None`)+- **intent** (Optional[str]): The search query/intent. (default: :obj:`None`)+- **allowed_apps_only** (bool): If true, only return functions from allowed apps. (default: :obj:`True`)+- **limit** (Optional[int]): Maximum number of results to return. (default: :obj:`10`)+- **offset** (Optional[int]): Offset for pagination. (default: :obj:`0`)**Returns:**@@ -326,7 +326,7 @@ Execute a function call.- **function_name** (str): Name of the function to execute.- **function_arguments** (Dict): Arguments to pass to the function.- **linked_account_owner_id** (str): To specify the end-user (account owner) on behalf of whom you want to execute functions You need to first link corresponding account with the same owner id in the ACI dashboard (https://platform.aci.dev).-- **allowed_apps_only** (bool): If true, only returns functions/apps that are allowed to be used by the agent/accessor, identified by the api key. (default: :obj: `False`)+- **allowed_apps_only** (bool): If true, only returns functions/apps that are allowed to be used by the agent/accessor, identified by the api key. (default: :obj:`False`)**Returns:**diff --git a/docs/mintlify/reference/camel.toolkits.arxiv_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.arxiv_toolkit.mdxindex 35edf0aaf..0e46819e1 100644--- a/docs/mintlify/reference/camel.toolkits.arxiv_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.arxiv_toolkit.mdx@@ -40,8 +40,8 @@ query and optional paper IDs.**Parameters:**- **query** (str): The search query string used to search for papers on arXiv.-- **paper_ids** (List[str], optional): A list of specific arXiv paper IDs to search for. (default: :obj: `None`)-- **max_results** (int, optional): The maximum number of search results to retrieve. (default: :obj: `5`)+- **paper_ids** (List[str], optional): A list of specific arXiv paper IDs to search for. (default: :obj:`None`)+- **max_results** (int, optional): The maximum number of search results to retrieve. (default: :obj:`5`)**Returns:**@@ -68,8 +68,8 @@ optional paper IDs.**Parameters:**- **query** (str): The search query string.-- **paper_ids** (List[str], optional): A list of specific arXiv paper IDs to search for. (default: :obj: `None`)-- **max_results** (int, optional): The maximum number of search results to return. (default: :obj: `5`)+- **paper_ids** (List[str], optional): A list of specific arXiv paper IDs to search for. (default: :obj:`None`)+- **max_results** (int, optional): The maximum number of search results to return. (default: :obj:`5`)**Returns:**@@ -97,8 +97,8 @@ query.**Parameters:**- **query** (str): The search query string.-- **paper_ids** (List[str], optional): A list of specific arXiv paper IDs to download. (default: :obj: `None`)-- **max_results** (int, optional): The maximum number of search results to download. (default: :obj: `5`)+- **paper_ids** (List[str], optional): A list of specific arXiv paper IDs to download. (default: :obj:`None`)+- **max_results** (int, optional): The maximum number of search results to download. (default: :obj:`5`)- **output_dir** (str, optional): The directory to save the downloaded PDFs. Defaults to the current directory.**Returns:**diff --git a/docs/mintlify/reference/camel.toolkits.dappier_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.dappier_toolkit.mdxindex 2c941527a..681f33484 100644--- a/docs/mintlify/reference/camel.toolkits.dappier_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.dappier_toolkit.mdx@@ -104,10 +104,10 @@ sources like The Mix, Snipdaily, Nerdable, and Familyproof.**Parameters:**- **query** (str): The user query for retrieving recommendations.-- **data_model_id** (str, optional): The data model ID to use for recommendations. Data model IDs always start with the prefix "dm_". (default: :obj: `dm_01j0pb465keqmatq9k83dthx34`)-- **similarity_top_k** (int, optional): The number of top documents to retrieve based on similarity. (default: :obj: `9`)-- **ref** (Optional[str], optional): The site domain where AI recommendations should be displayed. (default: :obj: `None`)-- **num_articles_ref** (int, optional): The minimum number of articles to return from the specified reference domain (`ref`). The remaining articles will come from other sites in the RAG model. (default: :obj: `0`) search_algorithm (Literal[ "most_recent", "semantic", "most_recent_semantic", "trending", ], optional): The search algorithm to use for retrieving articles. (default: :obj: `most_recent`)+- **data_model_id** (str, optional): The data model ID to use for recommendations. Data model IDs always start with the prefix "dm_". (default: :obj:`dm_01j0pb465keqmatq9k83dthx34`)+- **similarity_top_k** (int, optional): The number of top documents to retrieve based on similarity. (default: :obj:`9`)+- **ref** (Optional[str], optional): The site domain where AI recommendations should be displayed. (default: :obj:`None`)+- **num_articles_ref** (int, optional): The minimum number of articles to return from the specified reference domain (`ref`). The remaining articles will come from other sites in the RAG model. (default: :obj:`0`) search_algorithm (Literal[ "most_recent", "semantic", "most_recent_semantic", "trending", ], optional): The search algorithm to use for retrieving articles. (default: :obj:`most_recent`)**Returns:**diff --git a/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdxindex 77609827b..e67194c41 100644--- a/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.file_write_toolkit.mdx@@ -34,9 +34,9 @@ Initialize the FileWriteToolkit.**Parameters:**- **output_dir** (str): The default directory for output files. Defaults to the current working directory.-- **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`)+- **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`)<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._resolve_filepath"></a>@@ -80,7 +80,7 @@ Write text content to a plaintext file.- **file_path** (Path): The target file path.- **content** (str): The text content to write.-- **encoding** (str): Character encoding to use. (default: :obj: `utf-8`) (default: utf-8)+- **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8)<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._create_backup"></a>@@ -130,7 +130,7 @@ Write text content to a PDF file with default formatting.- **file_path** (Path): The target file path.- **content** (str): The text content to write.-- **use_latex** (bool): Whether to use LaTeX for rendering. (requires LaTeX toolchain). If False, uses FPDF for simpler PDF generation. (default: :obj: `False`)+- **use_latex** (bool): Whether to use LaTeX for rendering. (requires LaTeX toolchain). If False, uses FPDF for simpler PDF generation. (default: :obj:`False`)<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._write_csv_file"></a>@@ -151,7 +151,7 @@ Write CSV content to a file.- **file_path** (Path): The target file path.- **content** (Union[str, List[List]]): The CSV content as a string or list of lists.-- **encoding** (str): Character encoding to use. (default: :obj: `utf-8`) (default: utf-8)+- **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8)<a id="camel.toolkits.file_write_toolkit.FileWriteToolkit._write_json_file"></a>@@ -172,7 +172,7 @@ Write JSON content to a file.- **file_path** (Path): The target file path.- **content** (str): The JSON content as a string.-- **encoding** (str): Character encoding to use. (default: :obj: `utf-8`) (default: utf-8)+- **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>@@ -193,7 +193,7 @@ Write YAML content to a file.- **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)+- **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>@@ -214,7 +214,7 @@ Write text content to an HTML file.- **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)+- **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>@@ -235,7 +235,7 @@ Write text content to a Markdown file.- **file_path** (Path): The target file path.- **content** (str): The Markdown content to write.-- **encoding** (str): Character encoding to use. (default: :obj: `utf-8`) (default: utf-8)+- **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>diff --git a/docs/mintlify/reference/camel.toolkits.github_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.github_toolkit.mdxindex 663affa9a..3dce0c210 100644--- a/docs/mintlify/reference/camel.toolkits.github_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.github_toolkit.mdx@@ -102,7 +102,7 @@ Retrieves all issues from the GitHub repository.**Parameters:**- **repo_name** (str): The name of the GitHub repository.-- **state** (`Literal["open", "closed", "all"]`): The state of pull requests to retrieve. (default: :obj: `all`) Options are: - "open": Retrieve only open pull requests. - "closed": Retrieve only closed pull requests. - "all": Retrieve all pull requests, regardless of state.+- **state** (`Literal["open", "closed", "all"]`): The state of pull requests to retrieve. (default: :obj:`all`) Options are: - "open": Retrieve only open pull requests. - "closed": Retrieve only closed pull requests. - "all": Retrieve all pull requests, regardless of state.**Returns:**@@ -145,7 +145,7 @@ Retrieves all pull requests from the GitHub repository.**Parameters:**- **repo_name** (str): The name of the GitHub repository.-- **state** (`Literal["open", "closed", "all"]`): The state of pull requests to retrieve. (default: :obj: `all`) Options are: - "open": Retrieve only open pull requests. - "closed": Retrieve only closed pull requests. - "all": Retrieve all pull requests, regardless of state.+- **state** (`Literal["open", "closed", "all"]`): The state of pull requests to retrieve. (default: :obj:`all`) Options are: - "open": Retrieve only open pull requests. - "closed": Retrieve only closed pull requests. - "all": Retrieve all pull requests, regardless of state.**Returns:**@@ -206,7 +206,7 @@ Recursively retrieves all file paths in the GitHub repository.**Parameters:**- **repo_name** (str): The name of the GitHub repository.-- **path** (str): The repository path to start the traversal from. empty string means starts from the root directory. (default: :obj: `""`)+- **path** (str): The repository path to start the traversal from. empty string means starts from the root directory. (default: :obj:`""`)**Returns:**diff --git a/docs/mintlify/reference/camel.toolkits.pptx_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.pptx_toolkit.mdxindex 37f1c1cd1..9bd7b1ce4 100644--- a/docs/mintlify/reference/camel.toolkits.pptx_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.pptx_toolkit.mdx@@ -27,7 +27,7 @@ Initialize the PPTXToolkit.**Parameters:**- **output_dir** (str): The default directory for output files. Defaults to the current working directory.-- **timeout** (Optional[float]): The timeout for the toolkit. (default: :obj: `None`)+- **timeout** (Optional[float]): The timeout for the toolkit. (default: :obj:`None`)<a id="camel.toolkits.pptx_toolkit.PPTXToolkit._resolve_filepath"></a>@@ -90,7 +90,7 @@ word order.- **frame_paragraph**: The paragraph to format.- **text** (str): The text to format.-- **set_color_to_white** (bool): Whether to set the color to white. (default: :obj: `False`)+- **set_color_to_white** (bool): Whether to set the color to white. (default: :obj:`False`)<a id="camel.toolkits.pptx_toolkit.PPTXToolkit._add_bulleted_items"></a>@@ -111,7 +111,7 @@ Add a list of texts as bullet points and apply formatting.- **text_frame** (TextFrame): The text frame where text is to be displayed.- **flat_items_list** (List[Tuple[str, int]]): The list of items to be displayed.-- **set_color_to_white** (bool): Whether to set the font color to white. (default: :obj: `False`)+- **set_color_to_white** (bool): Whether to set the font color to white. (default: :obj:`False`)<a id="camel.toolkits.pptx_toolkit.PPTXToolkit._get_flat_list_of_contents"></a>@@ -191,7 +191,7 @@ Create a PowerPoint presentation (PPTX) file.- **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 '>> ', 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.-- **template** (Optional[str]): The path to the template PPTX file. Initializes a presentation from a given template file Or PPTX file. (default: :obj: `None`)+- **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:**diff --git a/docs/mintlify/reference/camel.toolkits.sympy_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.sympy_toolkit.mdxindex 7c6206c3b..960a5f70f 100644--- a/docs/mintlify/reference/camel.toolkits.sympy_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.sympy_toolkit.mdx@@ -28,7 +28,7 @@ Initializes the toolkit with a default variable and logging.**Parameters:**-- **default_variable** (str): The default variable for operations (default: :obj: `x`)+- **default_variable** (str): The default variable for operations (default: :obj:`x`)<a id="camel.toolkits.sympy_toolkit.SymPyToolkit.simplify_expression"></a>diff --git a/docs/mintlify/reference/camel.toolkits.task_planning_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.task_planning_toolkit.mdxindex 8e2f44dfe..119a20cbb 100644--- a/docs/mintlify/reference/camel.toolkits.task_planning_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.task_planning_toolkit.mdx@@ -22,7 +22,7 @@ Initialize the TaskPlanningToolkit.**Parameters:**-- **timeout** (Optional[float]): The timeout for the toolkit. (default: :obj: `None`)+- **timeout** (Optional[float]): The timeout for the toolkit. (default: :obj:`None`)<a id="camel.toolkits.task_planning_toolkit.TaskPlanningToolkit.decompose_task"></a>@@ -45,7 +45,7 @@ used when the original task is complex and needs to be decomposed.- **original_task_content** (str): The content of the task to be decomposed.- **sub_task_contents** (List[str]): A list of strings, where each string is the content for a new sub-task.-- **original_task_id** (Optional[str]): The id of the task to be decomposed. If not provided, a new id will be generated. (default: :obj: `None`)+- **original_task_id** (Optional[str]): The id of the task to be decomposed. If not provided, a new id will be generated. (default: :obj:`None`)**Returns:**@@ -73,7 +73,7 @@ the task.- **original_task_content** (str): The content of the task to be decomposed.- **sub_task_contents** (List[str]): A list of strings, where each string is the content for a new sub-task.-- **original_task_id** (Optional[str]): The id of the task to be decomposed. (default: :obj: `None`)+- **original_task_id** (Optional[str]): The id of the task to be decomposed. (default: :obj:`None`)**Returns:**diff --git a/docs/mintlify/reference/camel.toolkits.thinking_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.thinking_toolkit.mdxindex c20a2facb..43a4743b5 100644--- a/docs/mintlify/reference/camel.toolkits.thinking_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.thinking_toolkit.mdx@@ -22,7 +22,7 @@ Initialize the ThinkingToolkit.**Parameters:**-- **timeout** (Optional[float]): The timeout for the toolkit. (default: :obj: `None`)+- **timeout** (Optional[float]): The timeout for the toolkit. (default: :obj:`None`)<a id="camel.toolkits.thinking_toolkit.ThinkingToolkit.plan"></a>