lm-deluge 0.0.67__py3-none-any.whl → 0.0.88__py3-none-any.whl

lm_deluge/tool/builtin/anthropic/__init__.py

@@ -0,0 +1,300 @@
+from typing import Literal
+
+# Tool version identifiers corresponding to Anthropic's versioned tools
+# - 2024-10-22: Claude 3.5/3.6 (original computer use)
+# - 2025-01-24: Claude Sonnet 3.7 and Claude 4 models
+# - 2025-11-24: Claude Opus 4.5 (adds zoom action)
+ToolVersion = Literal["2024-10-22", "2025-01-24", "2025-11-24"]
+ToolType = Literal["bash", "computer", "editor"]
+
+
+def model_to_version(model: str) -> ToolVersion:
+    """
+    Determine the appropriate tool version for a given model.
+
+    Model compatibility:
+    - Claude Opus 4.5 (claude-opus-4-5-*): Uses 2025-11-24 tools with zoom support
+    - Claude 4 models (claude-4-*, claude-sonnet-4-*, claude-opus-4-*, etc.): Uses 2025-01-24 tools
+    - Claude Sonnet 3.7 (deprecated): Uses 2025-01-24 tools
+    - Claude 3.5/3.6: Uses 2024-10-22 tools
+    """
+    model_lower = model.lower()
+
+    # Check for valid model families
+    if not any(x in model_lower for x in ["opus", "sonnet", "haiku"]):
+        raise ValueError(
+            f"Cannot use computer tools with model '{model}'. "
+            "Computer use requires Claude Opus, Sonnet, or Haiku models."
+        )
+
+    # Claude Opus 4.5 - newest tool version with zoom support
+    # Matches: claude-opus-4-5-*, claude-4.5-opus, etc.
+    if (
+        "opus-4-5" in model_lower
+        or "opus-4.5" in model_lower
+        or "4.5-opus" in model_lower
+    ):
+        return "2025-11-24"
+
+    # Claude 4 models (Sonnet 4.5, Opus 4, Sonnet 4, Haiku 4.5, etc.)
+    # Matches aliases like claude-4-sonnet, claude-4.5-sonnet
+    # and full names like claude-sonnet-4-20250514, claude-sonnet-4-5-20250929
+    claude_4_patterns = [
+        "claude-4",  # alias prefix: claude-4-sonnet, claude-4-opus
+        "4.5-sonnet",  # alias: claude-4.5-sonnet
+        "4.5-haiku",  # alias: claude-4.5-haiku
+        "sonnet-4-5",  # full name: claude-sonnet-4-5-*
+        "sonnet-4-",  # full name: claude-sonnet-4-* (note trailing dash to avoid matching 3-5)
+        "opus-4-",  # full name: claude-opus-4-* (but not opus-4-5 handled above)
+        "haiku-4-5",  # full name: claude-haiku-4-5-*
+    ]
+    if any(p in model_lower for p in claude_4_patterns):
+        return "2025-01-24"
+
+    # Claude Sonnet 3.7 (deprecated but still supported)
+    if "3.7" in model_lower or "3-7" in model_lower:
+        return "2025-01-24"
+
+    # Claude 3.5/3.6 (older models)
+    if any(x in model_lower for x in ["3.5", "3-5", "3.6", "3-6"]):
+        return "2024-10-22"
+
+    raise ValueError(
+        f"Unsupported model '{model}' for Anthropic computer use. "
+        "Supported: Claude Opus 4.5, Claude 4 models, Sonnet 3.7, or 3.5/3.6."
+    )
+
+
+def get_beta_header(model: str) -> str:
+    """
+    Get the appropriate beta header for computer use with the given model.
+
+    Returns:
+        Beta header string to use in the API request.
+    """
+    version = model_to_version(model)
+
+    if version == "2025-11-24":
+        return "computer-use-2025-11-24"
+    elif version == "2025-01-24":
+        return "computer-use-2025-01-24"
+    else:  # 2024-10-22
+        return "computer-use-2024-10-22"
+
+
+def get_anthropic_cu_tools(
+    model: str,
+    display_width: int = 1024,
+    display_height: int = 768,
+    exclude_tools: list[ToolType] | None = None,
+    enable_zoom: bool = False,
+) -> list[dict]:
+    """
+    Get the computer use tools for the given model.
+
+    Args:
+        model: The model name (e.g., "claude-opus-4-5-20251124", "claude-4-sonnet")
+        display_width: Display width in pixels (recommended <= 1280)
+        display_height: Display height in pixels (recommended <= 800)
+        exclude_tools: List of tool types to exclude ("bash", "computer", "editor")
+        enable_zoom: Enable zoom action for Opus 4.5 (computer_20251124 only)
+
+    Returns:
+        List of tool definitions for the Anthropic API.
+
+    Note:
+        Keep display resolution at or below 1280x800 (WXGA) for best performance.
+        Higher resolutions may cause accuracy issues due to image resizing.
+    """
+    version = model_to_version(model)
+
+    if version == "2024-10-22":
+        # Claude 3.5/3.6 - original computer use
+        result = [
+            {
+                "name": "computer",
+                "type": "computer_20241022",
+                "display_width_px": display_width,
+                "display_height_px": display_height,
+                "display_number": None,
+            },
+            {"name": "str_replace_editor", "type": "text_editor_20241022"},
+            {"name": "bash", "type": "bash_20241022"},
+        ]
+    elif version == "2025-01-24":
+        # Claude 4 models and Sonnet 3.7
+        # Uses computer_20250124 and text_editor_20250728
+        result = [
+            {
+                "name": "computer",
+                "type": "computer_20250124",
+                "display_width_px": display_width,
+                "display_height_px": display_height,
+                "display_number": None,
+            },
+            {"name": "str_replace_based_edit_tool", "type": "text_editor_20250728"},
+            {"name": "bash", "type": "bash_20250124"},
+        ]
+    elif version == "2025-11-24":
+        # Claude Opus 4.5 - newest with zoom support
+        computer_tool: dict = {
+            "name": "computer",
+            "type": "computer_20251124",
+            "display_width_px": display_width,
+            "display_height_px": display_height,
+            "display_number": None,
+        }
+        # Enable zoom action if requested (allows Claude to zoom into screen regions)
+        if enable_zoom:
+            computer_tool["enable_zoom"] = True
+
+        result = [
+            computer_tool,
+            {"name": "str_replace_based_edit_tool", "type": "text_editor_20250728"},
+            {"name": "bash", "type": "bash_20250124"},
+        ]
+    else:
+        raise ValueError(f"Invalid tool version: {version}")
+
+    if exclude_tools is None:
+        return result
+
+    if "bash" in exclude_tools:
+        result = [x for x in result if x["name"] != "bash"]
+    if "editor" in exclude_tools:
+        result = [x for x in result if "edit" not in x["name"]]
+    if "computer" in exclude_tools:
+        result = [x for x in result if x["name"] != "computer"]
+
+    return result
+
+
+def bash_tool(model: str = "claude-4-sonnet") -> dict:
+    """
+    Get the bash tool definition for the given model.
+
+    The bash tool allows Claude to execute shell commands.
+
+    Note: Claude 3.5 requires the computer-use-2024-10-22 beta header.
+    The bash tool is generally available in Claude 4 and Sonnet 3.7.
+    """
+    version = model_to_version(model)
+
+    if version in ("2025-11-24", "2025-01-24"):
+        return {"type": "bash_20250124", "name": "bash"}
+    else:  # 2024-10-22
+        return {"type": "bash_20241022", "name": "bash"}
+
+
+def text_editor_tool(model: str = "claude-4-sonnet") -> dict:
+    """
+    Get the text editor tool definition for the given model.
+
+    The text editor tool allows Claude to view, create, and edit files.
+
+    Note:
+    - Claude 4 and Opus 4.5 use text_editor_20250728 with name "str_replace_based_edit_tool"
+      (no undo_edit command, has optional max_characters parameter)
+    - Claude Sonnet 3.7 uses text_editor_20250124 with name "str_replace_editor"
+      (includes undo_edit command)
+    - Claude 3.5/3.6 uses text_editor_20241022 with name "str_replace_editor"
+    """
+    version = model_to_version(model)
+
+    if version in ("2025-11-24", "2025-01-24"):
+        return {"type": "text_editor_20250728", "name": "str_replace_based_edit_tool"}
+    else:  # 2024-10-22
+        return {"type": "text_editor_20241022", "name": "str_replace_editor"}
+
+
+def computer_tool(
+    model: str = "claude-4-sonnet",
+    display_width: int = 1024,
+    display_height: int = 768,
+    enable_zoom: bool = False,
+) -> dict:
+    """
+    Get the computer use tool definition for the given model.
+
+    The computer tool allows Claude to see and control desktop environments
+    through screenshots and mouse/keyboard actions.
+
+    Args:
+        model: The model name
+        display_width: Display width in pixels (recommended <= 1280)
+        display_height: Display height in pixels (recommended <= 800)
+        enable_zoom: Enable zoom action (Opus 4.5 only). When enabled, Claude can
+            use the zoom action to view specific screen regions at full resolution.
+
+    Available actions by version:
+    - All versions: screenshot, left_click, type, key, mouse_move
+    - computer_20250124+: scroll, left_click_drag, right_click, middle_click,
+      double_click, triple_click, left_mouse_down, left_mouse_up, hold_key, wait
+    - computer_20251124 (Opus 4.5): All above + zoom (requires enable_zoom=True)
+    """
+    version = model_to_version(model)
+
+    if version == "2025-11-24":
+        tool: dict = {
+            "name": "computer",
+            "type": "computer_20251124",
+            "display_width_px": display_width,
+            "display_height_px": display_height,
+            "display_number": None,
+        }
+        if enable_zoom:
+            tool["enable_zoom"] = True
+        return tool
+    elif version == "2025-01-24":
+        return {
+            "name": "computer",
+            "type": "computer_20250124",
+            "display_width_px": display_width,
+            "display_height_px": display_height,
+            "display_number": None,
+        }
+    else:  # 2024-10-22
+        return {
+            "name": "computer",
+            "type": "computer_20241022",
+            "display_width_px": display_width,
+            "display_height_px": display_height,
+            "display_number": None,
+        }
+
+
+def web_search_tool(
+    max_uses: int = 5,
+    allowed_domains: list[str] | None = None,
+    blocked_domains: list[str] | None = None,
+) -> dict:
+    """
+    Get the web search tool definition.
+
+    Args:
+        max_uses: Maximum number of searches per request (default: 5)
+        allowed_domains: Only include results from these domains
+        blocked_domains: Never include results from these domains
+
+    Note: You can use either allowed_domains or blocked_domains, but not both.
+    """
+    res: dict = {
+        "type": "web_search_20250305",
+        "name": "web_search",
+        "max_uses": max_uses,
+    }
+    if allowed_domains:
+        res["allowed_domains"] = allowed_domains
+    if blocked_domains:
+        res["blocked_domains"] = blocked_domains
+    return res
+
+
+def code_execution_tool() -> dict:
+    """
+    Get the code execution tool definition.
+
+    The code execution tool is currently in beta.
+    This feature requires the beta header: "anthropic-beta": "code-execution-2025-05-22"
+    """
+    return {"type": "code_execution_20250522", "name": "code_execution"}

