Merge pull request #244 from askui/feat/max_steps

Adds max_steps parameter to stop the execution after a predefined number of steps

Author: philipph-askui

docs/11_callbacks.md

@@ -2,6 +2,8 @@
 
 Callbacks provide hooks into the agent's conversation lifecycle, similar to PyTorch Lightning's callback system. Use them for logging, monitoring, custom metrics, or extending agent behavior.
 
+All callbacks live in `askui.callbacks` and can be imported from there.
+
 ## Usage
 
 Subclass `ConversationCallback` and override the hooks you need:
@@ -71,6 +73,10 @@ with ComputerAgent(callbacks=[TimingCallback()]) as agent:
     agent.act("Search for documents")
 ```
 
+## Built-in Callbacks
+
+(we will add built-in callbacks at a later stage)
+
 ## Multiple Callbacks
 
 Pass multiple callbacks to combine behaviors:

src/askui/__init__.py

@@ -9,6 +9,7 @@
 
 from .agent_base import Agent
 from .agent_settings import AgentSettings
+from .callbacks import ConversationCallback
 from .computer_agent import ComputerAgent, VisionAgent
 from .locators import Locator
 from .models import (
@@ -30,7 +31,6 @@
     ToolUseBlockParam,
     UrlImageSourceParam,
 )
-from .models.shared.conversation_callback import ConversationCallback
 from .models.shared.settings import (
     DEFAULT_GET_RESOLUTION,
     DEFAULT_LOCATE_RESOLUTION,

src/askui/agent_base.py

@@ -10,11 +10,11 @@
 from typing_extensions import Self
 
 from askui.agent_settings import AgentSettings
+from askui.callbacks import ConversationCallback, UsageTrackingCallback
 from askui.container import telemetry
 from askui.locators.locators import Locator
 from askui.models.shared.agent_message_param import MessageParam
 from askui.models.shared.conversation import Conversation, Speakers
-from askui.models.shared.conversation_callback import ConversationCallback
 from askui.models.shared.settings import (
     ActSettings,
     CacheWritingSettings,
@@ -23,7 +23,6 @@
     LocateSettings,
 )
 from askui.models.shared.tools import Tool, ToolCollection
-from askui.models.shared.usage_tracking_callback import UsageTrackingCallback
 from askui.prompts.act_prompts import CACHE_USE_PROMPT, create_default_prompt
 from askui.telemetry.otel import OtelSettings, setup_opentelemetry_tracing
 from askui.tools.agent_os import AgentOs

src/askui/android_agent.py

@@ -6,10 +6,10 @@
 
 from askui.agent_base import Agent
 from askui.agent_settings import AgentSettings
+from askui.callbacks import ConversationCallback
 from askui.container import telemetry
 from askui.locators.locators import Locator
 from askui.models.models import Point
-from askui.models.shared.conversation_callback import ConversationCallback
 from askui.models.shared.settings import ActSettings, MessageSettings
 from askui.models.shared.tools import Tool
 from askui.prompts.act_prompts import create_android_agent_prompt

src/askui/callbacks/__init__.py

@@ -0,0 +1,7 @@
+from .conversation_callback import ConversationCallback
+from .usage_tracking_callback import UsageTrackingCallback
+
+__all__ = [
+    "ConversationCallback",
+    "UsageTrackingCallback",
+]

…i/models/shared/conversation_callback.py …askui/callbacks/conversation_callback.pysrc/askui/models/shared/conversation_callback.py renamed to src/askui/callbacks/conversation_callback.py src/askui/models/shared/conversation_callback.py renamed to src/askui/callbacks/conversation_callback.py

@@ -8,7 +8,7 @@
 from pydantic import BaseModel
 from typing_extensions import override
 
-from askui.models.shared.conversation_callback import ConversationCallback
+from askui.callbacks.conversation_callback import ConversationCallback
 from askui.reporting import NULL_REPORTER
 
 if TYPE_CHECKING:

…models/shared/usage_tracking_callback.py …kui/callbacks/usage_tracking_callback.pysrc/askui/models/shared/usage_tracking_callback.py renamed to src/askui/callbacks/usage_tracking_callback.py src/askui/models/shared/usage_tracking_callback.py renamed to src/askui/callbacks/usage_tracking_callback.py

@@ -6,10 +6,10 @@
 
 from askui.agent_base import Agent
 from askui.agent_settings import AgentSettings
+from askui.callbacks import ConversationCallback
 from askui.container import telemetry
 from askui.locators.locators import Locator
 from askui.models.models import Point
-from askui.models.shared.conversation_callback import ConversationCallback
 from askui.models.shared.settings import ActSettings, LocateSettings, MessageSettings
 from askui.models.shared.tools import Tool
 from askui.prompts.act_prompts import (

src/askui/computer_agent.py

@@ -22,7 +22,7 @@
 from askui.tools.switch_speaker_tool import SwitchSpeakerTool
 
 if TYPE_CHECKING:
-    from askui.models.shared.conversation_callback import ConversationCallback
+    from askui.callbacks import ConversationCallback
     from askui.utils.caching.cache_manager import CacheManager
 
 logger = logging.getLogger(__name__)
@@ -208,8 +208,21 @@ def _execute_control_loop(self) -> None:
         continue_execution = True
         while continue_execution:
             continue_execution = self._execute_step()
+            if self._is_max_steps_reached():
+                continue_execution = False
         self._on_control_loop_end()
 
+    def _is_max_steps_reached(self) -> bool:
+        if self.settings.max_steps is None:
+            return False
+        if self._step_index >= self.settings.max_steps:
+            msg = (
+                f"Reached max_steps limit {self.settings.max_steps}, stopping execution"
+            )
+            logger.exception(msg)
+            return True
+        return False
+
     @tracer.start_as_current_span("_teardown_control_loop")
     def _teardown_control_loop(self) -> None:
         # Finish recording if cache_manager is active and not executing from cache

src/askui/models/shared/conversation.py

@@ -89,6 +89,7 @@ class ActSettings(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
     messages: MessageSettings = Field(default_factory=MessageSettings)
+    max_steps: int | None = None
 
 
 class GetSettings(BaseModel):