Merge branch 'main' into chore/act_conversation_with_caching

Author: philipph-askui

docs/00_overview.md

@@ -1,5 +1,8 @@
 # Overview
 
+This documentation is intended for **developers** that want build custom implementation with this SDK.
+For tutorials, how-to-guides, and more ressources please visit our user documentation [here](https://docs.askui.com/).
+
 ## Why AskUI Vision Agent?
 
 AskUI Vision Agent is a powerful automation framework that bridges the gap between human intent and computer control. Whether you need precise UI automation for testing, want AI agents to handle complex workflows, or need to automate tasks across desktop, mobile, and HMI devices, AskUI Vision Agent provides a unified solution.

examples/model_providers.py

@@ -35,9 +35,7 @@ def try_act(agent: ComputerAgent, provider_name: str) -> None:
     """Test the act() method with a simple goal."""
     logger.info(f"Testing act() with {provider_name}")
     agent.act(
-        goal=(
-            "Open a new Chrome window and navigate to askui.com. "
-        ),
+        goal=("Open a new Chrome window and navigate to askui.com. "),
     )
 
 
@@ -116,19 +114,19 @@ def create_mixed_providers() -> AgentSettings:
 if __name__ == "__main__":
     # Define which provider configurations to test
     provider_configs = {
-        #"AskUI (default)": create_askui_providers,
-        #"Anthropic (direct)": create_anthropic_providers,
-        #"Google (Gemini)": create_google_providers,
+        # "AskUI (default)": create_askui_providers,
+        # "Anthropic (direct)": create_anthropic_providers,
+        # "Google (Gemini)": create_google_providers,
         "Mixed providers": create_mixed_providers,
     }
 
     # Select which configuration to run (change this to test different providers)
     selected_config = "AskUI (default)"
 
     for selected_config in provider_configs.keys():
-        logger.info("#"*60)
+        logger.info("#" * 60)
         logger.info(f"Running with provider configuration: {selected_config}")
-        logger.info("#"*60)
+        logger.info("#" * 60)
         settings = provider_configs[selected_config]()
 
         with ComputerAgent(settings=settings, display=1) as agent:

pyproject.toml

@@ -13,6 +13,7 @@ dependencies = [
     "httpx>=0.28.1",
     "Jinja2>=3.1.4",
     "openai>=1.61.1",
+    "opentelemetry-sdk>=1.38.0",
     "pillow>=11.0.0",
     "py-machineid>=0.7.0",
     "pydantic-settings>=2.9.1",
@@ -224,7 +225,7 @@ bedrock = [
 ]
 otel = [
     "prometheus-fastapi-instrumentator>=7.1.0",
-    "opentelemetry-sdk>=1.38.0",
+    "opentelemetry-api>=1.38.0",
     "opentelemetry-instrumentation-fastapi>=0.59b0",
     "opentelemetry-exporter-otlp-proto-http>=1.38.0",
     "opentelemetry-instrumentation-httpx>=0.59b0",

src/askui/__init__.py

@@ -1,6 +1,6 @@
 """AskUI Python SDK"""
 
-__version__ = "0.23.1"
+__version__ = "0.24.0"
 
 import logging
 import os

src/askui/agent_base.py

@@ -103,8 +103,9 @@ def __init__(
             self.act_tool_collection.add_agent_os(agent_os)
 
         # Add provider-based tools to the act loop
-        self.act_tool_collection.append_tool(self._get_tool)
-        self.act_tool_collection.append_tool(self._locate_tool)
+        if self._agent_os is not None:
+            self.act_tool_collection.append_tool(self._get_tool)
+            self.act_tool_collection.append_tool(self._locate_tool)
 
         # Settings stored at agent level (mutable)
         self.act_settings = ActSettings()

src/askui/models/openrouter/get_model.py

@@ -178,11 +178,7 @@ def get(
             raise NotImplementedError(err_msg)
 
         # Use system prompt from settings if provided, otherwise use default
-        system_prompt = (
-            get_settings.system_prompt
-            if get_settings.system_prompt
-            else SYSTEM_PROMPT_GET
-        )
+        system_prompt = get_settings.system_prompt or SYSTEM_PROMPT_GET
 
         response = self._predict(
             image_url=source.to_data_url(),

src/askui/telemetry/otel.py

@@ -1,5 +1,8 @@
 from fastapi import FastAPI
 from opentelemetry import trace
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
 from pydantic import BaseModel, Field, SecretStr, model_validator
 from typing_extensions import Self
 
@@ -57,15 +60,6 @@ def setup_opentelemetry_tracing(app: FastAPI, settings: OtelSettings) -> None:
         from opentelemetry.instrumentation.sqlalchemy import (  # type: ignore[import-not-found]
             SQLAlchemyInstrumentor,
         )
-        from opentelemetry.sdk.resources import (  # type: ignore[import-not-found]
-            Resource,
-        )
-        from opentelemetry.sdk.trace import (  # type: ignore[import-not-found]
-            TracerProvider,
-        )
-        from opentelemetry.sdk.trace.export import (  # type: ignore[import-not-found]
-            BatchSpanProcessor,
-        )
     except ImportError:
         return
 

src/askui/tools/askui/askui_controller.py

@@ -1052,7 +1052,7 @@ def _send_command(self, command: Command) -> AskUIAgentOSSendResponseSchema:
             )
         except grpc.RpcError as e:
             if e.code() == grpc.StatusCode.INVALID_ARGUMENT:
-                details = e.details() if e.details() else None
+                details = e.details() or None
                 raise AskUiControllerInvalidCommandError(details) from e
             raise
 

src/askui/utils/not_given.py

@@ -1,4 +1,4 @@
-from typing import Any, ClassVar
+from typing import Any, ClassVar, final
 from uuid import uuid4
 
 from pydantic import (
@@ -7,8 +7,10 @@
     SerializerFunctionWrapHandler,
     model_serializer,
 )
+from typing_extensions import Self
 
 
+@final  # Ensures Self resolves to NotGiven in __new__, fixing mypy return-type check
 class NotGiven(BaseModel):
     """
     A sentinel value that represents a value that is not given.
@@ -19,7 +21,7 @@ class NotGiven(BaseModel):
     _uuid: ClassVar[str] = str(uuid4())
     _instance: ClassVar["NotGiven | None"] = None
 
-    def __new__(cls) -> "NotGiven":
+    def __new__(cls) -> Self:
         if cls._instance is None:
             cls._instance = super().__new__(cls)
         return cls._instance