lm_deluge/tool/builtin/gemini.py

@@ -0,0 +1,59 @@
+"""
+Gemini built-in tools including computer use.
+
+Gemini computer use works differently from OpenAI/Anthropic:
+- Uses a special ComputerUse tool type in the API request
+- Returns actions as regular function_call objects
+- Uses normalized coordinates (0-999) that must be denormalized
+- Function responses include screenshots as FunctionResponsePart
+"""
+
+from typing import Literal
+
+
+def computer_use_gemini(
+    environment: Literal["browser", "android"] = "browser",
+    excluded_functions: list[str] | None = None,
+) -> dict:
+    """
+    Create a Gemini computer use tool configuration.
+
+    This returns a dict that will be specially handled when building
+    the Gemini API request.
+
+    Args:
+        environment: The environment type - "browser" or "android"
+        excluded_functions: List of predefined function names to exclude.
+            Available functions:
+            - open_web_browser, wait_5_seconds, go_back, go_forward
+            - search, navigate, click_at, hover_at, type_text_at
+            - key_combination, scroll_document, scroll_at, drag_and_drop
+
+    Returns:
+        A dict that will be converted to ComputerUse tool config
+    """
+    result: dict[str, str | list[str]] = {
+        "type": "gemini_computer_use",
+        "environment": environment,
+    }
+    if excluded_functions:
+        result["excluded_predefined_functions"] = excluded_functions
+    return result
+
+
+# Constants for Gemini computer use action names
+GEMINI_CU_ACTIONS = [
+    "open_web_browser",
+    "wait_5_seconds",
+    "go_back",
+    "go_forward",
+    "search",
+    "navigate",
+    "click_at",
+    "hover_at",
+    "type_text_at",
+    "key_combination",
+    "scroll_document",
+    "scroll_at",
+    "drag_and_drop",
+]

