hyperbrowser 0.34.0__py3-none-any.whl → 0.35.0__py3-none-any.whl

hyperbrowser/tools/__init__.py

@@ -1,5 +1,5 @@
 import json
-from hyperbrowser.models.beta.agents.browser_use import StartBrowserUseTaskParams
+from hyperbrowser.models.agents.browser_use import StartBrowserUseTaskParams
 from hyperbrowser.models.crawl import StartCrawlJobParams
 from hyperbrowser.models.extract import StartExtractJobParams
 from hyperbrowser.models.scrape import StartScrapeJobParams
@@ -9,12 +9,14 @@ from .openai import (
     BROWSER_USE_TOOL_OPENAI,
     EXTRACT_TOOL_OPENAI,
     SCRAPE_TOOL_OPENAI,
+    SCREENSHOT_TOOL_OPENAI,
     CRAWL_TOOL_OPENAI,
 )
 from .anthropic import (
     BROWSER_USE_TOOL_ANTHROPIC,
     EXTRACT_TOOL_ANTHROPIC,
     SCRAPE_TOOL_ANTHROPIC,
+    SCREENSHOT_TOOL_ANTHROPIC,
     CRAWL_TOOL_ANTHROPIC,
 )
 
@@ -34,6 +36,21 @@ class WebsiteScrapeTool:
         return resp.data.markdown if resp.data and resp.data.markdown else ""
 
 
+class WebsiteScreenshotTool:
+    openai_tool_definition = SCREENSHOT_TOOL_OPENAI
+    anthropic_tool_definition = SCREENSHOT_TOOL_ANTHROPIC
+
+    @staticmethod
+    def runnable(hb: Hyperbrowser, params: dict) -> str:
+        resp = hb.scrape.start_and_wait(params=StartScrapeJobParams(**params))
+        return resp.data.screenshot if resp.data and resp.data.screenshot else ""
+
+    @staticmethod
+    async def async_runnable(hb: AsyncHyperbrowser, params: dict) -> str:
+        resp = await hb.scrape.start_and_wait(params=StartScrapeJobParams(**params))
+        return resp.data.screenshot if resp.data and resp.data.screenshot else ""
+
+
 class WebsiteCrawlTool:
     openai_tool_definition = CRAWL_TOOL_OPENAI
     anthropic_tool_definition = CRAWL_TOOL_ANTHROPIC
@@ -88,14 +105,14 @@ class BrowserUseTool:
 
     @staticmethod
     def runnable(hb: Hyperbrowser, params: dict) -> str:
