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-botf68f807fcc01
diff --git a/docs/reference/camel.toolkits.hybrid_browser_toolkit.actions.md b/docs/reference/camel.toolkits.hybrid_browser_toolkit.actions.md
index 0eff9c269..340b6a188 100644
--- a/docs/reference/camel.toolkits.hybrid_browser_toolkit.actions.md
+++ b/docs/reference/camel.toolkits.hybrid_browser_toolkit.actions.md
@@ -15,7 +15,14 @@ Executes high-level actions (click, type …) on a Playwright Page.
### __init__
```python
-def __init__(self, page: 'Page', session: Optional[Any] = None):
+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.actions.ActionExecutor.should_update_snapshot"></a>
diff --git a/docs/reference/camel.toolkits.hybrid_browser_toolkit.config_loader.md b/docs/reference/camel.toolkits.hybrid_browser_toolkit.config_loader.md
new file mode 100644
index 000000000..3644914d9
--- /dev/null
+++ b/docs/reference/camel.toolkits.hybrid_browser_toolkit.config_loader.md
@@ -0,0 +1,476 @@
+<a id="camel.toolkits.hybrid_browser_toolkit.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.config_loader.ConfigLoader"></a>
+
+## ConfigLoader
+
+```python
+class ConfigLoader:
+```
+
+Legacy wrapper for BrowserConfig - maintained for backward
+compatibility.
+
+<a id="camel.toolkits.hybrid_browser_toolkit.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.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.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.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.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.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.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.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.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.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.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.config_loader.get_browser_config"></a>
+
+## get_browser_config
+
+```python
+def get_browser_config():
+```
+
+Get BrowserConfig class.
+
+<a id="camel.toolkits.hybrid_browser_toolkit.config_loader.get_stealth_config"></a>
+
+## get_stealth_config
+
+```python
+def get_stealth_config():
+```
+
+Get StealthConfig class.
+
+<a id="camel.toolkits.hybrid_browser_toolkit.config_loader.get_timeout_config"></a>
+
+## get_timeout_config
+
+```python
+def get_timeout_config():
+```
+
+Get timeout configuration.
+
+<a id="camel.toolkits.hybrid_browser_toolkit.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.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.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.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.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.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.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.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/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.md b/docs/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.md
index 4271d0cf5..b14f2d2a0 100644
--- a/docs/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.md
+++ b/docs/reference/camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit.md
@@ -38,6 +38,43 @@ Initialize the HybridBrowserToolkit.
- **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.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.__del__"></a>