lm_deluge/tool/builtin/openai.py

@@ -0,0 +1,74 @@
+def image_generation_openai():
+    # TODO: handle result properly
+    return {"type": "image_generation"}
+
+
+def code_interpreter_openai(container: dict | None = None):
+    if container is None:
+        container = {"type": "auto"}
+    return {"type": "code_interpreter", "container": container}
+
+
+def local_shell_openai():
+    return {"type": "local_shell"}
+
+
+def web_search_openai(
+    preview: bool = False,
+    user_location: dict | None = None,
+    allowed_domains: list[str] | None = None,
+    search_context_size: str | None = None,
+):
+    """OpenAI's built-in web search tool for the Responses API.
+
+    Args:
+        preview: If True, use web_search_preview. If False (default), use
+            the GA web_search tool.
+        user_location: Optional approximate user location to refine search results.
+            Should be a dict with "type": "approximate" and an "approximate" key
+            containing any of: country (ISO code), city, region, timezone.
+            Note: Not supported for deep research models.
+        allowed_domains: Optional list of domains to restrict search results to.
+            Up to 100 URLs, without http/https prefix (e.g. "openai.com").
+            Only available with web_search (not preview).
+        search_context_size: Controls how much context from web search results
+            is provided to the model. Options: "low", "medium" (default), "high".
+            Higher values use more tokens but may improve response quality.
+
+    Returns:
+        A dict representing the web search tool configuration.
+    """
+    tool: dict = {}
+    if preview:
+        tool["type"] = "web_search_preview"
+        if user_location:
+            tool["user_location"] = user_location
+        if search_context_size:
+            tool["search_context_size"] = search_context_size
+        return tool
+
+    # GA web_search tool
+    tool["type"] = "web_search"
+
+    if user_location:
+        tool["user_location"] = user_location
+
+    if search_context_size:
+        tool["search_context_size"] = search_context_size
+
+    # Domain filtering uses a nested filters structure
+    if allowed_domains:
+        tool["filters"] = {"allowed_domains": allowed_domains}
+
+    return tool
+
+
+def computer_use_openai(
+    display_width: int = 1024, display_height: int = 768, environment: str = "browser"
+):
+    return {
+        "type": "computer_use_preview",
+        "display_width": display_width,
+        "display_height": display_height,
+        "environment": environment,
+    }