-        resp = hb.beta.agents.browser_use.start_and_wait(
+        resp = hb.agents.browser_use.start_and_wait(
             params=StartBrowserUseTaskParams(**params)
         )
         return resp.data.final_result if resp.data and resp.data.final_result else ""
 
     @staticmethod
     async def async_runnable(hb: AsyncHyperbrowser, params: dict) -> str:
-        resp = await hb.beta.agents.browser_use.start_and_wait(
+        resp = await hb.agents.browser_use.start_and_wait(
             params=StartBrowserUseTaskParams(**params)
         )
         return resp.data.final_result if resp.data and resp.data.final_result else ""

hyperbrowser/tools/anthropic.py

@@ -6,6 +6,7 @@ from hyperbrowser.tools.schema import (
     CRAWL_SCHEMA,
     EXTRACT_SCHEMA,
     SCRAPE_SCHEMA,
+    SCREENSHOT_SCHEMA,
 )
 
 
@@ -54,6 +55,12 @@ SCRAPE_TOOL_ANTHROPIC: ToolParam = {
     "description": "Scrape content from a webpage and return the content in markdown format",
 }
 
+SCREENSHOT_TOOL_ANTHROPIC: ToolParam = {
+    "input_schema": SCREENSHOT_SCHEMA,
+    "name": "screenshot_webpage",
+    "description": "Scrape content from a webpage and return the content in screenshot format",
+}
+
 CRAWL_TOOL_ANTHROPIC: ToolParam = {
     "input_schema": CRAWL_SCHEMA,
     "name": "crawl_website",

hyperbrowser/tools/openai.py

@@ -6,6 +6,7 @@ from hyperbrowser.tools.schema import (
     CRAWL_SCHEMA,
     EXTRACT_SCHEMA,
     SCRAPE_SCHEMA,
+    SCREENSHOT_SCHEMA,
 )
 
 FunctionParameters: TypeAlias = Dict[str, object]
@@ -63,6 +64,16 @@ SCRAPE_TOOL_OPENAI: ChatCompletionToolParam = {
     },
 }
 
+SCREENSHOT_TOOL_OPENAI: ChatCompletionToolParam = {
+    "type": "function",
+    "function": {
+        "name": "screenshot_webpage",
+        "description": "Scrape content from a webpage and return the content in screenshot format",
+        "parameters": SCREENSHOT_SCHEMA,
+        "strict": True,
+    },
+}
+
 CRAWL_TOOL_OPENAI: ChatCompletionToolParam = {
     "type": "function",
     "function": {

hyperbrowser/tools/schema.py

@@ -1,38 +1,63 @@
-SCRAPE_OPTIONS = {
-    "type": "object",
-    "description": "The options for the scrape",
-    "properties": {
-        "include_tags": {
-            "type": "array",
-            "items": {
+from typing import Literal, List
+
+scrape_types = Literal["markdown", "screenshot"]
+
+
+def get_scrape_options(formats: List[scrape_types] = ["markdown"]):
+    return {
+        "type": "object",
+        "description": "The options for the scrape",
+        "properties": {
+            "format": {
                 "type": "string",
+                "description": "The format of the content to scrape",
+                "enum": formats,
             },
-            "description": "An array of HTML tags, classes, or IDs to include in the scraped content. Only elements matching these selectors will be returned.",
-        },
-        "exclude_tags": {
-            "type": "array",
-            "items": {
-                "type": "string",
+            "include_tags": {
+                "type": "array",
+                "items": {
+                    "type": "string",
+                },
+                "description": "An array of HTML tags, classes, or IDs to include in the scraped content. Only elements matching these selectors will be returned.",
+            },
+            "exclude_tags": {
+                "type": "array",
+                "items": {
+                    "type": "string",
+                },
+                "description": "An array of HTML tags, classes, or IDs to exclude from the scraped content. Elements matching these selectors will be omitted from the response.",
+            },
+            "only_main_content": {
+                "type": "boolean",
+                "description": "Whether to only return the main content of the page. If true, only the main content of the page will be returned, excluding any headers, navigation menus,footers, or other non-main content.",
             },
-            "description": "An array of HTML tags, classes, or IDs to exclude from the scraped content. Elements matching these selectors will be omitted from the response.",
         },
-        "only_main_content": {
-            "type": "boolean",
-            "description": "Whether to only return the main content of the page. If true, only the main content of the page will be returned, excluding any headers, navigation menus,footers, or other non-main content.",
+        "required": ["include_tags", "exclude_tags", "only_main_content", "format"],
+        "additionalProperties": False,
+    }
+
+
+SCRAPE_SCHEMA = {
+    "type": "object",
+    "properties": {
+        "url": {
+            "type": "string",
+            "description": "The URL of the website to scrape",
         },
+        "scrape_options": get_scrape_options(),
     },
-    "required": ["include_tags", "exclude_tags", "only_main_content"],
+    "required": ["url", "scrape_options"],
     "additionalProperties": False,
 }
 
-SCRAPE_SCHEMA = {
+SCREENSHOT_SCHEMA = {
     "type": "object",
     "properties": {
         "url": {
             "type": "string",
             "description": "The URL of the website to scrape",
         },
-        "scrape_options": SCRAPE_OPTIONS,
+        "scrape_options": get_scrape_options(["screenshot"]),
     },
     "required": ["url", "scrape_options"],
     "additionalProperties": False,
@@ -71,7 +96,7 @@ CRAWL_SCHEMA = {
             },
             "description": "An array of regular expressions or wildcard patterns specifying which URLs should be included in the crawl. Only pages whose URLs' path match one of these path patterns will be visited. Example: ['/admin', '/careers/*']",
         },
-        "scrape_options": SCRAPE_OPTIONS,
+        "scrape_options": get_scrape_options(),
     },
     "required": [
         "url",

{hyperbrowser-0.34.0.dist-info → hyperbrowser-0.35.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hyperbrowser
-Version: 0.34.0
+Version: 0.35.0
 Summary: Python SDK for hyperbrowser
 License: MIT
 Author: Nikhil Shahi

{hyperbrowser-0.34.0.dist-info → hyperbrowser-0.35.0.dist-info}/RECORD

@@ -29,14 +29,14 @@ hyperbrowser/models/extract.py,sha256=DXg0HtO44plAtcFOmqUpdp9P93tq45U2fLWxn5jdjA
 hyperbrowser/models/profile.py,sha256=KRb_LNxxW00AsD_thzzthFS51vInJawt1RcoNz4Q9i8,1322
 hyperbrowser/models/scrape.py,sha256=iMsUuMx3UFtSci6TVUpcH5ytbgwiImIXjviVcGZ_gBQ,5048
 hyperbrowser/models/session.py,sha256=i1NkrQWNlKziDd98ySdrUUH7XSv6qOa2cmiK5vV7VeI,6730
-hyperbrowser/tools/__init__.py,sha256=tC5aIXvDqJdUbveRwTWd6p0e-IovU_DwxPcHmmYiMGY,3923
-hyperbrowser/tools/anthropic.py,sha256=tMZa4mceL0bx6hNls6CDYfSEdlH5HJMsTd-AeocvgRY,2463
-hyperbrowser/tools/openai.py,sha256=sKAQrQiYiCdibtuysagpZYSWecKkVf9vO0VHQ3NmrF0,3184
-hyperbrowser/tools/schema.py,sha256=9u0pFbFB6qAz8CNm4Powk86QeUyYuLbPYabQe4WCEKk,6416
+hyperbrowser/tools/__init__.py,sha256=L-2xveBbSuIBQBQhJmXGCLNYEUq_XHDdgz_gBAsmQZo,4605
+hyperbrowser/tools/anthropic.py,sha256=bo8jn2ROHCp_hpX1_cjkCk7qU0LmuBr_gvlvM0f5OMc,2699
+hyperbrowser/tools/openai.py,sha256=YkdONf2CYuuJei2019a5cpCcZGn8g5bH-PnZ4YY7c4U,3514
+hyperbrowser/tools/schema.py,sha256=mRaPmDncJt7j84kz9ssNZdbjRDDjKVM6wL3sXz_83gE,7197
 hyperbrowser/transport/async_transport.py,sha256=6HKoeM5TutIqraEscEWobvSPWF3iVKh2hPflGNKwykw,4128
 hyperbrowser/transport/base.py,sha256=ildpMrDiM8nvrSGrH2LTOafmB17T7PQB_NQ1ODA378U,1703
 hyperbrowser/transport/sync.py,sha256=aUVpxWF8sqSycLNKxVNEZvlsZSoqc1eHgPK1Y1QA1u8,3422
-hyperbrowser-0.34.0.dist-info/LICENSE,sha256=6rUGKlyKb_1ZAH7h7YITYAAUNFN3MNGGKCyfrw49NLE,1071
-hyperbrowser-0.34.0.dist-info/METADATA,sha256=nKHdGSYyqUWRvKQV4RZNowpBEMVihYUSqKyFtJwkjws,3471
-hyperbrowser-0.34.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-hyperbrowser-0.34.0.dist-info/RECORD,,
+hyperbrowser-0.35.0.dist-info/LICENSE,sha256=6rUGKlyKb_1ZAH7h7YITYAAUNFN3MNGGKCyfrw49NLE,1071
+hyperbrowser-0.35.0.dist-info/METADATA,sha256=_cCONtcpaLWQmn1tyaGEeoYd0bxWz12az58hF9eJbcY,3471
+hyperbrowser-0.35.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+hyperbrowser-0.35.0.dist-info/RECORD,,