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 [skip ci]

camel-docs-bot6ddfe6aa64b7
diff --git a/docs/mintlify/reference/camel.toolkits.arxiv_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.arxiv_toolkit.mdx
index 0e46819e1..a96cf780f 100644
--- a/docs/mintlify/reference/camel.toolkits.arxiv_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.arxiv_toolkit.mdx
@@ -87,7 +87,8 @@ def download_papers(
query: str,
paper_ids: Optional[List[str]] = None,
max_results: Optional[int] = 5,
- output_dir: Optional[str] = './'
+ output_dir: Optional[str] = './',
+ filenames: Optional[List[str]] = None
):
```
@@ -100,6 +101,7 @@ query.
- **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.
+- **filenames** (List[str], optional): Exact filenames to use for the downloaded papers. This can only be used with `__INLINE_CODE_0____INLINE_CODE_1__None`)
**Returns:**
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.mdx
index 7a20940df..991c0e31e 100644
--- a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.actions.mdx
+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.actions.mdx
@@ -8,7 +8,15 @@
class ActionExecutor:
```
-Executes high-level actions (click, type …) on a Playwright Page.
+Executes high-level actions (click, type ...) on a Playwright Page.
+
+**Parameters:**
+
+- **page** (Page): The Playwright page instance to execute actions on.
+- **session** (Any, optional): The :obj:`HybridBrowserSession` instance for multi-tab support. (default: :obj:`None`)
+- **default_timeout** (int, optional): Default timeout in milliseconds for actions. If :obj:`None`, uses the configured default. (default: :obj:`None`)
+- **short_timeout** (int, optional): Short timeout in milliseconds for quick operations. If :obj:`None`, uses the configured default. (default: :obj:`None`)
+- **max_scroll_amount** (int, optional): Maximum scroll amount in pixels per scroll action. If :obj:`None`, uses the configured default. (default: :obj:`None`)
<a id="camel.toolkits.hybrid_browser_toolkit_py.actions.ActionExecutor.__init__"></a>
@@ -35,6 +43,16 @@ def _valid_coordinates(self, x_coord: float, y_coord: float):
Validate given coordinates against viewport bounds.
+**Parameters:**
+
+- **x_coord** (float): The x coordinate to validate.
+- **y_coord** (float): The y coordinate to validate.
+
+**Returns:**
+
+ bool: :obj:`True` if both coordinates are within the current
+viewport bounds, :obj:`False` otherwise.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.actions.ActionExecutor.should_update_snapshot"></a>
### should_update_snapshot
@@ -44,3 +62,12 @@ def should_update_snapshot(action: Dict[str, Any]):
```
Determine if an action requires a snapshot update.
+
+**Parameters:**
+
+- **action** (Dict[str, Any]): The action dictionary containing a `__INLINE_CODE_0__` key to check.
+
+**Returns:**
+
+ bool: :obj:`True` if the action type modifies the page and
+requires a snapshot update, :obj:`False` otherwise.
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.mdx
index 152c9c50f..0a8f9cc71 100644
--- a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.agent.mdx
+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.agent.mdx
@@ -8,7 +8,17 @@
class PlaywrightLLMAgent:
```
-High-level orchestration: snapshot ↔ LLM ↔ action executor.
+High-level orchestration layer connecting page snapshots, an LLM,
+and an action executor for browser automation.
+
+**Parameters:**
+
+- **user_data_dir** (str, optional): Path to the browser user data directory for persistent sessions. (default: :obj:`None`)
+- **headless** (bool, optional): Whether to run the browser in headless mode. (default: :obj:`False`)
+- **stealth** (bool, optional): Whether to enable stealth mode to avoid bot detection. (default: :obj:`False`)
+- **model_backend** (BaseModelBackend, optional): The model backend to use for LLM calls. If :obj:`None`, defaults to :obj:`ModelFactory` with :obj:`ModelPlatformType.DEFAULT` and :obj:`ModelType.DEFAULT`. (default: :obj:`None`)
+- **default_timeout** (int, optional): Default timeout in milliseconds for browser actions. If :obj:`None`, uses the configured default. (default: :obj:`None`)
+- **short_timeout** (int, optional): Short timeout in milliseconds for quick browser operations. If :obj:`None`, uses the configured default. (default: :obj:`None`)
<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent.__init__"></a>
@@ -26,7 +36,10 @@ def __init__(self):
def _get_chat_agent(self):
```
-Get or create the ChatAgent instance.
+**Returns:**
+
+ ChatAgent: The existing or newly created :obj:`ChatAgent`
+initialized with the system prompt and model backend.
<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent._safe_parse_json"></a>
@@ -36,9 +49,22 @@ Get or create the ChatAgent instance.
def _safe_parse_json(self, content: str):
```
-Safely parse JSON from LLM response with multiple fallback
+Safely parse JSON from an LLM response with multiple fallback
strategies.
+Attempts direct parsing first, then regex-based extraction, then
+line-by-line parsing. Falls back to a default structure if all
+strategies fail.
+
+**Parameters:**
+
+- **content** (str): The raw LLM response string to parse.
+
+**Returns:**
+
+ Dict[str, Any]: The parsed JSON as a dictionary, or a fallback
+response structure if parsing fails.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent._get_fallback_response"></a>
### _get_fallback_response
@@ -47,7 +73,16 @@ strategies.
def _get_fallback_response(self, error_msg: str):
```
-Generate a fallback response structure.
+Generate a fallback response structure for parsing failures.
+
+**Parameters:**
+
+- **error_msg** (str): A description of the error that caused the fallback.
+
+**Returns:**
+
+ Dict[str, Any]: A default response dictionary with a
+`__INLINE_CODE_0__` action and the error message as summary.
<a id="camel.toolkits.hybrid_browser_toolkit_py.agent.PlaywrightLLMAgent._llm_call"></a>
@@ -63,4 +98,17 @@ def _llm_call(
):
```
-Call the LLM (via CAMEL ChatAgent) to get plan & next action.
+Call the LLM via :obj:`ChatAgent` to get a plan and next action.
+
+**Parameters:**
+
+- **prompt** (str): The user task description.
+- **snapshot** (str): The current page snapshot text.
+- **is_initial** (bool): Whether this is the first LLM call for the task. If :obj:`True`, no action history is included.
+- **history** (List[Dict[str, Any]], optional): List of previous actions and their results. Only used when `__INLINE_CODE_0__`
+- **is**: obj:`False`. (default: :obj:`None`)
+
+**Returns:**
+
+ Dict[str, Any]: The parsed LLM response containing `__INLINE_CODE_0__`
+(List[str]) and `__INLINE_CODE_1__` (Dict[str, Any]).
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.mdx
index a11e3eb34..c8f016d6c 100644
--- 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.mdx
@@ -13,8 +13,12 @@ appear as a regular user browser and configure action timeouts.
class BrowserConfig:
```
-Configuration class for browser settings including stealth mode and
-timeouts.
+Configuration class for browser settings including stealth mode
+and timeouts.
+
+Provides static methods to retrieve timeout values, action limits,
+stealth configuration, and HTTP headers. All values support
+environment variable overrides.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_timeout_config"></a>
@@ -26,7 +30,11 @@ def get_timeout_config():
**Returns:**
- Dict[str, int]: Timeout configuration in milliseconds.
+ Dict[str, int]: A dictionary of timeout values in milliseconds
+with keys: `__INLINE_CODE_0____INLINE_CODE_1____INLINE_CODE_2__`,
+`__INLINE_CODE_3____INLINE_CODE_4____INLINE_CODE_5__`,
+`__INLINE_CODE_6____INLINE_CODE_7____INLINE_CODE_8__`, and
+`__INLINE_CODE_9__`.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_action_limits"></a>
@@ -38,7 +46,8 @@ def get_action_limits():
**Returns:**
- Dict[str, int]: Action limits configuration.
+ Dict[str, int]: A dictionary of action limits with key
+`__INLINE_CODE_0__` (in pixels).
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_log_limits"></a>
@@ -50,7 +59,8 @@ def get_log_limits():
**Returns:**
- Dict[str, int]: Console Log limits configuration.
+ Dict[str, int]: A dictionary of log limits with key
+`__INLINE_CODE_0__`.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_action_timeout"></a>
@@ -64,7 +74,8 @@ Get action timeout with optional override.
**Parameters:**
-- **override**: Optional timeout override value in milliseconds.
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
**Returns:**
@@ -82,7 +93,8 @@ Get short timeout with optional override.
**Parameters:**
-- **override**: Optional timeout override value in milliseconds.
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
**Returns:**
@@ -100,7 +112,8 @@ Get navigation timeout with optional override.
**Parameters:**
-- **override**: Optional timeout override value in milliseconds.
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
**Returns:**
@@ -118,7 +131,8 @@ Get network idle timeout with optional override.
**Parameters:**
-- **override**: Optional timeout override value in milliseconds.
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
**Returns:**
@@ -136,7 +150,8 @@ Get maximum scroll amount with optional override.
**Parameters:**
-- **override**: Optional scroll amount override value in pixels.
+- **override** (int, optional): Scroll amount override value in pixels.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
**Returns:**
@@ -154,11 +169,11 @@ Get maximum log limit with optional override.
**Parameters:**
-- **override**: Optional log limit override value.
+- **override** (int, optional): Log limit override value. If :obj:`None`, uses the environment-configured default. (default: :obj:`None`)
**Returns:**
- int: Maximum log limit.
+ int: Maximum number of log entries.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.BrowserConfig.get_screenshot_timeout"></a>
@@ -172,7 +187,8 @@ Get screenshot timeout with optional override.
**Parameters:**
-- **override**: Optional timeout override value in milliseconds.
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
**Returns:**
@@ -190,7 +206,8 @@ Get page stability timeout with optional override.
**Parameters:**
-- **override**: Optional timeout override value in milliseconds.
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
**Returns:**
@@ -208,7 +225,8 @@ Get DOM content loaded timeout with optional override.
**Parameters:**
-- **override**: Optional timeout override value in milliseconds.
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
**Returns:**
@@ -282,9 +300,12 @@ def get_all_config():
class ConfigLoader:
```
-Legacy wrapper for BrowserConfig - maintained for backward
+Legacy wrapper for :obj:`BrowserConfig`, maintained for backward
compatibility.
+All methods delegate directly to :obj:`BrowserConfig`. New code
+should use :obj:`BrowserConfig` directly.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_browser_config"></a>
### get_browser_config
@@ -293,7 +314,9 @@ compatibility.
def get_browser_config(cls):
```
-Get the BrowserConfig class.
+**Returns:**
+
+ type: The :obj:`BrowserConfig` class.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_stealth_config"></a>
@@ -303,7 +326,9 @@ Get the BrowserConfig class.
def get_stealth_config(cls):
```
-Get the StealthConfig class (alias).
+**Returns:**
+
+ type: The :obj:`BrowserConfig` class.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_timeout_config"></a>
@@ -313,7 +338,10 @@ Get the StealthConfig class (alias).
def get_timeout_config(cls):
```
-Get timeout configuration.
+**Returns:**
+
+ Dict[str, int]: A dictionary of timeout values in milliseconds.
+See :obj:`BrowserConfig.get_timeout_config` for keys.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_action_timeout"></a>
@@ -325,6 +353,15 @@ def get_action_timeout(cls, override: Optional[int] = None):
Get action timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_short_timeout"></a>
### get_short_timeout
@@ -335,6 +372,15 @@ def get_short_timeout(cls, override: Optional[int] = None):
Get short timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_navigation_timeout"></a>
### get_navigation_timeout
@@ -345,6 +391,15 @@ def get_navigation_timeout(cls, override: Optional[int] = None):
Get navigation timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_network_idle_timeout"></a>
### get_network_idle_timeout
@@ -355,6 +410,15 @@ def get_network_idle_timeout(cls, override: Optional[int] = None):
Get network idle timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_max_scroll_amount"></a>
### get_max_scroll_amount
@@ -365,6 +429,15 @@ def get_max_scroll_amount(cls, override: Optional[int] = None):
Get maximum scroll amount with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_max_log_limit"></a>
### get_max_log_limit
@@ -375,6 +448,15 @@ def get_max_log_limit(cls, override: Optional[int] = None):
Get maximum log limit with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_screenshot_timeout"></a>
### get_screenshot_timeout
@@ -385,6 +467,15 @@ def get_screenshot_timeout(cls, override: Optional[int] = None):
Get screenshot timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_page_stability_timeout"></a>
### get_page_stability_timeout
@@ -395,6 +486,15 @@ def get_page_stability_timeout(cls, override: Optional[int] = None):
Get page stability timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.ConfigLoader.get_dom_content_loaded_timeout"></a>
### get_dom_content_loaded_timeout
@@ -405,6 +505,15 @@ def get_dom_content_loaded_timeout(cls, override: Optional[int] = None):
Get DOM content loaded timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_browser_config"></a>
## get_browser_config
@@ -413,7 +522,9 @@ Get DOM content loaded timeout with optional override.
def get_browser_config():
```
-Get BrowserConfig class.
+**Returns:**
+
+ type: The :obj:`BrowserConfig` class.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_stealth_config"></a>
@@ -423,7 +534,9 @@ Get BrowserConfig class.
def get_stealth_config():
```
-Get StealthConfig class.
+**Returns:**
+
+ type: The :obj:`BrowserConfig` class.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_timeout_config"></a>
@@ -433,7 +546,10 @@ Get StealthConfig class.
def get_timeout_config():
```
-Get timeout configuration.
+**Returns:**
+
+ Dict[str, int]: A dictionary of timeout values in milliseconds.
+See :obj:`BrowserConfig.get_timeout_config` for keys.
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_action_timeout"></a>
@@ -445,6 +561,15 @@ def get_action_timeout(override: Optional[int] = None):
Get action timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_short_timeout"></a>
## get_short_timeout
@@ -455,6 +580,15 @@ def get_short_timeout(override: Optional[int] = None):
Get short timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_navigation_timeout"></a>
## get_navigation_timeout
@@ -465,6 +599,15 @@ def get_navigation_timeout(override: Optional[int] = None):
Get navigation timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_network_idle_timeout"></a>
## get_network_idle_timeout
@@ -475,6 +618,15 @@ def get_network_idle_timeout(override: Optional[int] = None):
Get network idle timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_max_scroll_amount"></a>
## get_max_scroll_amount
@@ -485,6 +637,15 @@ def get_max_scroll_amount(override: Optional[int] = None):
Get maximum scroll amount with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_max_log_limit"></a>
## get_max_log_limit
@@ -495,6 +656,15 @@ def get_max_log_limit(override: Optional[int] = None):
Get maximum log limit with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_screenshot_timeout"></a>
## get_screenshot_timeout
@@ -505,6 +675,15 @@ def get_screenshot_timeout(override: Optional[int] = None):
Get screenshot timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_page_stability_timeout"></a>
## get_page_stability_timeout
@@ -515,6 +694,15 @@ def get_page_stability_timeout(override: Optional[int] = None):
Get page stability timeout with optional override.
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.config_loader.get_dom_content_loaded_timeout"></a>
## get_dom_content_loaded_timeout
@@ -524,3 +712,12 @@ def get_dom_content_loaded_timeout(override: Optional[int] = None):
```
Get DOM content loaded timeout with optional override.
+
+**Parameters:**
+
+- **override** (int, optional): Timeout override value in milliseconds.
+- **If**: obj:`None`, uses the environment-configured default. (default: :obj:`None`)
+
+**Returns:**
+
+ int: Timeout value in milliseconds.
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.mdx
index 1c9fda810..911d990ca 100644
--- a/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.snapshot.mdx
+++ b/docs/mintlify/reference/camel.toolkits.hybrid_browser_toolkit_py.snapshot.mdx
@@ -11,6 +11,10 @@ class PageSnapshot:
Utility for capturing YAML-like page snapshots and diff-only
variants.
+**Parameters:**
+
+- **page** (Page): The Playwright page instance to capture snapshots from.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.snapshot.PageSnapshot.__init__"></a>
### __init__
@@ -27,6 +31,16 @@ def __init__(self, page: 'Page'):
def _format_snapshot(text: str):
```
+Format raw snapshot text into a fenced YAML block.
+
+**Parameters:**
+
+- **text** (str): The raw snapshot text to format.
+
+**Returns:**
+
+ str: The snapshot wrapped in a YAML code block.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.snapshot.PageSnapshot._compute_diff"></a>
### _compute_diff
@@ -35,6 +49,18 @@ def _format_snapshot(text: str):
def _compute_diff(old: str, new: str):
```
+Compute a unified diff between two snapshot strings.
+
+**Parameters:**
+
+- **old** (str): The previous snapshot text.
+- **new** (str): The current snapshot text.
+
+**Returns:**
+
+ str: A formatted diff string, or a message indicating no
+changes were detected.
+
<a id="camel.toolkits.hybrid_browser_toolkit_py.snapshot.PageSnapshot._detect_priorities"></a>
### _detect_priorities
@@ -43,4 +69,17 @@ def _compute_diff(old: str, new: str):
def _detect_priorities(self, snapshot_yaml: str):
```
-Return sorted list of priorities present (1,2,3).
+Return sorted list of priority levels present in the snapshot.
+
+Priority levels are assigned based on element types found in the
+snapshot: interactive elements (input, button, etc.) map to
+priority 1, labels to priority 2, and all others to priority 3.
+
+**Parameters:**
+
+- **snapshot_yaml** (str): The snapshot text to analyze.
+
+**Returns:**
+
+ List[int]: Sorted list of detected priority levels (e.g.
+:obj:`[1, 2, 3]`).