🐫 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-bote4864d58994d
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.jsonindex 32d0eed5b..bc99ca9cf 100644--- a/docs/mintlify/docs.json+++ b/docs/mintlify/docs.json@@ -540,9 +540,16 @@"reference/camel.toolkits.hybrid_browser_toolkit.browser_session","reference/camel.toolkits.hybrid_browser_toolkit.config_loader","reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit",+ "reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts","reference/camel.toolkits.hybrid_browser_toolkit.snapshot","reference/camel.toolkits.hybrid_browser_toolkit.stealth_config","reference/camel.toolkits.hybrid_browser_toolkit.ws_wrapper",+ "reference/camel.toolkits.hybrid_browser_toolkit_py.actions",+ "reference/camel.toolkits.hybrid_browser_toolkit_py.agent",+ "reference/camel.toolkits.hybrid_browser_toolkit_py.browser_session",+ "reference/camel.toolkits.hybrid_browser_toolkit_py.config_loader",+ "reference/camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit",+ "reference/camel.toolkits.hybrid_browser_toolkit_py.snapshot","reference/camel.toolkits.non_visual_browser_toolkit.actions","reference/camel.toolkits.non_visual_browser_toolkit.agent","reference/camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit",diff --git a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.mdxindex e0b21b7a3..d57933074 100644--- a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.mdx+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.mdx@@ -5,27 +5,29 @@## HybridBrowserToolkit```python-class HybridBrowserToolkit(BaseToolkit, RegisteredAgentToolkit):+class HybridBrowserToolkit(BaseToolkit):```-A hybrid browser toolkit that combines non-visual, DOM-based browser-automation with visual, screenshot-based capabilities.+A hybrid browser toolkit that can switch between TypeScript and Python+implementations.-This toolkit now uses TypeScript implementation with Playwright's-_snapshotForAI functionality for enhanced AI integration.+This wrapper allows users to choose between:+- 'typescript': WebSocket-based implementation using TypeScript/Node.js+- 'python': Pure Python implementation using Playwright directly-<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.HybridBrowserToolkit.__init__"></a>+<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.HybridBrowserToolkit.__new__"></a>-### __init__+### __new__```python-def __init__(self):+def __new__(cls, **kwargs: Any):```-Initialize the HybridBrowserToolkit.+Create a HybridBrowserToolkit instance with the specified mode.**Parameters:**+- **mode** (`Literal["typescript", "python"]`): Implementation mode. - 'typescript': Uses WebSocket-based TypeScript implementation - 'python': Uses pure Python Playwright implementation Defaults to "typescript".- **headless** (bool): Whether to run browser in headless mode. Defaults to True.- **user_data_dir** (Optional[str]): Directory for user data persistence. Defaults to None.- **stealth** (bool): Whether to enable stealth mode. Defaults to False.@@ -42,77 +44,10 @@ Initialize the HybridBrowserToolkit.- **screenshot_timeout** (Optional[int]): Screenshot timeout in milliseconds. Defaults to None.- **page_stability_timeout** (Optional[int]): Page stability timeout in milliseconds. Defaults to None.- **dom_content_loaded_timeout** (Optional[int]): DOM content loaded timeout in milliseconds. Defaults to None.-- **viewport_limit** (bool): Whether to filter page snapshot elements to only those visible in the current viewport. When True, only elements within the current viewport bounds will be included in snapshots. When False (default), all elements on the page are included. Defaults to False.-- **connect_over_cdp** (bool): Whether to connect to an existing browser via Chrome DevTools Protocol. Defaults to False.-- **cdp_url** (Optional[str]): WebSocket endpoint URL for CDP connection (e.g., 'ws://localhost:9222/devtools/browser/...'). Required when connect_over_cdp is True. Defaults to None.--<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.HybridBrowserToolkit.__del__"></a>--### __del__--```python-def __del__(self):-```--Cleanup browser resources on garbage collection.--<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.HybridBrowserToolkit.web_agent_model"></a>--### web_agent_model--```python-def web_agent_model(self):-```--Get the web agent model.--<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.HybridBrowserToolkit.web_agent_model"></a>--### web_agent_model--```python-def web_agent_model(self, value: Optional[BaseModelBackend]):-```--Set the web agent model.--<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.HybridBrowserToolkit.cache_dir"></a>--### cache_dir--```python-def cache_dir(self):-```--Get the cache directory.--<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.HybridBrowserToolkit.clone_for_new_session"></a>--### clone_for_new_session--```python-def clone_for_new_session(self, new_session_id: Optional[str] = None):-```--Create a new instance of HybridBrowserToolkit with a unique-session.--**Parameters:**--- **new_session_id**: Optional new session ID. If None, a UUID will be generated.+- **viewport_limit** (bool): Whether to filter page snapshot elements to only those visible in the current viewport. Defaults to False.+- **connect_over_cdp** (bool): Whether to connect to an existing browser via Chrome DevTools Protocol. Defaults to False. (Only supported in TypeScript mode)+- **cdp_url** (Optional[str]): WebSocket endpoint URL for CDP connection. Required when connect_over_cdp is True. Defaults to None. (Only supported in TypeScript mode) **kwargs: Additional keyword arguments passed to the implementation.**Returns:**- A new HybridBrowserToolkit instance with the same configuration-but a different session.--<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.HybridBrowserToolkit.get_tools"></a>--### get_tools--```python-def get_tools(self):-```--Get available function tools based-on enabled_tools configuration.+ HybridBrowserToolkit instance of the specified implementation.diff --git a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.mdx b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.mdxnew file mode 100644index 000000000..7a7d99b81--- /dev/null+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.mdx@@ -0,0 +1,118 @@+<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts"></a>++<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.HybridBrowserToolkit"></a>++## HybridBrowserToolkit++```python+class HybridBrowserToolkit(BaseToolkit, RegisteredAgentToolkit):+```++A hybrid browser toolkit that combines non-visual, DOM-based browser+automation with visual, screenshot-based capabilities.++This toolkit now uses TypeScript implementation with Playwright's+_snapshotForAI functionality for enhanced AI integration.++<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.HybridBrowserToolkit.__init__"></a>++### __init__++```python+def __init__(self):+```++Initialize the HybridBrowserToolkit.++**Parameters:**++- **headless** (bool): Whether to run browser in headless mode. Defaults to True.+- **user_data_dir** (Optional[str]): Directory for user data persistence. Defaults to None.+- **stealth** (bool): Whether to enable stealth mode. Defaults to False.+- **web_agent_model** (Optional[BaseModelBackend]): Model for web agent operations. Defaults to None.+- **cache_dir** (str): Directory for caching. Defaults to "tmp/". (default: `"tmp/"`)+- **enabled_tools** (Optional[List[str]]): List of enabled tools. Defaults to None.+- **browser_log_to_file** (bool): Whether to log browser actions to file. Defaults to False.+- **session_id** (Optional[str]): Session identifier. Defaults to None.+- **default_start_url** (str): Default URL to start with. Defaults to "https://google.com/".+- **default_timeout** (Optional[int]): Default timeout in milliseconds. Defaults to None.+- **short_timeout** (Optional[int]): Short timeout in milliseconds. Defaults to None.+- **navigation_timeout** (Optional[int]): Navigation timeout in milliseconds. Defaults to None.+- **network_idle_timeout** (Optional[int]): Network idle timeout in milliseconds. Defaults to None.+- **screenshot_timeout** (Optional[int]): Screenshot timeout in milliseconds. Defaults to None.+- **page_stability_timeout** (Optional[int]): Page stability timeout in milliseconds. Defaults to None.+- **dom_content_loaded_timeout** (Optional[int]): DOM content loaded timeout in milliseconds. Defaults to None.+- **viewport_limit** (bool): Whether to filter page snapshot elements to only those visible in the current viewport. When True, only elements within the current viewport bounds will be included in snapshots. When False (default), all elements on the page are included. Defaults to False.+- **connect_over_cdp** (bool): Whether to connect to an existing browser via Chrome DevTools Protocol. Defaults to False.+- **cdp_url** (Optional[str]): WebSocket endpoint URL for CDP connection (e.g., 'ws://localhost:9222/devtools/browser/...'). Required when connect_over_cdp is True. Defaults to None.++<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.HybridBrowserToolkit.__del__"></a>++### __del__++```python+def __del__(self):+```++Cleanup browser resources on garbage collection.++<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.HybridBrowserToolkit.web_agent_model"></a>++### web_agent_model++```python+def web_agent_model(self):+```++Get the web agent model.++<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.HybridBrowserToolkit.web_agent_model"></a>++### web_agent_model++```python+def web_agent_model(self, value: Optional[BaseModelBackend]):+```++Set the web agent model.++<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.HybridBrowserToolkit.cache_dir"></a>++### cache_dir++```python+def cache_dir(self):+```++Get the cache directory.++<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.HybridBrowserToolkit.clone_for_new_session"></a>++### clone_for_new_session++```python+def clone_for_new_session(self, new_session_id: Optional[str] = None):+```++Create a new instance of HybridBrowserToolkit with a unique+session.++**Parameters:**++- **new_session_id**: Optional new session ID. If None, a UUID will be generated.++**Returns:**++ A new HybridBrowserToolkit instance with the same configuration+but a different session.++<a id="camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts.HybridBrowserToolkit.get_tools"></a>++### get_tools++```python+def get_tools(self):+```++Get available function tools based+on enabled_tools configuration.diff --git a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.actions.mdx b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.actions.mdxnew file mode 100644index 000000000..9537ef9a7--- /dev/null+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.actions.mdx@@ -0,0 +1,36 @@+<a id="camel.toolkits.hybrid_browser_toolkit_py.actions"></a>++<a id="camel.toolkits.hybrid_browser_toolkit_py.actions.ActionExecutor"></a>++## ActionExecutor++```python+class ActionExecutor:+```++Executes high-level actions (click, type …) on a Playwright Page.++<a id="camel.toolkits.hybrid_browser_toolkit_py.actions.ActionExecutor.__init__"></a>++### __init__++```python+def __init__(+ self,+ page: 'Page',+ session: Optional[Any] = None,+ default_timeout: Optional[int] = None,+ short_timeout: Optional[int] = None,+ max_scroll_amount: Optional[int] = None+):+```++<a id="camel.toolkits.hybrid_browser_toolkit_py.actions.ActionExecutor.should_update_snapshot"></a>++### should_update_snapshot++```python+def should_update_snapshot(action: Dict[str, Any]):+```++Determine if an action requires a snapshot update.diff --git a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.agent.mdx b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.agent.mdxnew file mode 100644index 000000000..152c9c50f--- /dev/null+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.agent.mdx@@ -0,0 +1,66 @@+<a id="camel.toolkits.hybrid_browser_toolkit_py.agent"></a>++<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent"></a>++## PlaywrightLLMAgent++```python+class PlaywrightLLMAgent:+```++High-level orchestration: snapshot ↔ LLM ↔ action executor.++<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent.__init__"></a>++### __init__++```python+def __init__(self):+```++<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent._get_chat_agent"></a>++### _get_chat_agent++```python+def _get_chat_agent(self):+```++Get or create the ChatAgent instance.++<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent._safe_parse_json"></a>++### _safe_parse_json++```python+def _safe_parse_json(self, content: str):+```++Safely parse JSON from LLM response with multiple fallback+strategies.++<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent._get_fallback_response"></a>++### _get_fallback_response++```python+def _get_fallback_response(self, error_msg: str):+```++Generate a fallback response structure.++<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent._llm_call"></a>++### _llm_call++```python+def _llm_call(+ self,+ prompt: str,+ snapshot: str,+ is_initial: bool,+ history: Optional[List[Dict[str, Any]]] = None+):+```++Call the LLM (via CAMEL ChatAgent) to get plan & next action.diff --git a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.browser_session.mdx b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.browser_session.mdxnew file mode 100644index 000000000..fb83d03a5--- /dev/null+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.browser_session.mdx@@ -0,0 +1,54 @@+<a id="camel.toolkits.hybrid_browser_toolkit_py.browser_session"></a>++<a id="camel.toolkits.hybrid_browser_toolkit_py.browser_session.TabIdGenerator"></a>++## TabIdGenerator++```python+class TabIdGenerator:+```++Monotonically increasing tab ID generator.++<a id="camel.toolkits.hybrid_browser_toolkit_py.browser_session.HybridBrowserSession"></a>++## HybridBrowserSession++```python+class HybridBrowserSession:+```++Lightweight wrapper around Playwright for+browsing with multi-tab support.++It provides multiple *Page* instances plus helper utilities (snapshot &+executor). Multiple toolkits or agents can reuse this class without+duplicating Playwright setup code.++This class is a singleton per event-loop and session-id combination.++<a id="camel.toolkits.hybrid_browser_toolkit_py.browser_session.HybridBrowserSession.__new__"></a>++### __new__++```python+def __new__(cls):+```++<a id="camel.toolkits.hybrid_browser_toolkit_py.browser_session.HybridBrowserSession.__init__"></a>++### __init__++```python+def __init__(self):+```++<a id="camel.toolkits.hybrid_browser_toolkit_py.browser_session.HybridBrowserSession._load_stealth_script"></a>++### _load_stealth_script++```python+def _load_stealth_script(self):+```++Load the stealth JavaScript script from file.diff --git a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.config_loader.mdx b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.config_loader.mdxnew file mode 100644index 000000000..91b323a50--- /dev/null+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.config_loader.mdx@@ -0,0 +1,476 @@+<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader"></a>++Configuration for browser automation including stealth mode and timeouts.++This module contains all the configuration needed to make the browser+appear as a regular user browser and configure action timeouts.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig"></a>++## BrowserConfig++```python+class BrowserConfig:+```++Configuration class for browser settings including stealth mode and+timeouts.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_timeout_config"></a>++### get_timeout_config++```python+def get_timeout_config():+```++**Returns:**++ Dict[str, int]: Timeout configuration in milliseconds.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_action_limits"></a>++### get_action_limits++```python+def get_action_limits():+```++**Returns:**++ Dict[str, int]: Action limits configuration.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_action_timeout"></a>++### get_action_timeout++```python+def get_action_timeout(override: Optional[int] = None):+```++Get action timeout with optional override.++**Parameters:**++- **override**: Optional timeout override value in milliseconds.++**Returns:**++ int: Timeout value in milliseconds.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_short_timeout"></a>++### get_short_timeout++```python+def get_short_timeout(override: Optional[int] = None):+```++Get short timeout with optional override.++**Parameters:**++- **override**: Optional timeout override value in milliseconds.++**Returns:**++ int: Timeout value in milliseconds.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_navigation_timeout"></a>++### get_navigation_timeout++```python+def get_navigation_timeout(override: Optional[int] = None):+```++Get navigation timeout with optional override.++**Parameters:**++- **override**: Optional timeout override value in milliseconds.++**Returns:**++ int: Timeout value in milliseconds.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_network_idle_timeout"></a>++### get_network_idle_timeout++```python+def get_network_idle_timeout(override: Optional[int] = None):+```++Get network idle timeout with optional override.++**Parameters:**++- **override**: Optional timeout override value in milliseconds.++**Returns:**++ int: Timeout value in milliseconds.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_max_scroll_amount"></a>++### get_max_scroll_amount++```python+def get_max_scroll_amount(override: Optional[int] = None):+```++Get maximum scroll amount with optional override.++**Parameters:**++- **override**: Optional scroll amount override value in pixels.++**Returns:**++ int: Maximum scroll amount in pixels.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_screenshot_timeout"></a>++### get_screenshot_timeout++```python+def get_screenshot_timeout(override: Optional[int] = None):+```++Get screenshot timeout with optional override.++**Parameters:**++- **override**: Optional timeout override value in milliseconds.++**Returns:**++ int: Timeout value in milliseconds.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_page_stability_timeout"></a>++### get_page_stability_timeout++```python+def get_page_stability_timeout(override: Optional[int] = None):+```++Get page stability timeout with optional override.++**Parameters:**++- **override**: Optional timeout override value in milliseconds.++**Returns:**++ int: Timeout value in milliseconds.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_dom_content_loaded_timeout"></a>++### get_dom_content_loaded_timeout++```python+def get_dom_content_loaded_timeout(override: Optional[int] = None):+```++Get DOM content loaded timeout with optional override.++**Parameters:**++- **override**: Optional timeout override value in milliseconds.++**Returns:**++ int: Timeout value in milliseconds.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_launch_args"></a>++### get_launch_args++```python+def get_launch_args():+```++**Returns:**++ List[str]: Chrome command line arguments to avoid detection.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_context_options"></a>++### get_context_options++```python+def get_context_options():+```++**Returns:**++ Dict[str, Any]: Browser context configuration options.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_http_headers"></a>++### get_http_headers++```python+def get_http_headers():+```++**Returns:**++ Dict[str, str]: HTTP headers to appear more like a real browser.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_stealth_config"></a>++### get_stealth_config++```python+def get_stealth_config():+```++**Returns:**++ Dict[str, Any]: Complete stealth configuration.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_all_config"></a>++### get_all_config++```python+def get_all_config():+```++**Returns:**++ Dict[str, Any]: Complete browser configuration.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader"></a>++## ConfigLoader++```python+class ConfigLoader:+```++Legacy wrapper for BrowserConfig - maintained for backward+compatibility.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_browser_config"></a>++### get_browser_config++```python+def get_browser_config(cls):+```++Get the BrowserConfig class.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_stealth_config"></a>++### get_stealth_config++```python+def get_stealth_config(cls):+```++Get the StealthConfig class (alias).++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_timeout_config"></a>++### get_timeout_config++```python+def get_timeout_config(cls):+```++Get timeout configuration.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_action_timeout"></a>++### get_action_timeout++```python+def get_action_timeout(cls, override: Optional[int] = None):+```++Get action timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_short_timeout"></a>++### get_short_timeout++```python+def get_short_timeout(cls, override: Optional[int] = None):+```++Get short timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_navigation_timeout"></a>++### get_navigation_timeout++```python+def get_navigation_timeout(cls, override: Optional[int] = None):+```++Get navigation timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_network_idle_timeout"></a>++### get_network_idle_timeout++```python+def get_network_idle_timeout(cls, override: Optional[int] = None):+```++Get network idle timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_max_scroll_amount"></a>++### get_max_scroll_amount++```python+def get_max_scroll_amount(cls, override: Optional[int] = None):+```++Get maximum scroll amount with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_screenshot_timeout"></a>++### get_screenshot_timeout++```python+def get_screenshot_timeout(cls, override: Optional[int] = None):+```++Get screenshot timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_page_stability_timeout"></a>++### get_page_stability_timeout++```python+def get_page_stability_timeout(cls, override: Optional[int] = None):+```++Get page stability timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_dom_content_loaded_timeout"></a>++### get_dom_content_loaded_timeout++```python+def get_dom_content_loaded_timeout(cls, override: Optional[int] = None):+```++Get DOM content loaded timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_browser_config"></a>++## get_browser_config++```python+def get_browser_config():+```++Get BrowserConfig class.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_stealth_config"></a>++## get_stealth_config++```python+def get_stealth_config():+```++Get StealthConfig class.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_timeout_config"></a>++## get_timeout_config++```python+def get_timeout_config():+```++Get timeout configuration.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_action_timeout"></a>++## get_action_timeout++```python+def get_action_timeout(override: Optional[int] = None):+```++Get action timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_short_timeout"></a>++## get_short_timeout++```python+def get_short_timeout(override: Optional[int] = None):+```++Get short timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_navigation_timeout"></a>++## get_navigation_timeout++```python+def get_navigation_timeout(override: Optional[int] = None):+```++Get navigation timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_network_idle_timeout"></a>++## get_network_idle_timeout++```python+def get_network_idle_timeout(override: Optional[int] = None):+```++Get network idle timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_max_scroll_amount"></a>++## get_max_scroll_amount++```python+def get_max_scroll_amount(override: Optional[int] = None):+```++Get maximum scroll amount with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_screenshot_timeout"></a>++## get_screenshot_timeout++```python+def get_screenshot_timeout(override: Optional[int] = None):+```++Get screenshot timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_page_stability_timeout"></a>++## get_page_stability_timeout++```python+def get_page_stability_timeout(override: Optional[int] = None):+```++Get page stability timeout with optional override.++<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_dom_content_loaded_timeout"></a>++## get_dom_content_loaded_timeout++```python+def get_dom_content_loaded_timeout(override: Optional[int] = None):+```++Get DOM content loaded timeout with optional override.diff --git a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.mdxnew file mode 100644index 000000000..c9331c62e--- /dev/null+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.mdx@@ -0,0 +1,218 @@+<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit"></a>++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit"></a>++## HybridBrowserToolkit++```python+class HybridBrowserToolkit(BaseToolkit):+```++A hybrid browser toolkit that combines non-visual, DOM-based browser+automation with visual, screenshot-based capabilities.++This toolkit exposes a set of actions as CAMEL FunctionTools for agents+to interact with web pages. It can operate in headless mode and supports+both programmatic control of browser actions (like clicking and typing)+and visual analysis of the page layout through screenshots with marked+interactive elements.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.__init__"></a>++### __init__++```python+def __init__(self):+```++Initialize the HybridBrowserToolkit.++**Parameters:**++- **headless** (bool): Whether to run the browser in headless mode. Defaults to `True`.+- **user_data_dir** (Optional[str]): Path to a directory for storing browser data like cookies and local storage. Useful for maintaining sessions across runs. Defaults to `None` (a temporary directory is used).+- **stealth** (bool): Whether to run the browser in stealth mode to avoid bot detection. When enabled, hides WebDriver characteristics, spoofs navigator properties, and implements various anti-detection measures. Highly recommended for production use and when accessing sites with bot detection. Defaults to `False`.+- **web_agent_model** (Optional[BaseModelBackend]): The language model backend to use for the high-level `solve_task` agent. This is required only if you plan to use `solve_task`. Defaults to `None`.+- **cache_dir** (str): The directory to store cached files, such as screenshots. Defaults to `"tmp/"`.+- **enabled_tools** (Optional[List[str]]): List of tool names to enable. If None, uses DEFAULT_TOOLS. Available tools: open_browser, close_browser, visit_page, back, forward, get_page_snapshot, get_som_screenshot, get_page_links, click, type, select, scroll, enter, wait_user, solve_task. Defaults to `None`.+- **browser_log_to_file** (bool): Whether to save detailed browser action logs to file. When enabled, logs action inputs/outputs, execution times, and page loading times. Logs are saved to an auto-generated timestamped file. Defaults to `False`.+- **session_id** (Optional[str]): A unique identifier for this browser session. When multiple HybridBrowserToolkit instances are used concurrently, different session IDs prevent them from sharing the same browser session and causing conflicts. If None, a default session will be used. Defaults to `None`.+- **default_start_url** (str): The default URL to navigate to when open_browser() is called without a start_url parameter or with None. Defaults to `"https://google.com/"`.+- **default_timeout** (Optional[int]): Default timeout in milliseconds for browser actions. If None, uses environment variable HYBRID_BROWSER_DEFAULT_TIMEOUT or defaults to 3000ms. Defaults to `None`.+- **short_timeout** (Optional[int]): Short timeout in milliseconds for quick browser actions. If None, uses environment variable HYBRID_BROWSER_SHORT_TIMEOUT or defaults to 1000ms. Defaults to `None`.+- **navigation_timeout** (Optional[int]): Custom navigation timeout in milliseconds. If None, uses environment variable HYBRID_BROWSER_NAVIGATION_TIMEOUT or defaults to 10000ms. Defaults to `None`.+- **network_idle_timeout** (Optional[int]): Custom network idle timeout in milliseconds. If None, uses environment variable HYBRID_BROWSER_NETWORK_IDLE_TIMEOUT or defaults to 5000ms. Defaults to `None`.+- **screenshot_timeout** (Optional[int]): Custom screenshot timeout in milliseconds. If None, uses environment variable HYBRID_BROWSER_SCREENSHOT_TIMEOUT or defaults to 15000ms. Defaults to `None`.+- **page_stability_timeout** (Optional[int]): Custom page stability timeout in milliseconds. If None, uses environment variable HYBRID_BROWSER_PAGE_STABILITY_TIMEOUT or defaults to 1500ms. Defaults to `None`.+- **dom_content_loaded_timeout** (Optional[int]): Custom DOM content loaded timeout in milliseconds. If None, uses environment variable HYBRID_BROWSER_DOM_CONTENT_LOADED_TIMEOUT or defaults to 5000ms. Defaults to `None`.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.web_agent_model"></a>++### web_agent_model++```python+def web_agent_model(self):+```++Get the web agent model.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.web_agent_model"></a>++### web_agent_model++```python+def web_agent_model(self, value: Optional[BaseModelBackend]):+```++Set the web agent model.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.cache_dir"></a>++### cache_dir++```python+def cache_dir(self):+```++Get the cache directory.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.__del__"></a>++### __del__++```python+def __del__(self):+```++Cleanup browser resources on garbage collection.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit._load_unified_analyzer"></a>++### _load_unified_analyzer++```python+def _load_unified_analyzer(self):+```++Load the unified analyzer JavaScript script.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit._validate_ref"></a>++### _validate_ref++```python+def _validate_ref(self, ref: str, method_name: str):+```++Validate ref parameter.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit._truncate_if_needed"></a>++### _truncate_if_needed++```python+def _truncate_if_needed(self, content: Any):+```++Truncate content if max_log_length is set.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.action_logger"></a>++### action_logger++```python+def action_logger(func: Callable[..., Any]):+```++Decorator to add logging to action methods.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit._convert_analysis_to_rects"></a>++### _convert_analysis_to_rects++```python+def _convert_analysis_to_rects(self, analysis_data: Dict[str, Any]):+```++Convert analysis data to rect format for visual marking.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit._add_set_of_mark"></a>++### _add_set_of_mark++```python+def _add_set_of_mark(self, image, rects):+```++Add visual marks to the image.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit._format_snapshot_from_analysis"></a>++### _format_snapshot_from_analysis++```python+def _format_snapshot_from_analysis(self, analysis_data: Dict[str, Any]):+```++Format analysis data into snapshot string.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit._ensure_agent"></a>++### _ensure_agent++```python+def _ensure_agent(self):+```++Create PlaywrightLLMAgent on first use.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.get_log_summary"></a>++### get_log_summary++```python+def get_log_summary(self):+```++Get a summary of logged actions.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.clear_logs"></a>++### clear_logs++```python+def clear_logs(self):+```++Clear the log buffer.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.get_tools"></a>++### get_tools++```python+def get_tools(self):+```++Get available function tools+based on enabled_tools configuration.++<a id="camel.toolkits.hybrid_browser_toolkit_py.hybrid_browser_toolkit.HybridBrowserToolkit.clone_for_new_session"></a>++### clone_for_new_session++```python+def clone_for_new_session(self, new_session_id: Optional[str] = None):+```++Create a new instance of HybridBrowserToolkit with a unique+session.++**Parameters:**++- **new_session_id**: Optional new session ID. If None, a UUID will be generated.++**Returns:**++ A new HybridBrowserToolkit instance with the same configuration+but a different session.diff --git a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.snapshot.mdx b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.snapshot.mdxnew file mode 100644index 000000000..1c9fda810--- /dev/null+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.snapshot.mdx@@ -0,0 +1,46 @@+<a id="camel.toolkits.hybrid_browser_toolkit_py.snapshot"></a>++<a id="camel.toolkits.hybrid_browser_toolkit_py.snapshot.PageSnapshot"></a>++## PageSnapshot++```python+class PageSnapshot:+```++Utility for capturing YAML-like page snapshots and diff-only+variants.++<a id="camel.toolkits.hybrid_browser_toolkit_py.snapshot.PageSnapshot.__init__"></a>++### __init__++```python+def __init__(self, page: 'Page'):+```++<a id="camel.toolkits.hybrid_browser_toolkit_py.snapshot.PageSnapshot._format_snapshot"></a>++### _format_snapshot++```python+def _format_snapshot(text: str):+```++<a id="camel.toolkits.hybrid_browser_toolkit_py.snapshot.PageSnapshot._compute_diff"></a>++### _compute_diff++```python+def _compute_diff(old: str, new: str):+```++<a id="camel.toolkits.hybrid_browser_toolkit_py.snapshot.PageSnapshot._detect_priorities"></a>++### _detect_priorities++```python+def _detect_priorities(self, snapshot_yaml: str):+```++Return sorted list of priorities present (1,2,3).