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-bote260632f90f0
diff --git a/docs/reference/camel.toolkits.non_visual_browser_toolkit.actions.md b/docs/reference/camel.toolkits.non_visual_browser_toolkit.actions.md
new file mode 100644
index 000000000..024feec52
--- /dev/null
+++ b/docs/reference/camel.toolkits.non_visual_browser_toolkit.actions.md
@@ -0,0 +1,27 @@
+<a id="camel.toolkits.non_visual_browser_toolkit.actions"></a>
+
+<a id="camel.toolkits.non_visual_browser_toolkit.actions.ActionExecutor"></a>
+
+## ActionExecutor
+
+```python
+class ActionExecutor:
+```
+
+Executes high-level actions (click, type …) on a Playwright Page.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.actions.ActionExecutor.__init__"></a>
+
+### __init__
+
+```python
+def __init__(self, page: 'Page'):
+```
+
+<a id="camel.toolkits.non_visual_browser_toolkit.actions.ActionExecutor.should_update_snapshot"></a>
+
+### should_update_snapshot
+
+```python
+def should_update_snapshot(action: Dict[str, Any]):
+```
diff --git a/docs/reference/camel.toolkits.non_visual_browser_toolkit.agent.md b/docs/reference/camel.toolkits.non_visual_browser_toolkit.agent.md
new file mode 100644
index 000000000..84ad5790f
--- /dev/null
+++ b/docs/reference/camel.toolkits.non_visual_browser_toolkit.agent.md
@@ -0,0 +1,56 @@
+<a id="camel.toolkits.non_visual_browser_toolkit.agent"></a>
+
+<a id="camel.toolkits.non_visual_browser_toolkit.agent.PlaywrightLLMAgent"></a>
+
+## PlaywrightLLMAgent
+
+```python
+class PlaywrightLLMAgent:
+```
+
+High-level orchestration: snapshot ↔ LLM ↔ action executor.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.agent.PlaywrightLLMAgent.__init__"></a>
+
+### __init__
+
+```python
+def __init__(self):
+```
+
+<a id="camel.toolkits.non_visual_browser_toolkit.agent.PlaywrightLLMAgent._get_chat_agent"></a>
+
+### _get_chat_agent
+
+```python
+def _get_chat_agent(self):
+```
+
+Get or create the ChatAgent instance.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.agent.PlaywrightLLMAgent._safe_parse_json"></a>
+
+### _safe_parse_json
+
+```python
+def _safe_parse_json(self, content: str):
+```
+
+Safely parse JSON from LLM response with multiple fallback
+strategies.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.agent.PlaywrightLLMAgent._llm_call"></a>
+
+### _llm_call
+
+```python
+def _llm_call(
+ self,
+ prompt: str,
+ snapshot: str,
+ is_initial: bool,
+ history: Optional[List[Dict[str, Any]]] = None
+):
+```
+
+Call the LLM (via CAMEL ChatAgent) to get plan & next action.
diff --git a/docs/reference/camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit.md b/docs/reference/camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit.md
new file mode 100644
index 000000000..d898a1445
--- /dev/null
+++ b/docs/reference/camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit.md
@@ -0,0 +1,59 @@
+<a id="camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit"></a>
+
+<a id="camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit.BrowserNonVisualToolkit"></a>
+
+## BrowserNonVisualToolkit
+
+```python
+class BrowserNonVisualToolkit(BaseToolkit):
+```
+
+A lightweight, *non-visual* browser toolkit exposing primitive
+Playwright actions as CAMEL `FunctionTool`s.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit.BrowserNonVisualToolkit.__init__"></a>
+
+### __init__
+
+```python
+def __init__(self):
+```
+
+<a id="camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit.BrowserNonVisualToolkit.__del__"></a>
+
+### __del__
+
+```python
+def __del__(self):
+```
+
+Ensure cleanup when toolkit is garbage collected.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit.BrowserNonVisualToolkit._validate_ref"></a>
+
+### _validate_ref
+
+```python
+def _validate_ref(self, ref: str, method_name: str):
+```
+
+Validate that ref parameter is a non-empty string.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit.BrowserNonVisualToolkit._ensure_agent"></a>
+
+### _ensure_agent
+
+```python
+def _ensure_agent(self):
+```
+
+Create PlaywrightLLMAgent on first use if `web_agent_model`
+provided.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.browser_non_visual_toolkit.BrowserNonVisualToolkit.get_tools"></a>
+
+### get_tools
+
+```python
+def get_tools(self):
+```
diff --git a/docs/reference/camel.toolkits.non_visual_browser_toolkit.nv_browser_session.md b/docs/reference/camel.toolkits.non_visual_browser_toolkit.nv_browser_session.md
new file mode 100644
index 000000000..7a3a137ca
--- /dev/null
+++ b/docs/reference/camel.toolkits.non_visual_browser_toolkit.nv_browser_session.md
@@ -0,0 +1,24 @@
+<a id="camel.toolkits.non_visual_browser_toolkit.nv_browser_session"></a>
+
+<a id="camel.toolkits.non_visual_browser_toolkit.nv_browser_session.NVBrowserSession"></a>
+
+## NVBrowserSession
+
+```python
+class NVBrowserSession:
+```
+
+Lightweight wrapper around Playwright for non-visual (headless)
+browsing.
+
+It provides a single *Page* instance plus helper utilities (snapshot &
+executor). Multiple toolkits or agents can reuse this class without
+duplicating Playwright setup code.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.nv_browser_session.NVBrowserSession.__init__"></a>
+
+### __init__
+
+```python
+def __init__(self):
+```
diff --git a/docs/reference/camel.toolkits.non_visual_browser_toolkit.snapshot.md b/docs/reference/camel.toolkits.non_visual_browser_toolkit.snapshot.md
new file mode 100644
index 000000000..81522a636
--- /dev/null
+++ b/docs/reference/camel.toolkits.non_visual_browser_toolkit.snapshot.md
@@ -0,0 +1,46 @@
+<a id="camel.toolkits.non_visual_browser_toolkit.snapshot"></a>
+
+<a id="camel.toolkits.non_visual_browser_toolkit.snapshot.PageSnapshot"></a>
+
+## PageSnapshot
+
+```python
+class PageSnapshot:
+```
+
+Utility for capturing YAML-like page snapshots and diff-only
+variants.
+
+<a id="camel.toolkits.non_visual_browser_toolkit.snapshot.PageSnapshot.__init__"></a>
+
+### __init__
+
+```python
+def __init__(self, page: 'Page'):
+```
+
+<a id="camel.toolkits.non_visual_browser_toolkit.snapshot.PageSnapshot._format_snapshot"></a>
+
+### _format_snapshot
+
+```python
+def _format_snapshot(text: str):
+```
+
+<a id="camel.toolkits.non_visual_browser_toolkit.snapshot.PageSnapshot._compute_diff"></a>
+
+### _compute_diff
+
+```python
+def _compute_diff(old: str, new: str):
+```
+
+<a id="camel.toolkits.non_visual_browser_toolkit.snapshot.PageSnapshot._detect_priorities"></a>
+
+### _detect_priorities
+
+```python
+def _detect_priorities(self, snapshot_yaml: str):
+```
+
+Return sorted list of priorities present (1,2,3).