Skip to main content

​
extract_function_name

def extract_function_name(s: str):
Extract the pure function name from a string (without parameters or parentheses) Parameters:
  • s (str): Input string, e.g., 1.click_id(14), scroll_up(), \'visit_page(url)\', etc.
Returns: str: Pure function name (e.g., click_id, scroll_up, visit_page)

​
AsyncBaseBrowser

class AsyncBaseBrowser:

​
init

def __init__(
    self,
    headless = True,
    cache_dir: Optional[str] = None,
    channel: Literal['chrome', 'msedge', 'chromium'] = 'chromium',
    cookie_json_path: Optional[str] = None,
    user_data_dir: Optional[str] = None
):
Initialize the asynchronous browser core. Parameters:
  • headless (bool): Whether to run the browser in headless mode.
  • cache_dir (Union[str, None]): The directory to store cache files.
  • channel (Literal["chrome", "msedge", "chromium"]): The browser channel to use. Must be one of “chrome”, “msedge”, or “chromium”.
  • cookie_json_path (Optional[str]): Path to a JSON file containing authentication cookies and browser storage state. If provided and the file exists, the browser will load this state to maintain authenticated sessions. This is primarily used when user_data_dir is not set.
  • user_data_dir (Optional[str]): The directory to store user data for persistent context. If None, a fresh browser instance is used without saving data. (default: :obj:None)
Returns: None

​
init

def init(self):
Initialize the browser asynchronously.

​
clean_cache

def clean_cache(self):
Delete the cache directory and its contents.

​
wait_for_load

def wait_for_load(self, timeout: int = 20):
Wait for a certain amount of time for the page to load. Parameters:
  • timeout (int): Timeout in seconds.

​
click_blank_area

def click_blank_area(self):
Click a blank area of the page to unfocus the current element.

​
visit_page

def visit_page(self, url: str):
Visit a page with the given URL.

​
ask_question_about_video

def ask_question_about_video(self, question: str):
Ask a question about the video on the current page, such as YouTube video. Parameters:
  • question (str): The question to ask.
Returns: str: The answer to the question.

​
get_screenshot

def get_screenshot(self, save_image: bool = False):
Get a screenshot of the current page. Parameters:
  • save_image (bool): Whether to save the image to the cache directory.
Returns: Tuple[Image.Image, str]: A tuple containing the screenshot image and the path to the image file if saved, otherwise :obj:None.

​
capture_full_page_screenshots

def capture_full_page_screenshots(self, scroll_ratio: float = 0.8):
Capture full page screenshots by scrolling the page with a buffer zone. Parameters:
  • scroll_ratio (float): The ratio of viewport height to scroll each step (default: 0.8).
Returns: List[str]: A list of paths to the captured screenshots.

​
get_visual_viewport

def get_visual_viewport(self):
Get the visual viewport of the current page.

​
get_interactive_elements

def get_interactive_elements(self):
Returns: Dict[str, InteractiveRegion]: A dictionary of interactive elements.

​
get_som_screenshot

def get_som_screenshot(self, save_image: bool = False):
Get a screenshot of the current viewport with interactive elements marked. Parameters:
  • save_image (bool): Whether to save the image to the cache directory.
Returns: Tuple[Image.Image, str]: A tuple containing the screenshot image and the path to the image file.

​
scroll_up

def scroll_up(self):
Scroll up the page.

​
scroll_down

def scroll_down(self):
Scroll down the page.

​
get_url

def get_url(self):
Get the URL of the current page.

​
click_id

def click_id(self, identifier: Union[str, int]):
Click an element with the given identifier.

​
extract_url_content

def extract_url_content(self):
Extract the content of the current page.

​
download_file_id

def download_file_id(self, identifier: Union[str, int]):
Download a file with the given identifier.

​
fill_input_id

def fill_input_id(self, identifier: Union[str, int], text: str):
Fill an input field with the given text, and then press Enter.

​
scroll_to_bottom

def scroll_to_bottom(self):
Scroll to the bottom of the page.

​
scroll_to_top

def scroll_to_top(self):
Scroll to the top of the page.

​
hover_id

def hover_id(self, identifier: Union[str, int]):
Hover over an element with the given identifier.

​
find_text_on_page

def find_text_on_page(self, search_text: str):
Find the next given text on the page, and scroll the page to the targeted text. It is equivalent to pressing Ctrl + F and searching for the text. Parameters:
  • search_text (str): The text to search for.
Returns: str: The result of the action.

​
back

def back(self):
Navigate back to the previous page.

​
close

def close(self):
Close the browser.

​
show_interactive_elements

def show_interactive_elements(self):
Show simple interactive elements on the current page.

​
get_webpage_content

def get_webpage_content(self):
Extract the content of the current page.

​
_ensure_browser_installed

def _ensure_browser_installed(self):
Ensure the browser is installed.

​
AsyncBrowserToolkit

class AsyncBrowserToolkit(BaseToolkit):
An asynchronous class for browsing the web and interacting with web pages. This class provides methods for browsing the web and interacting with web pages.

​
init

def __init__(
    self,
    headless: bool = False,
    cache_dir: Optional[str] = None,
    channel: Literal['chrome', 'msedge', 'chromium'] = 'chromium',
    history_window: int = 5,
    web_agent_model: Optional[BaseModelBackend] = None,
    planning_agent_model: Optional[BaseModelBackend] = None,
    output_language: str = 'en',
    cookie_json_path: Optional[str] = None,
    user_data_dir: Optional[str] = None
):
Initialize the BrowserToolkit instance. Parameters:
  • headless (bool): Whether to run the browser in headless mode.
  • cache_dir (Union[str, None]): The directory to store cache files.
  • channel (Literal["chrome", "msedge", "chromium"]): The browser channel to use. Must be one of “chrome”, “msedge”, or “chromium”.
  • history_window (int): The window size for storing the history of actions.
  • web_agent_model (Optional[BaseModelBackend]): The model backend for the web agent.
  • planning_agent_model (Optional[BaseModelBackend]): The model backend for the planning agent.
  • output_language (str): The language to use for output. (default: :obj:"en”)
  • cookie_json_path (Optional[str]): Path to a JSON file containing authentication cookies and browser storage state. If provided and the file exists, the browser will load this state to maintain authenticated sessions without requiring manual login. (default: :obj:None)
  • user_data_dir (Optional[str]): The directory to store user data for persistent context. (default: :obj:"user_data_dir/")

​
_reset

def _reset(self):

​
_initialize_agent

def _initialize_agent(self):
Initialize the planning and web agents.

​
get_tools

def get_tools(self):
⌘I