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

enhance: Support browser toolkit with dynamic channel PR 1937 (#2016)

Wendong-Fane7f75d8e0572
diff --git a/camel/toolkits/__init__.py b/camel/toolkits/__init__.py
index 82bd96295..7da68879b 100644
--- a/camel/toolkits/__init__.py
+++ b/camel/toolkits/__init__.py
@@ -56,7 +56,7 @@ from .excel_toolkit import ExcelToolkit
from .video_analysis_toolkit import VideoAnalysisToolkit
from .image_analysis_toolkit import ImageAnalysisToolkit
from .mcp_toolkit import MCPToolkit
-from .browser_toolkit import BrowserToolkit, ChromiumChannels
+from .browser_toolkit import BrowserToolkit
from .file_write_toolkit import FileWriteToolkit
from .terminal_toolkit import TerminalToolkit
from .pubmed_toolkit import PubMedToolkit
@@ -106,7 +106,6 @@ __all__ = [
'VideoAnalysisToolkit',
'ImageAnalysisToolkit',
'BrowserToolkit',
- 'ChromiumChannels',
'FileWriteToolkit',
'TerminalToolkit',
'PubMedToolkit',
diff --git a/camel/toolkits/browser_toolkit.py b/camel/toolkits/browser_toolkit.py
index cb9b485e5..46a3da2c6 100644
--- a/camel/toolkits/browser_toolkit.py
+++ b/camel/toolkits/browser_toolkit.py
@@ -21,13 +21,13 @@ import re
import shutil
import time
from copy import deepcopy
-from enum import Enum
from typing import (
TYPE_CHECKING,
Any,
BinaryIO,
Dict,
List,
+ Literal,
Optional,
Tuple,
TypedDict,
@@ -127,16 +127,6 @@ class InteractiveRegion(TypedDict):
rects: List[DOMRectangle]
-class ChromiumChannels(Enum):
- """
- Enum for the accepted browser channels.
- """
-
- CHROME = "chrome"
- MSEDGE = "msedge"
- CHROMIUM = "chromium"
-
-
def _get_str(d: Any, k: str) -> str:
r"""Safely retrieve a string value from a dictionary."""
if k not in d:
@@ -439,13 +429,16 @@ class BaseBrowser:
self,
headless=True,
cache_dir: Optional[str] = None,
- channel: ChromiumChannels = ChromiumChannels.CHROMIUM,
+ channel: Literal["chrome", "msedge", "chromium"] = "chromium",
):
r"""Initialize the WebBrowser instance.
Args:
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".
Returns:
None
@@ -456,7 +449,7 @@ class BaseBrowser:
self.history: list = []
self.headless = headless
- self.channel = channel.value
+ self.channel = channel
self._ensure_browser_installed()
self.playwright = sync_playwright().start()
self.page_history: list = [] # stores the history of visited pages
@@ -577,7 +570,7 @@ class BaseBrowser:
Args:
scroll_ratio (float): The ratio of viewport height to scroll each
- step (default: 0.8).
+ step. (default: :obj:`0.8`)
Returns:
List[str]: A list of paths to the screenshot files.
@@ -988,7 +981,7 @@ class BrowserToolkit(BaseToolkit):
self,
headless: bool = False,
cache_dir: Optional[str] = None,
- channel: ChromiumChannels = ChromiumChannels.CHROMIUM,
+ channel: Literal["chrome", "msedge", "chromium"] = "chromium",
history_window: int = 5,
web_agent_model: Optional[BaseModelBackend] = None,
planning_agent_model: Optional[BaseModelBackend] = None,
@@ -999,12 +992,17 @@ class BrowserToolkit(BaseToolkit):
Args:
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`")
"""
self.browser = BaseBrowser(
@@ -1422,7 +1420,8 @@ Your output should be in json format, including the following fields:
Args:
task_prompt (str): The task prompt to solve.
start_url (str): The start URL to visit.
- round_limit (int): The round limit to solve the task (default: 12).
+ round_limit (int): The round limit to solve the task.
+ (default: :obj:`12`).
Returns:
str: The simulation result to the task.
diff --git a/examples/toolkits/web_toolkit.py b/examples/toolkits/browser_toolkit.py
similarity index 95%
rename from examples/toolkits/web_toolkit.py
rename to examples/toolkits/browser_toolkit.py
index 23d62b7ea..9ffc7f99d 100644
--- a/examples/toolkits/web_toolkit.py
+++ b/examples/toolkits/browser_toolkit.py
@@ -16,7 +16,7 @@
from camel.agents import ChatAgent
from camel.configs import ChatGPTConfig
from camel.models import ModelFactory
-from camel.toolkits import BrowserToolkit, ChromiumChannels
+from camel.toolkits import BrowserToolkit
from camel.types import ModelPlatformType, ModelType
model = ModelFactory.create(
@@ -47,7 +47,7 @@ web_toolkit = BrowserToolkit(
headless=False,
web_agent_model=web_agent_model,
planning_agent_model=planning_agent_model,
- channel=ChromiumChannels.CHROMIUM,
+ channel="chromium",
)
agent = ChatAgent(
diff --git a/test/toolkits/test_browser_toolkit.py b/test/toolkits/test_browser_toolkit.py
index b0e30c510..67acafdae 100644
--- a/test/toolkits/test_browser_toolkit.py
+++ b/test/toolkits/test_browser_toolkit.py
@@ -21,7 +21,6 @@ from PIL import Image
from camel.toolkits.browser_toolkit import (
BaseBrowser,
BrowserToolkit,
- ChromiumChannels,
)
TEST_URL = "https://example.com"
@@ -69,15 +68,15 @@ def test_base_browser_initialization_order():
@pytest.mark.parametrize(
"channel",
[
- ChromiumChannels.CHROME,
- ChromiumChannels.MSEDGE,
- ChromiumChannels.CHROMIUM,
+ "chrome",
+ "msedge",
+ "chromium",
],
)
-def test_browser_channel_selection(channel: ChromiumChannels):
+def test_browser_channel_selection(channel):
with patch('playwright.sync_api.sync_playwright'):
browser = BaseBrowser(headless=True, channel=channel)
- assert browser.channel == channel.value
+ assert browser.channel == channel
def test_browser_visit_page(base_browser_fixture):