anchorbrowser 0.1.0a3__py3-none-any.whl → 0.2.0__py3-none-any.whl

anchorbrowser/resources/tools.py

@@ -7,7 +7,7 @@ from typing_extensions import Literal
 import httpx
 
 from ..types import tool_fetch_webpage_params, tool_perform_web_task_params, tool_screenshot_webpage_params
-from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
 from .._utils import maybe_transform, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
@@ -54,15 +54,19 @@ class ToolsResource(SyncAPIResource):
     def fetch_webpage(
         self,
         *,
-        session_id: str | NotGiven = NOT_GIVEN,
-        format: Literal["html", "markdown"] | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
+        session_id: str | Omit = omit,
+        format: Literal["html", "markdown"] | Omit = omit,
+        new_page: bool | Omit = omit,
+        page_index: int | Omit = omit,
+        return_partial_on_timeout: bool | Omit = omit,
+        url: str | Omit = omit,
+        wait: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> str:
         """
         Retrieve the rendered content of a webpage, optionally formatted as Markdown or
@@ -74,9 +78,18 @@ class ToolsResource(SyncAPIResource):
 
           format: The output format of the content.
 
+          new_page: Whether to create a new page for the content.
+
+          page_index: The index of the page to fetch content from. **Overides new_page**.
+
+          return_partial_on_timeout: Whether to return partial content if the content is not loaded within the 20
+              seconds.
+
           url: The URL of the webpage to fetch content from. When left empty, the current
               webpage is used.
 
+          wait: The time to wait for **dynamic** content to load in **milliseconds**.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -91,7 +104,11 @@ class ToolsResource(SyncAPIResource):
             body=maybe_transform(
                 {
                     "format": format,
+                    "new_page": new_page,
+                    "page_index": page_index,
+                    "return_partial_on_timeout": return_partial_on_timeout,
                     "url": url,
+                    "wait": wait,
                 },
                 tool_fetch_webpage_params.ToolFetchWebpageParams,
             ),
@@ -109,15 +126,19 @@ class ToolsResource(SyncAPIResource):
         self,
         *,
         prompt: str,
-        session_id: str | NotGiven = NOT_GIVEN,
-        output_schema: object | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
+        session_id: str | Omit = omit,
+        agent: Literal["browser-use", "openai-cua"] | Omit = omit,
+        highlight_elements: bool | Omit = omit,
+        model: str | Omit = omit,
+        output_schema: object | Omit = omit,
+        provider: Literal["openai", "gemini", "groq", "azure", "xai"] | Omit = omit,
+        url: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ToolPerformWebTaskResponse:
         """
         Start from a URL and perform the given task.
@@ -129,8 +150,18 @@ class ToolsResource(SyncAPIResource):
               sessions. When passed, the tool will be executed on the provided browser
               session.
 
+          agent: The AI agent to use for task completion. Defaults to browser-use.
+
+          highlight_elements: Whether to highlight elements during task execution for better visibility.
+
+          model: The specific model to use for task completion. see our
+              [models](/agentic-browser-control/ai-task-completion#available-models) page for
+              more information.
+
           output_schema: JSON Schema defining the expected structure of the output data.
 
+          provider: The AI provider to use for task completion.
+
           url: The URL of the webpage. If not provided, the tool will use the current page in
               the session.
 
@@ -147,7 +178,11 @@ class ToolsResource(SyncAPIResource):
             body=maybe_transform(
                 {
                     "prompt": prompt,
+                    "agent": agent,
+                    "highlight_elements": highlight_elements,
+                    "model": model,
                     "output_schema": output_schema,
+                    "provider": provider,
                     "url": url,
                 },
                 tool_perform_web_task_params.ToolPerformWebTaskParams,
@@ -167,21 +202,21 @@ class ToolsResource(SyncAPIResource):
     def screenshot_webpage(
         self,
         *,
-        session_id: str | NotGiven = NOT_GIVEN,
-        capture_full_height: bool | NotGiven = NOT_GIVEN,
-        height: int | NotGiven = NOT_GIVEN,
-        image_quality: int | NotGiven = NOT_GIVEN,
-        s3_target_address: str | NotGiven = NOT_GIVEN,
-        scroll_all_content: bool | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
-        wait: int | NotGiven = NOT_GIVEN,
-        width: int | NotGiven = NOT_GIVEN,
+        session_id: str | Omit = omit,
+        capture_full_height: bool | Omit = omit,
+        height: int | Omit = omit,
+        image_quality: int | Omit = omit,
+        s3_target_address: str | Omit = omit,
+        scroll_all_content: bool | Omit = omit,
+        url: str | Omit = omit,
+        wait: int | Omit = omit,
+        width: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> BinaryAPIResponse:
         """
         This endpoint captures a screenshot of the specified webpage using Chromium.
@@ -270,15 +305,19 @@ class AsyncToolsResource(AsyncAPIResource):
     async def fetch_webpage(
         self,
         *,
-        session_id: str | NotGiven = NOT_GIVEN,
-        format: Literal["html", "markdown"] | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
+        session_id: str | Omit = omit,
+        format: Literal["html", "markdown"] | Omit = omit,
+        new_page: bool | Omit = omit,
+        page_index: int | Omit = omit,
+        return_partial_on_timeout: bool | Omit = omit,
+        url: str | Omit = omit,
+        wait: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> str:
         """
         Retrieve the rendered content of a webpage, optionally formatted as Markdown or
@@ -290,9 +329,18 @@ class AsyncToolsResource(AsyncAPIResource):
 
           format: The output format of the content.
 
+          new_page: Whether to create a new page for the content.
+
+          page_index: The index of the page to fetch content from. **Overides new_page**.
+
+          return_partial_on_timeout: Whether to return partial content if the content is not loaded within the 20
+              seconds.
+
           url: The URL of the webpage to fetch content from. When left empty, the current
               webpage is used.
 
+          wait: The time to wait for **dynamic** content to load in **milliseconds**.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -307,7 +355,11 @@ class AsyncToolsResource(AsyncAPIResource):
             body=await async_maybe_transform(
                 {
                     "format": format,
+                    "new_page": new_page,
+                    "page_index": page_index,
+                    "return_partial_on_timeout": return_partial_on_timeout,
                     "url": url,
+                    "wait": wait,
                 },
                 tool_fetch_webpage_params.ToolFetchWebpageParams,
             ),
@@ -327,15 +379,19 @@ class AsyncToolsResource(AsyncAPIResource):
         self,
         *,
         prompt: str,
-        session_id: str | NotGiven = NOT_GIVEN,
-        output_schema: object | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
+        session_id: str | Omit = omit,
+        agent: Literal["browser-use", "openai-cua"] | Omit = omit,
+        highlight_elements: bool | Omit = omit,
+        model: str | Omit = omit,
+        output_schema: object | Omit = omit,
+        provider: Literal["openai", "gemini", "groq", "azure", "xai"] | Omit = omit,
+        url: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ToolPerformWebTaskResponse:
         """
         Start from a URL and perform the given task.
@@ -347,8 +403,18 @@ class AsyncToolsResource(AsyncAPIResource):
               sessions. When passed, the tool will be executed on the provided browser
               session.
 
+          agent: The AI agent to use for task completion. Defaults to browser-use.
+
+          highlight_elements: Whether to highlight elements during task execution for better visibility.
+
+          model: The specific model to use for task completion. see our
+              [models](/agentic-browser-control/ai-task-completion#available-models) page for
+              more information.
+
           output_schema: JSON Schema defining the expected structure of the output data.
 
+          provider: The AI provider to use for task completion.
+
           url: The URL of the webpage. If not provided, the tool will use the current page in
               the session.
 
@@ -365,7 +431,11 @@ class AsyncToolsResource(AsyncAPIResource):
             body=await async_maybe_transform(
                 {
                     "prompt": prompt,
+                    "agent": agent,
+                    "highlight_elements": highlight_elements,
+                    "model": model,
                     "output_schema": output_schema,
+                    "provider": provider,
                     "url": url,
                 },
                 tool_perform_web_task_params.ToolPerformWebTaskParams,
@@ -385,21 +455,21 @@ class AsyncToolsResource(AsyncAPIResource):
     async def screenshot_webpage(
         self,
         *,
-        session_id: str | NotGiven = NOT_GIVEN,
-        capture_full_height: bool | NotGiven = NOT_GIVEN,
-        height: int | NotGiven = NOT_GIVEN,
-        image_quality: int | NotGiven = NOT_GIVEN,
-        s3_target_address: str | NotGiven = NOT_GIVEN,
-        scroll_all_content: bool | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
-        wait: int | NotGiven = NOT_GIVEN,
-        width: int | NotGiven = NOT_GIVEN,
+        session_id: str | Omit = omit,
+        capture_full_height: bool | Omit = omit,
+        height: int | Omit = omit,
+        image_quality: int | Omit = omit,
+        s3_target_address: str | Omit = omit,
+        scroll_all_content: bool | Omit = omit,
+        url: str | Omit = omit,
+        wait: int | Omit = omit,
+        width: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AsyncBinaryAPIResponse:
         """
         This endpoint captures a screenshot of the specified webpage using Chromium.

anchorbrowser/types/__init__.py

@@ -3,17 +3,23 @@
 from __future__ import annotations
 
 from .shared import SuccessResponse as SuccessResponse
+from .task_list_params import TaskListParams as TaskListParams
 from .extension_manifest import ExtensionManifest as ExtensionManifest
+from .task_create_params import TaskCreateParams as TaskCreateParams
+from .task_list_response import TaskListResponse as TaskListResponse
+from .event_signal_params import EventSignalParams as EventSignalParams
 from .session_goto_params import SessionGotoParams as SessionGotoParams
 from .session_paste_params import SessionPasteParams as SessionPasteParams
+from .task_create_response import TaskCreateResponse as TaskCreateResponse
+from .event_wait_for_params import EventWaitForParams as EventWaitForParams
 from .profile_create_params import ProfileCreateParams as ProfileCreateParams
 from .profile_list_response import ProfileListResponse as ProfileListResponse
-from .profile_update_params import ProfileUpdateParams as ProfileUpdateParams
 from .session_copy_response import SessionCopyResponse as SessionCopyResponse
 from .session_create_params import SessionCreateParams as SessionCreateParams
 from .session_goto_response import SessionGotoResponse as SessionGotoResponse
 from .session_scroll_params import SessionScrollParams as SessionScrollParams
 from .session_paste_response import SessionPasteResponse as SessionPasteResponse
+from .event_wait_for_response import EventWaitForResponse as EventWaitForResponse
 from .extension_list_response import ExtensionListResponse as ExtensionListResponse
 from .extension_upload_params import ExtensionUploadParams as ExtensionUploadParams
 from .session_create_response import SessionCreateResponse as SessionCreateResponse
@@ -21,12 +27,19 @@ from .session_scroll_response import SessionScrollResponse as SessionScrollRespo
 from .extension_delete_response import ExtensionDeleteResponse as ExtensionDeleteResponse
 from .extension_upload_response import ExtensionUploadResponse as ExtensionUploadResponse
 from .profile_retrieve_response import ProfileRetrieveResponse as ProfileRetrieveResponse
+from .session_retrieve_response import SessionRetrieveResponse as SessionRetrieveResponse
 from .tool_fetch_webpage_params import ToolFetchWebpageParams as ToolFetchWebpageParams
+from .session_upload_file_params import SessionUploadFileParams as SessionUploadFileParams
+from .batch_session_create_params import BatchSessionCreateParams as BatchSessionCreateParams
 from .extension_retrieve_response import ExtensionRetrieveResponse as ExtensionRetrieveResponse
+from .session_list_pages_response import SessionListPagesResponse as SessionListPagesResponse
 from .tool_fetch_webpage_response import ToolFetchWebpageResponse as ToolFetchWebpageResponse
 from .session_drag_and_drop_params import SessionDragAndDropParams as SessionDragAndDropParams
+from .session_upload_file_response import SessionUploadFileResponse as SessionUploadFileResponse
 from .tool_perform_web_task_params import ToolPerformWebTaskParams as ToolPerformWebTaskParams
+from .batch_session_create_response import BatchSessionCreateResponse as BatchSessionCreateResponse
 from .session_drag_and_drop_response import SessionDragAndDropResponse as SessionDragAndDropResponse
 from .tool_perform_web_task_response import ToolPerformWebTaskResponse as ToolPerformWebTaskResponse
 from .tool_screenshot_webpage_params import ToolScreenshotWebpageParams as ToolScreenshotWebpageParams
+from .batch_session_retrieve_response import BatchSessionRetrieveResponse as BatchSessionRetrieveResponse
 from .session_retrieve_downloads_response import SessionRetrieveDownloadsResponse as SessionRetrieveDownloadsResponse