Camel.toolkits.hybrid browser toolkit py.hybrid browser toolkit

​

HybridBrowserToolkit

class HybridBrowserToolkit(BaseToolkit, RegisteredAgentToolkit):

​

init

def __init__(self):

• 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: browser_open, browser_close, browser_visit_page, browser_back, browser_forward, browser_get_page_snapshot, browser_get_som_screenshot, browser_get_page_links, browser_click, browser_type, browser_select, browser_scroll, browser_enter, browser_wait_user, browser_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.
• viewport_limit (bool): When True, only return snapshot results visible in the current viewport. When False, return all elements on the page regardless of visibility. Defaults to False.

​

web_agent_model

def web_agent_model(self):

​

web_agent_model

def web_agent_model(self, value: Optional[BaseModelBackend]):

​

cache_dir

def cache_dir(self):

​

del

def __del__(self):

​

_load_unified_analyzer

def _load_unified_analyzer(self):

​

_validate_ref

def _validate_ref(self, ref: str, method_name: str):

​

_truncate_if_needed

def _truncate_if_needed(self, content: Any):

​

action_logger

def action_logger(func: Callable[..., Any]):

​

_convert_analysis_to_rects

def _convert_analysis_to_rects(self, analysis_data: Dict[str, Any]):

​

_add_set_of_mark

def _add_set_of_mark(self, image, rects):

​

_format_snapshot_from_analysis

def _format_snapshot_from_analysis(self, analysis_data: Dict[str, Any]):

​

_ensure_agent

def _ensure_agent(self):

​

get_log_summary

def get_log_summary(self):

​

clear_logs

def clear_logs(self):

​

clone_for_new_session

def clone_for_new_session(self, new_session_id: Optional[str] = None):

• new_session_id: Optional new session ID. If None, a UUID will be generated.

​

get_tools

def get_tools(self):