lm_deluge/tool/cua/__init__.py

@@ -0,0 +1,173 @@
+"""
+Computer Use Actions (CUA) module.
+
+This module provides a provider-agnostic abstraction for computer use actions
+and executors that can run them on various backends.
+
+Key components:
+- CUAction: Union type of all possible computer use actions
+- ComputerExecutor: Abstract base class for action executors
+- KernelExecutor: Execute actions on Kernel's browser-as-a-service
+- TryCUAExecutor: Execute actions on TryCUA's computer-server (desktop control)
+
+Usage with Kernel (browser):
+    from lm_deluge.tool.cua import (
+        KernelBrowser,
+        KernelExecutor,
+        anthropic_tool_call_to_action,
+    )
+
+    # Create a browser and executor
+    with KernelBrowser() as browser:
+        executor = KernelExecutor(browser.session_id)
+
+        # Convert Anthropic tool call to action
+        action = anthropic_tool_call_to_action(tool_call.arguments)
+
+        # Execute and get result
+        result = executor.execute(action)
+
+Usage with TryCUA (desktop):
+    from lm_deluge.tool.cua import (
+        TryCUAConnection,
+        TryCUAExecutor,
+        Screenshot,
+        Click,
+        Type,
+    )
+
+    # Connect to a TryCUA computer-server
+    with TryCUAConnection("ws://localhost:8000/ws") as conn:
+        executor = TryCUAExecutor(conn)
+
+        # Execute actions
+        result = executor.execute(Screenshot(kind="screenshot"))
+        executor.execute(Click(kind="click", x=100, y=200, button="left"))
+        executor.execute(Type(kind="type", text="Hello!"))
+
+    # Async version
+    async with AsyncTryCUAConnection("ws://localhost:8000/ws") as conn:
+        executor = AsyncTryCUAExecutor(conn)
+        result = await executor.execute(Screenshot(kind="screenshot"))
+"""
+
+from .actions import (
+    Bash,
+    Click,
+    CUAction,
+    CursorPos,
+    DoubleClick,
+    Drag,
+    Edit,
+    GoBack,
+    GoForward,
+    HoldKey,
+    Keypress,
+    MouseDown,
+    MouseUp,
+    Move,
+    Navigate,
+    Scroll,
+    Screenshot,
+    Search,
+    TripleClick,
+    Type,
+    Wait,
+)
+from .base import ComputerExecutor, CUActionResult
+from .base import Screenshot as ScreenshotResult
+from .converters import (
+    anthropic_tool_call_to_action,
+    openai_computer_call_to_action,
+    gemini_function_call_to_action,
+)
+from .batch import create_computer_batch_tool
+
+
+# Lazy imports for optional dependencies
+def __getattr__(name: str):
+    if name in (
+        "KernelBrowser",
+        "KernelExecutor",
+        "AsyncKernelBrowser",
+        "AsyncKernelExecutor",
+    ):
+        from .kernel import (
+            KernelBrowser,
+            KernelExecutor,
+            AsyncKernelBrowser,
+            AsyncKernelExecutor,
+        )
+
+        return {
+            "KernelBrowser": KernelBrowser,
+            "KernelExecutor": KernelExecutor,
+            "AsyncKernelBrowser": AsyncKernelBrowser,
+            "AsyncKernelExecutor": AsyncKernelExecutor,
+        }[name]
+    if name in (
+        "TryCUAConnection",
+        "TryCUAExecutor",
+        "AsyncTryCUAConnection",
+        "AsyncTryCUAExecutor",
+    ):
+        from .trycua import (
+            TryCUAConnection,
+            TryCUAExecutor,
+            AsyncTryCUAConnection,
+            AsyncTryCUAExecutor,
+        )
+
+        return {
+            "TryCUAConnection": TryCUAConnection,
+            "TryCUAExecutor": TryCUAExecutor,
+            "AsyncTryCUAConnection": AsyncTryCUAConnection,
+            "AsyncTryCUAExecutor": AsyncTryCUAExecutor,
+        }[name]
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+__all__ = [
+    # Actions
+    "CUAction",
+    "Click",
+    "DoubleClick",
+    "TripleClick",
+    "Move",
+    "Drag",
+    "Scroll",
+    "Keypress",
+    "Type",
+    "Wait",
+    "Screenshot",
+    "MouseDown",
+    "MouseUp",
+    "CursorPos",
+    "HoldKey",
+    "Navigate",
+    "GoBack",
+    "GoForward",
+    "Search",
+    "Bash",
+    "Edit",
+    # Base classes
+    "ComputerExecutor",
+    "CUActionResult",
+    "ScreenshotResult",
+    # Converters
+    "anthropic_tool_call_to_action",
+    "openai_computer_call_to_action",
+    "gemini_function_call_to_action",
+    # Batch tool
+    "create_computer_batch_tool",
+    # Kernel executor (lazy loaded)
+    "KernelBrowser",  # pyright: ignore[reportUnsupportedDunderAll]
+    "KernelExecutor",  # pyright: ignore[reportUnsupportedDunderAll]
+    "AsyncKernelBrowser",  # pyright: ignore[reportUnsupportedDunderAll]
+    "AsyncKernelExecutor",  # pyright: ignore[reportUnsupportedDunderAll]
+    # TryCUA executor (lazy loaded)
+    "TryCUAConnection",  # pyright: ignore[reportUnsupportedDunderAll]
+    "TryCUAExecutor",  # pyright: ignore[reportUnsupportedDunderAll]
+    "AsyncTryCUAConnection",  # pyright: ignore[reportUnsupportedDunderAll]
+    "AsyncTryCUAExecutor",  # pyright: ignore[reportUnsupportedDunderAll]
+]