🐫 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 [skip ci]
camel-docs-bota6968dd80432
diff --git a/docs/mintlify/reference/camel.societies.workforce.workforce.mdx b/docs/mintlify/reference/camel.societies.workforce.workforce.mdxindex 8541b2ec1..3a7e3efe2 100644--- a/docs/mintlify/reference/camel.societies.workforce.workforce.mdx+++ b/docs/mintlify/reference/camel.societies.workforce.workforce.mdx@@ -64,6 +64,7 @@ capabilities- **task_agent** (Optional[ChatAgent], optional): A custom task planning agent instance for task decomposition and composition. If provided, the workforce will create a new agent using this agent's model configuration but with the required system message and tools (TaskPlanningToolkit). If None, a default agent will be created using DEFAULT model settings. (default: :obj:`None`)- **new_worker_agent** (Optional[ChatAgent], optional): A template agent for workers created dynamically at runtime when existing workers cannot handle failed tasks. If None, workers will be created with default settings including SearchToolkit, CodeExecutionToolkit, and ThinkingToolkit. (default: :obj:`None`)- **graceful_shutdown_timeout** (float, optional): The timeout in seconds for graceful shutdown when a task fails 3 times. During this period, the workforce remains active for debugging. Set to 0 for immediate shutdown. (default: :obj:`15.0`)+- **task_timeout_seconds** (Optional[float], optional): The timeout in seconds for waiting for tasks to be returned by workers. If None, uses the global TASK_TIMEOUT_SECONDS value (600.0 seconds). Increase this value for tasks that require more processing time. (default: :obj:`None`)- **share_memory** (bool, optional): Whether to enable shared memory across SingleAgentWorker instances in the workforce. When enabled, all SingleAgentWorker instances, coordinator agent, and task planning agent will share their complete conversation history and function-calling trajectory, providing better context for task handoffs and continuity. Note: Currently only supports SingleAgentWorker instances; RolePlayingWorker and nested Workforce instances do not participate in memory sharing. (default: :obj:`False`)- **use_structured_output_handler** (bool, optional): Whether to use the structured output handler instead of native structured output. When enabled, the workforce will use prompts with structured output instructions and regex extraction to parse responses. This ensures compatibility with agents that don't reliably support native structured output. When disabled, the workforce uses the native response_format parameter. (default: :obj:`True`)@@ -90,7 +91,8 @@ def __init__(new_worker_agent: Optional[ChatAgent] = None,graceful_shutdown_timeout: float = 15.0,share_memory: bool = False,- use_structured_output_handler: bool = True+ use_structured_output_handler: bool = True,+ task_timeout_seconds: Optional[float] = None):```diff --git a/docs/mintlify/reference/camel.toolkits.search_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.search_toolkit.mdxindex 74601b1fb..81f929a1b 100644--- a/docs/mintlify/reference/camel.toolkits.search_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.search_toolkit.mdx@@ -21,18 +21,15 @@ search engines like Google, DuckDuckGo, Wikipedia and Wolfram Alpha, Brave.def __init__(self,timeout: Optional[float] = None,- number_of_result_pages: int = 10,exclude_domains: Optional[List[str]] = None):```-Initializes the RedditToolkit with the specified number of retries-and delay.+Initializes the SearchToolkit.**Parameters:**- **timeout** (float): Timeout for API requests in seconds. (default: :obj:`None`)-- **number_of_result_pages** (int): The number of result pages to retrieve. (default: :obj:`10`)- **exclude_domains** (Optional[List[str]]): List of domains to exclude from search results. Currently only supported by the `search_google` function. (default: :obj:`None`)<a id="camel.toolkits.search_toolkit.SearchToolkit.search_wiki"></a>@@ -91,7 +88,12 @@ returns an error message.### search_duckduckgo```python-def search_duckduckgo(self, query: str, source: str = 'text'):+def search_duckduckgo(+ self,+ query: str,+ source: str = 'text',+ number_of_result_pages: int = 10+):```Use DuckDuckGo search engine to search information for@@ -105,6 +107,7 @@ dictionaries, each representing a search result.- **query** (str): The query to be searched.- **source** (str): The type of information to query (e.g., "text", "images", "videos"). Defaults to "text".+- **number_of_result_pages** (int): The number of result pages to retrieve. Adjust this based on your task - use fewer results for focused searches and more for comprehensive searches. (default: :obj:`10`)**Returns:**@@ -131,7 +134,8 @@ def search_brave(goggles_id: Optional[str] = None,units: Optional[str] = None,extra_snippets: Optional[bool] = None,- summary: Optional[bool] = None+ summary: Optional[bool] = None,+ number_of_result_pages: int = 10):```@@ -158,6 +162,7 @@ for more details.- **units** (Optional[str]): The measurement units. If not provided, units are derived from search country. Possible values are: - 'metric': The standardized measurement system - 'imperial': The British Imperial system of units.- **extra_snippets** (Optional[bool]): A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts. Only available under Free AI, Base AI, Pro AI, Base Data, Pro Data and Custom plans.- **summary** (Optional[bool]): This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.+- **number_of_result_pages** (int): The number of result pages to retrieve. Adjust this based on your task - use fewer results for focused searches and more for comprehensive searches. (default: :obj:`10`)**Returns:**@@ -168,7 +173,13 @@ for more details.### search_google```python-def search_google(self, query: str, search_type: str = 'web'):+def search_google(+ self,+ query: str,+ search_type: str = 'web',+ number_of_result_pages: int = 10,+ start_page: int = 1+):```Use Google search engine to search information for the given query.@@ -177,6 +188,8 @@ Use Google search engine to search information for the given query.- **query** (str): The query to be searched.- **search_type** (str): The type of search to perform. Either "web" for web pages or "image" for image search. (default: "web")+- **number_of_result_pages** (int): The number of result pages to retrieve. Adjust this based on your task - use fewer results for focused searches and more for comprehensive searches. (default: :obj:`10`)+- **start_page** (int): The result page to start from. Use this for pagination - e.g., start_page=1 for results 1-10, start_page=11 for results 11-20, etc. This allows agents to check initial results and continue searching if needed. (default: :obj:`1`)**Returns:**@@ -228,14 +241,20 @@ Example image result:### tavily_search```python-def tavily_search(self, query: str, **kwargs):+def tavily_search(+ self,+ query: str,+ number_of_result_pages: int = 10,+ **kwargs+):```Use Tavily Search API to search information for the given query.**Parameters:**-- **query** (str): The query to be searched. **kwargs: Additional optional parameters supported by Tavily's API: - search_depth (str): "basic" or "advanced" search depth. - topic (str): The search category, e.g., "general" or "news." - days (int): Time frame in days for news-related searches. - max_results (int): Max number of results to return (overrides `num_results`). See https://docs.tavily.com/docs/python-sdk/tavily-search/ api-reference for details.+- **query** (str): The query to be searched.+- **number_of_result_pages** (int): The number of result pages to retrieve. Adjust this based on your task - use fewer results for focused searches and more for comprehensive searches. (default: :obj:`10`) **kwargs: Additional optional parameters supported by Tavily's API: - search_depth (str): "basic" or "advanced" search depth. - topic (str): The search category, e.g., "general" or "news." - days (int): Time frame in days for news-related searches. - max_results (int): Max number of results to return (overrides `num_results`). See https://docs.tavily.com/docs/python-sdk/tavily-search/ api-reference for details.**Returns:**@@ -262,7 +281,8 @@ def search_bocha(query: str,freshness: str = 'noLimit',summary: bool = False,- page: int = 1+ page: int = 1,+ number_of_result_pages: int = 10):```@@ -274,6 +294,7 @@ Query the Bocha AI search API and return search results.- **freshness** (str): Time frame filter for search results. Default is "noLimit". Options include: - 'noLimit': no limit (default). - 'oneDay': past day. - 'oneWeek': past week. - 'oneMonth': past month. - 'oneYear': past year.- **summary** (bool): Whether to include text summaries in results. Default is False.- **page** (int): Page number of results. Default is 1.+- **number_of_result_pages** (int): The number of result pages to retrieve. Adjust this based on your task - use fewer results for focused searches and more for comprehensive searches. (default: :obj:`10`)**Returns:**@@ -286,7 +307,7 @@ follows the Bocha AI search API response format.### search_baidu```python-def search_baidu(self, query: str):+def search_baidu(self, query: str, number_of_result_pages: int = 10):```Search Baidu using web scraping to retrieve relevant search@@ -296,6 +317,7 @@ results including titles, descriptions, and URLs.**Parameters:**- **query** (str): Search query string to submit to Baidu.+- **number_of_result_pages** (int): The number of result pages to retrieve. Adjust this based on your task - use fewer results for focused searches and more for comprehensive searches. (default: :obj:`10`)**Returns:**@@ -307,7 +329,7 @@ message.### search_bing```python-def search_bing(self, query: str):+def search_bing(self, query: str, number_of_result_pages: int = 10):```Use Bing search engine to search information for the given query.@@ -321,6 +343,7 @@ Chinese search results are desired.**Parameters:**- **query** (str): The search query string to submit to Bing. Works best with Chinese queries or when Chinese results are preferred.+- **number_of_result_pages** (int): The number of result pages to retrieve. Adjust this based on your task - use fewer results for focused searches and more for comprehensive searches. (default: :obj:`10`)**Returns:**@@ -345,7 +368,8 @@ def search_exa(include_text: Optional[List[str]] = None,exclude_text: Optional[List[str]] = None,use_autoprompt: bool = True,- text: bool = False+ text: bool = False,+ number_of_result_pages: int = 10):```@@ -361,6 +385,7 @@ content extraction.- **exclude_text** (Optional[List[str]]): Strings that must not be present in webpage text. Limited to 1 string of up to 5 words. (default: :obj:`None`)- **use_autoprompt** (bool): Whether to use Exa's autoprompt feature to enhance the query. (default: :obj:`True`)- **text** (bool): Whether to include webpage contents in results. (default: :obj:`False`)+- **number_of_result_pages** (int): The number of result pages to retrieve. Must be between 1 and 100. Adjust this based on your task - use fewer results for focused searches and more for comprehensive searches. (default: :obj:`10`)**Returns:**@@ -385,7 +410,8 @@ def search_alibaba_tongxiao(industry: Optional[Literal['finance', 'law', 'medical', 'internet', 'tax', 'news_province', 'news_center']] = None,return_main_text: bool = False,return_markdown_text: bool = True,- enable_rerank: bool = True+ enable_rerank: bool = True,+ number_of_result_pages: int = 10):```@@ -407,6 +433,7 @@ features:- **return_main_text** (bool): Whether to include the main text of the webpage in results. (default: :obj:`True`)- **return_markdown_text** (bool): Whether to include markdown formatted content in results. (default: :obj:`True`)- **enable_rerank** (bool): Whether to enable result reranking. If response time is critical, setting this to False can reduce response time by approximately 140ms. (default: :obj:`True`)+- **number_of_result_pages** (int): The number of result pages to retrieve. Adjust this based on your task - use fewer results for focused searches and more for comprehensive searches. (default: :obj:`10`)**Returns:**