chore: change name of caching strategy both to auto

Author: philipph-askui

docs/06_caching.md

@@ -13,7 +13,7 @@ The caching mechanism supports three strategies, configured via the `caching_set
 - **`None`** (default): No caching is used. The agent executes normally without recording or replaying actions.
 - **`"record"`**: Records all agent actions to a cache file for future replay.
 - **`"execute"`**: Provides tools to the agent to list and execute previously cached trajectories.
-- **`"both"`**: Combines execute and record modes - the agent can use existing cached trajectories and will also record new ones.
+- **`"auto"`**: Combines execute and record modes - the agent can use existing cached trajectories and will also record new ones.
 
 ## Configuration
 
@@ -23,7 +23,7 @@ Caching is configured using the `CachingSettings` class:
 from askui.models.shared.settings import CachingSettings, CachedExecutionToolSettings
 
 caching_settings = CachingSettings(
-    strategy="record",       # One of: "execute", "record", "both", or None
+    strategy="record",       # One of: "execute", "record", "auto", or None
     cache_dir=".cache",      # Directory to store cache files
     filename="my_test.json", # Filename for the cache file (optional for record mode)
     execute_cached_trajectory_tool_settings=CachedExecutionToolSettings(
@@ -34,7 +34,7 @@ caching_settings = CachingSettings(
 
 ### Parameters
 
-- **`strategy`**: The caching strategy to use (`"execute"`, `"record"`, `"both"`, or `None`).
+- **`strategy`**: The caching strategy to use (`"execute"`, `"record"`, `"auto"`, or `None`).
 - **`cache_dir`**: Directory where cache files are stored. Defaults to `".cache"`.
 - **`filename`**: Name of the cache file to write to or read from. If not specified in record mode, a timestamped filename will be generated automatically (format: `cached_trajectory_YYYYMMDDHHMMSSffffff.json`).
 - **`execute_cached_trajectory_tool_settings`**: Configuration for the trajectory execution tool (optional). See [Execution Settings](#execution-settings) below.
@@ -73,7 +73,7 @@ with ComputerAgent() as agent:
     agent.act(
         goal="Fill out the login form with username 'admin' and password 'secret123'",
         caching_settings=CachingSettings(
-            strategy="record", # you could also use "both" here
+            strategy="record", # you could also use "auto" here
             cache_dir=".cache",
             filename="login_test.json"
         )
@@ -94,7 +94,7 @@ with ComputerAgent() as agent:
     agent.act(
         goal="Fill out the login form",
         caching_settings=CachingSettings(
-            strategy="execute", # you could also use "both" here
+            strategy="execute", # you could also use "auto" here
             cache_dir=".cache"
         )
     )
@@ -109,7 +109,7 @@ The agent will automatically check if a relevant cached trajectory exists and us
 
 ### Referencing Cache Files in Goal Prompts
 
-When using `strategy="execute"` or `strategy="both"`, **you need to inform the agent about which cache files are available and when to use them**. This is done by including cache file information directly in your goal prompt.
+When using `strategy="execute"` or `strategy="auto"`, **you need to inform the agent about which cache files are available and when to use them**. This is done by including cache file information directly in your goal prompt.
 
 #### Explicit Cache File References
 
@@ -233,7 +233,7 @@ This is particularly useful when:
 - UI elements take time to become interactive after appearing
 - You're testing on slower hardware or environments
 
-### Using Both Strategies
+### Using Auto Strategy
 
 Enable both reading and writing simultaneously:
 
@@ -245,7 +245,7 @@ with ComputerAgent() as agent:
     agent.act(
         goal="Complete the checkout process",
         caching_settings=CachingSettings(
-            strategy="both",
+            strategy="auto",
             cache_dir=".cache",
             filename="checkout_test.json"
         )
@@ -323,7 +323,7 @@ The delay between actions can be customized using `CachedExecutionToolSettings`
 ## Limitations
 
 - **UI State Sensitivity**: Cached trajectories assume the UI is in the same state as when they were recorded. If the UI has changed, the replay may fail or produce incorrect results.
-- **No on_message Callback**: When using `strategy="record"` or `strategy="both"`, you cannot provide a custom `on_message` callback, as the caching system uses this callback to record actions.
+- **No on_message Callback**: When using `strategy="record"` or `strategy="auto"`, you cannot provide a custom `on_message` callback, as the caching system uses this callback to record actions.
 - **Verification Required**: After executing a cached trajectory, the agent should verify that the results are correct, as UI changes may cause partial failures.
 
 ## Example: Complete Test Workflow

src/askui/agent_base.py

@@ -142,7 +142,7 @@ def act(
                 for the act execution. Controls recording and replaying of action
                 sequences (trajectories). Available strategies: None (default, no
                 caching), "record" (record actions to cache file), "execute" (replay
-                from cached trajectories), "both" (execute and record). Defaults to
+                from cached trajectories), "auto" (execute and record). Defaults to
                 no caching.
 
         Returns:
@@ -208,7 +208,7 @@ def act(
                 agent.act(
                     goal="Complete the checkout process",
                     caching_settings=CachingSettings(
-                        strategy="both",
+                        strategy="auto",
                         cache_dir=".cache",
                         filename="checkout.json"
                     )
@@ -281,7 +281,7 @@ def _patch_act_with_cache(
         cache_manager: CacheManager | None = None
 
         # Setup execute mode: add caching tools and modify system prompt
-        if caching_settings.strategy in ["execute", "both"]:
+        if caching_settings.strategy in ["execute", "auto"]:
             # Create CacheExecutor with execution settings and add to speakers
             cache_executor = CacheExecutor(caching_settings.execution_settings)
             self._conversation.speakers.add_speaker(cache_executor)
@@ -308,7 +308,7 @@ def _patch_act_with_cache(
             tools = caching_tools
 
         # Setup record mode: create cache manager for recording
-        if caching_settings.strategy in ["record", "both"]:
+        if caching_settings.strategy in ["record", "auto"]:
             cache_writer_settings = (
                 caching_settings.writing_settings or CacheWritingSettings()
             )

src/askui/models/shared/settings.py

@@ -34,7 +34,7 @@ class Resolution(NamedTuple):
 DEFAULT_LOCATE_RESOLUTION = Resolution(1280, 800)
 DEFAULT_GET_RESOLUTION = Resolution(1280, 800)
 
-CACHING_STRATEGY = Literal["execute", "record", "both"]
+CACHING_STRATEGY = Literal["execute", "record", "auto"]
 CACHE_PARAMETER_IDENTIFICATION_STRATEGY = Literal["llm", "preset"]
 CACHING_VISUAL_VERIFICATION_METHOD = Literal["phash", "ahash", "none"]
 
@@ -269,11 +269,11 @@ class CachingSettings(BaseModel):
             - None: Caching disabled (default)
             - "execute": Replay actions from cache
             - "record": Record actions to cache
-            - "both": Execute from cache if available, otherwise record
+            - "auto": Execute from cache if available, otherwise record
         cache_dir (str): Directory path for storing cache files.
             Default: ".askui_cache".
-        writing_settings: Settings for cache recording (used in "record"/"both" modes)
-        execution_settings: Settings for cache playback (used in "execute"/"both" modes)
+        writing_settings: Settings for cache recording (used in "record"/"auto" modes)
+        execution_settings: Settings for cache playback (used in "execute"/"auto" modes)
     """
 
     strategy: CACHING_STRATEGY | None = None

tests/e2e/agent/test_act_caching.py

@@ -62,7 +62,7 @@ def test_act_with_caching_strategy_both(vision_agent: ComputerAgent) -> None:
         vision_agent.act(
             goal="Tell me a joke",
             caching_settings=CachingSettings(
-                strategy="both",
+                strategy="auto",
                 cache_dir=str(cache_dir),
                 filename=cache_filename,
             ),