From 1fcf6cc6ae7fa5518c68f006189e1acb9b258ccd Mon Sep 17 00:00:00 2001 From: Samir Mlika Date: Mon, 5 Jan 2026 11:42:36 +0100 Subject: [PATCH] rename vision agent to python sdk --- 01-tutorials/01-your-first-agent.mdx | 2 +- .../05-runtime-and-environment-errors.mdx | 2 +- .../04-troubleshooting/08-known-issues.mdx | 2 +- .../00-build-ai-agents-overview.mdx | 2 +- .../05-build-ai-agents/02-select-elements.mdx | 2 +- .../01-foundations/foundations-overview.mdx | 2 +- .../04-effective-agentic-instructions.mdx | 2 +- 03-explanation/05-glossary.mdx | 4 ++-- ...I-AddAskUIControllerAutoRecoverService.mdx | 6 ++--- .../AskUI-SetFirstAskUIRunner.mdx | 22 +++++++++---------- 04-reference/environment-variables.mdx | 8 +++---- .../askui-suite-25-10-1-release-notes.md | 6 ++--- .../askui-suite-25-11-1-release-notes.md | 6 ++--- .../askui-suite-25-2-1-release-notes.md | 6 ++--- .../askui-suite-25-3-1-release-notes.md | 6 ++--- .../askui-suite-25-4-1-release-notes.md | 6 ++--- .../askui-suite-25-6-1-release-notes.md | 8 +++---- .../askui-suite-25-6-2-release-notes.md | 6 ++--- .../askui-suite-25-6-3-release-notes.md | 6 ++--- .../askui-suite-25-7-1-release-notes.md | 6 ++--- .../askui-suite-25-7-2-release-notes.md | 6 ++--- .../askui-suite-25-8-1-release-notes.md | 6 ++--- .../askui-suite-25-8-2-release-notes.md | 6 ++--- .../askui-suite-25-9-2-release-notes.md | 6 ++--- .../python-vision-agent-release-notes.mdx | 2 +- README.md | 6 ++--- index.mdx | 2 +- mint.json | 2 +- 28 files changed, 73 insertions(+), 73 deletions(-) diff --git a/01-tutorials/01-your-first-agent.mdx b/01-tutorials/01-your-first-agent.mdx index 86541bf..480976d 100644 --- a/01-tutorials/01-your-first-agent.mdx +++ b/01-tutorials/01-your-first-agent.mdx @@ -93,7 +93,7 @@ You'll create an agent that: ```python with VisionAgent(reporters=[SimpleHtmlReporter()]) as agent: ``` - - Creates a vision agent that can see and interact with your screen + - Creates an agent using the Python SDK that can see and interact with your screen - Enables debug logging to see what's happening - Sets up HTML reporting to review the automation later diff --git a/02-how-to-guides/04-troubleshooting/05-runtime-and-environment-errors.mdx b/02-how-to-guides/04-troubleshooting/05-runtime-and-environment-errors.mdx index 09b8d1a..217d8e0 100644 --- a/02-how-to-guides/04-troubleshooting/05-runtime-and-environment-errors.mdx +++ b/02-how-to-guides/04-troubleshooting/05-runtime-and-environment-errors.mdx @@ -5,7 +5,7 @@ description: Solutions for runtime errors and environment configuration issues This guide helps you resolve runtime errors and environment-related issues when using AskUI. -## Python Vision Agent Errors +## Python SDK Errors ### Session Info Doesn't Match Error diff --git a/02-how-to-guides/04-troubleshooting/08-known-issues.mdx b/02-how-to-guides/04-troubleshooting/08-known-issues.mdx index ed8f663..c41102b 100644 --- a/02-how-to-guides/04-troubleshooting/08-known-issues.mdx +++ b/02-how-to-guides/04-troubleshooting/08-known-issues.mdx @@ -40,7 +40,7 @@ For solutions to common problems, see our [Troubleshooting Guides](/02-how-to-gu ``` Then restart your system. -## Python Vision Agent +## Python SDK ### Session Management - **Issue**: "Session info doesn't match" errors diff --git a/02-how-to-guides/05-build-ai-agents/00-build-ai-agents-overview.mdx b/02-how-to-guides/05-build-ai-agents/00-build-ai-agents-overview.mdx index aa508c7..02af76b 100644 --- a/02-how-to-guides/05-build-ai-agents/00-build-ai-agents-overview.mdx +++ b/02-how-to-guides/05-build-ai-agents/00-build-ai-agents-overview.mdx @@ -60,4 +60,4 @@ For detailed information about method parameters, return types, and advanced usa - [`act()`](/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent#act) - Autonomous goal-oriented actions - [`type()`](/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent#type) - Type text input - [`keyboard()`](/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent#keyboard) - Send keyboard input -- [Full Vision Agent API](/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent) - Complete reference +- [Full Python SDK API](/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent) - Complete reference diff --git a/02-how-to-guides/05-build-ai-agents/02-select-elements.mdx b/02-how-to-guides/05-build-ai-agents/02-select-elements.mdx index 208c358..3a52045 100644 --- a/02-how-to-guides/05-build-ai-agents/02-select-elements.mdx +++ b/02-how-to-guides/05-build-ai-agents/02-select-elements.mdx @@ -3,7 +3,7 @@ title: Select UI Elements description: How to select and interact with UI elements using AskUI --- -This guide shows you how to select and interact with UI elements using AskUI's Vision Agent. +This guide shows you how to select and interact with UI elements using AskUI's Python SDK. ## Natural Language Selection diff --git a/03-explanation/01-foundations/foundations-overview.mdx b/03-explanation/01-foundations/foundations-overview.mdx index ea63129..dfdb7bf 100644 --- a/03-explanation/01-foundations/foundations-overview.mdx +++ b/03-explanation/01-foundations/foundations-overview.mdx @@ -31,7 +31,7 @@ Key features of AskUI include: - Flexible model use (hot swap of models) and infrastructure for reteaching of models (available on-premise) - **Secure deployment** of agents in enterprise environments -| Feature | AskUI Vision Agent | Computer Use by Anthropic | Operator by OpenAI | Browser Use | Custom (VLM \+ PyAutoGUI \+ Playwright) | +| Feature | AskUI Python SDK | Computer Use by Anthropic | Operator by OpenAI | Browser Use | Custom (VLM \+ PyAutoGUI \+ Playwright) | | ---------------------------------- | ------------------ | ------------------------- | ------------------ | ----------- | --------------------------------------- | | Browser Use | ✅ | ✅ | ✅ | ✅ | ✅ | | DOM Support | ❌ | ❌ | ✅ | ✅ | ✅ | diff --git a/03-explanation/02-best-practices/04-effective-agentic-instructions.mdx b/03-explanation/02-best-practices/04-effective-agentic-instructions.mdx index 24d681a..f300e71 100644 --- a/03-explanation/02-best-practices/04-effective-agentic-instructions.mdx +++ b/03-explanation/02-best-practices/04-effective-agentic-instructions.mdx @@ -60,7 +60,7 @@ This ensures that your automation script adapts dynamically to real-time applica ### **5. Use Multiple Approaches for Actions** -Flexibility is key when automating tasks, especially for repetitive actions like deleting text. The AskUI Vision Agent allows you to use multiple approaches for the same action, ensuring compatibility across different scenarios. +Flexibility is key when automating tasks, especially for repetitive actions like deleting text. The AskUI Python SDK allows you to use multiple approaches for the same action, ensuring compatibility across different scenarios. Example: diff --git a/03-explanation/05-glossary.mdx b/03-explanation/05-glossary.mdx index fe96627..53ad784 100644 --- a/03-explanation/05-glossary.mdx +++ b/03-explanation/05-glossary.mdx @@ -6,7 +6,7 @@ description: 'This page provides a glossary of key AskUI terms and definitions t | **Term** | **Meaning** | | :-------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **access token** | Gives you access to the AskUI inference in combination with your workspace ID. Every access token has an expiry date and is assigned to exactly one workspace. See [Managing Access Tokens](/02-how-to-guides/01-account-management/04-tokens). | -| **action** | A method in the AskUI Control Client API that describes an action to be taken against the operating system, e.g., `click()`, `type()`. See [Vision Agent API Actions](/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent). | +| **action** | A method in the AskUI Control Client API that describes an action to be taken against the operating system, e.g., `click()`, `type()`. See [Python SDK API Actions](/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent). | | **annotation** | Marked area around an element with metadata including name, text, and bounding box coordinates. | | **automation** | A system of multiple connected workflows. | | **bounding box** | A rectangle described by coordinates that define an element’s location, visually displayed as a red rectangle. | @@ -16,7 +16,7 @@ description: 'This page provides a glossary of key AskUI terms and definitions t | **inference server** | The backend system that performs inference (UI analysis and annotation). | | **instruction** | A single AskUI directive, usually consisting of **action + (optional) locator**. | | **interactive annotation** | Exploring the annotations of a user interface through an annotated screenshot. | -| **locator** | A description of an UI *element* that is used to (re-)locate (find) the element on the screen, e.g., when trying to click on it; can be a simple textual description like `"login button"` or more complex, potentially multi-modal, e.g., `loc.Image("path/to/image.png").below_of(loc.Text("Login"))`. See [Vision Agent API Locators](/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/locators) and [Element Selection Guide](/03-explanation/02-best-practices/01-element-selection/01-element-selection). | +| **locator** | A description of an UI *element* that is used to (re-)locate (find) the element on the screen, e.g., when trying to click on it; can be a simple textual description like `"login button"` or more complex, potentially multi-modal, e.g., `loc.Image("path/to/image.png").below_of(loc.Text("Login"))`. See [Python SDK API Locators](/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/locators) and [Element Selection Guide](/03-explanation/02-best-practices/01-element-selection/01-element-selection). | | **UI Controller (legacy)** | A service that controls inputs and observes visuals on the operating system. | | **AskUI Controller** | The updated service that controls inputs and observes visuals on the operating system. | | **UI Control Client** | Retrieves annotations from the inference server and executes input instructions on the operating system via the AskUI Controller. | diff --git a/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-AddAskUIControllerAutoRecoverService.mdx b/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-AddAskUIControllerAutoRecoverService.mdx index 3256934..86e12ff 100644 --- a/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-AddAskUIControllerAutoRecoverService.mdx +++ b/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-AddAskUIControllerAutoRecoverService.mdx @@ -11,9 +11,9 @@ It handles switching the RDP session to console mode. ### PARAMETERS -- `-ControllerType` | _<String>_ - The type of the controller to recover. (Default: RemoteDeviceController for Python Vision Agent) +- `-ControllerType` | _<String>_ - The type of the controller to recover. (Default: RemoteDeviceController for Python SDK) Valid values are: 'UIController', 'RemoteDeviceController' -Example: 'UIController' for Typescript ADK (NodeJS), 'RemoteDeviceController' for Python Vision Agent. +Example: 'UIController' for Typescript ADK (NodeJS), 'RemoteDeviceController' for Python SDK. ### NOTES @@ -23,7 +23,7 @@ This Commandlet is only available on Windows AMD64. #### EXAMPLE 1 -This command adds the AskUI Controller Auto Recover Service for the Python Vision Agent. +This command adds the AskUI Controller Auto Recover Service for the Python SDK. ```powershell AskUI-AddAskUIControllerAutoRecoverService diff --git a/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-SetFirstAskUIRunner.mdx b/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-SetFirstAskUIRunner.mdx index a02dae2..47fd609 100644 --- a/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-SetFirstAskUIRunner.mdx +++ b/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-SetFirstAskUIRunner.mdx @@ -2,24 +2,24 @@ title: AskUI-SetFirstAskUIRunner --- - + ### SYNOPSIS -Configures the runner environment. -It tries to create the "AskUIRunnerUser" user and disables the screensaver for it. -It sets the AskUI Suite as global installation. -It adds and starts the AskUI Controller Auto Recover Service. - +Configures the runner environment. +It tries to create the "AskUIRunnerUser" user and disables the screensaver for it. +It sets the AskUI Suite as global installation. +It adds and starts the AskUI Controller Auto Recover Service. + ### PARAMETERS -- `-ControllerType` | _<String>_ - The type of the controller to recover. (Default: RemoteDeviceController for Python Vision Agent) +- `-ControllerType` | _<String>_ - The type of the controller to recover. (Default: RemoteDeviceController for Python SDK) Valid values are: 'UIController', 'RemoteDeviceController' -Example: 'UIController' for Typescript ADK (NodeJS), 'RemoteDeviceController' for Python Vision Agent. - +Example: 'UIController' for Typescript ADK (NodeJS), 'RemoteDeviceController' for Python SDK. + ### NOTES -This Commandlet is only available on Windows AMD64. - +This Commandlet is only available on Windows AMD64. + ### EXAMPLES #### EXAMPLE 1 diff --git a/04-reference/environment-variables.mdx b/04-reference/environment-variables.mdx index 2a5898a..74c29a6 100644 --- a/04-reference/environment-variables.mdx +++ b/04-reference/environment-variables.mdx @@ -19,13 +19,13 @@ description: "These are the environment variables for AskUI" --- -### Vision Agent: +### Python SDK: -- **ASKUI_INFERENCE_ENDPOINT**: The URL of the Vision Agent's inference endpoint, which handles image and text analysis. +- **ASKUI_INFERENCE_ENDPOINT**: The URL of the Python SDK's inference endpoint, which handles image and text analysis. - **ASKUI_CONTROLLER_PATH**: The file path to the controller's executable or binary file. -- **ASKUI__VA__TELEMETRY__ENABLED**: A boolean flag to enable or disable the recording of usage data for the Vision Agent. Setting this variable to False will disable telemetry. +- **ASKUI__VA__TELEMETRY__ENABLED**: A boolean flag to enable or disable the recording of usage data for the Python SDK. Setting this variable to False will disable telemetry. - **ASKUI_CONTROLLER_ARGS**: Command-line arguments for the AskUI Remote Device Controller. See details in [ASKUI_CONTROLLER_ARGS](#askui_controller_args). -- **ASKUI_CONTROLLER_CLIENT_SERVER_AUTOSTART**: Boolean flag to enable or disable the automatic startup of AskUI Remote Device Controller Client Server by the Client in vision agent. Default is `true`. +- **ASKUI_CONTROLLER_CLIENT_SERVER_AUTOSTART**: Boolean flag to enable or disable the automatic startup of AskUI Remote Device Controller Client Server by the Client in Python SDK. Default is `true`. - **ASKUI_CONTROLLER_CLIENT_SERVER_ADDRESS**: The address of the AskUI Remote Device Controller Client Server. Default is `localhost:23000`. - **ASKUI__AUTHORIZATION**: Overwrites the HTTP Request Authorization Header with the value. (Optional) diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-10-1-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-10-1-release-notes.md index a287d20..6090777 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-10-1-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-10-1-release-notes.md @@ -49,9 +49,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@latest` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -94,7 +94,7 @@ Nothing has changed | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.26.0 | [Link](https://github.com/askui/askui/releases/tag/v0.26.0) | -| Python Vision Agent | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | +| Python SDK | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | | VSCode | 1.98 | | | Mesa Driver | 25.2.0 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-11-1-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-11-1-release-notes.md index 741b202..3a505cd 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-11-1-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-11-1-release-notes.md @@ -49,9 +49,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@latest` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -97,7 +97,7 @@ To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to th | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.26.0 | [Link](https://github.com/askui/askui/releases/tag/v0.26.0) | -| Python Vision Agent | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | +| Python SDK | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | | VSCode | 1.98 | | | Mesa Driver | 25.2.0 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-2-1-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-2-1-release-notes.md index 6eaa932..922586b 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-2-1-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-2-1-release-notes.md @@ -6,7 +6,7 @@ The AskUI Suite is a comprehensive bundle that includes all necessary dependenci This release focus on: 1. Enhance On-Boarding experience for Users with the new [Caesr](https://app.caesr.ai/) -2. Support [Python Vision Agent](https://github.com/askui/vision-agent) +2. Support [Python Python SDK](https://github.com/askui/vision-agent) 3. Improve ADE 4. Improve Proxy Handling and Autodetection @@ -186,7 +186,7 @@ Info: Response description: OK ### ADE: Windows Tools: Long Path Tools -On Windows, the maximum file path length is 260 characters. Exceeding this limit results in a "Destination Path Too Long" error. This tool helps users check and enable Windows Long Path support. This helps to avoid errors with Python Vision Agent. +On Windows, the maximum file path length is 260 characters. Exceeding this limit results in a "Destination Path Too Long" error. This tool helps users check and enable Windows Long Path support. This helps to avoid errors with Python Python SDK.
Startup Check Warns Long Path Support is not enabled - Displays a Long Path not enabled warning when starting the askui-shell @@ -288,7 +288,7 @@ Info: Plugin with name 'MyPlugin' has been removed. ### ADE: Python Environment Manager -The Python Environment Manager helps manage virtual environments, dependencies, and package installations, ensuring consistency across projects. It prevents conflicts and allows seamless switching between different Python versions and environments. It is used in combination with AskUI Agents from the [Caesr](https://app.caesr.ai/) and the [Python Vision Agent Libarary](https://github.com/askui/vision-agent) +The Python Environment Manager helps manage virtual environments, dependencies, and package installations, ensuring consistency across projects. It prevents conflicts and allows seamless switching between different Python versions and environments. It is used in combination with AskUI Agents from the [Caesr](https://app.caesr.ai/) and the [Python SDK](https://github.com/askui/vision-agent)
AskUI-EnablePythonEnvironment - Activates a Python virtual environment. - docs diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-3-1-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-3-1-release-notes.md index d82d6f6..fe82940 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-3-1-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-3-1-release-notes.md @@ -50,9 +50,9 @@ To update your [AskUI Typescipt ADK ](https://github.com/askui/askui) to the new 3. Enter the AskUI Shell by `askui-shell` 4. Update AskUI by `npm install --dev askui@0.23.1` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSode 5. Enable your virtual environment. 6. Enter `pip install askui==0.2.4` @@ -229,7 +229,7 @@ await aui.click().element().matching('a black sneaker shoe').exec(); -> await au | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.23.1 | [Link](https://github.com/askui/askui/releases/tag/v0.23.1) | -| Python Vision Agent | 0.2.4 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.2.4) | +| Python SDK | 0.2.4 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.2.4) | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-4-1-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-4-1-release-notes.md index 5286e11..50b5389 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-4-1-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-4-1-release-notes.md @@ -53,9 +53,9 @@ To update your [AskUI Typescipt ADK ](https://github.com/askui/askui) to the new 6. Enter the AskUI Shell by `askui-shell` 7. Update AskUI by `npm install --dev askui@0.23.1` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSode 8. Enable your virtual environment. 9. Enter `pip install askui==0.2.4` @@ -131,7 +131,7 @@ Nothing has changed | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.23.1 | [Link](https://github.com/askui/askui/releases/tag/v0.23.1) | -| Python Vision Agent | 0.2.4 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.2.4) | +| Python SDK | 0.2.4 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.2.4) | | VSCode | 1.98 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-1-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-1-release-notes.md index 69dcdfb..7b2e5b1 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-1-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-1-release-notes.md @@ -117,7 +117,7 @@ ADE C:\Users\MaxMustermann> AskUI-NewAiElement -Name "code" AskUI Typescript ADK: Filter: aiElement('code') Example: await aui.click().aiElement('code').exec() - AskUI Python Vision Agent: + AskUI Python Python SDK: Example: agent.click(loc.AiElement("code")) ```
@@ -149,9 +149,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@0.25.1` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -185,5 +185,5 @@ To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to th | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.25.1 | [Link](https://github.com/askui/askui/releases/tag/v0.25.1) | -| Python Vision Agent | 0.4.7 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.4.7) | +| Python SDK | 0.4.7 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.4.7) | | VSCode | 1.98 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-2-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-2-release-notes.md index 223401b..eb850ee 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-2-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-2-release-notes.md @@ -54,9 +54,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@0.26.0` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -90,5 +90,5 @@ To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to th | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.26.0 | [Link](https://github.com/askui/askui/releases/tag/v0.26.0) | -| Python Vision Agent | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | +| Python SDK | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | | VSCode | 1.98 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-3-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-3-release-notes.md index ccb1bd8..f18af35 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-3-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-3-release-notes.md @@ -54,9 +54,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@0.26.0` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -97,5 +97,5 @@ To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to th | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.26.0 | [Link](https://github.com/askui/askui/releases/tag/v0.26.0) | -| Python Vision Agent | 0.6.0 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.6.0) | +| Python SDK | 0.6.0 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.6.0) | | VSCode | 1.98 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-1-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-1-release-notes.md index 56b2b28..73112c2 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-1-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-1-release-notes.md @@ -48,9 +48,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@0.26.0` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -89,6 +89,6 @@ To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to th | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.26.0 | [Link](https://github.com/askui/askui/releases/tag/v0.26.0) | -| Python Vision Agent | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | +| Python SDK | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | | VSCode | 1.98 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-2-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-2-release-notes.md index 67c3bf7..2ddd11e 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-2-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-2-release-notes.md @@ -50,9 +50,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@0.26.0` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -93,6 +93,6 @@ To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to th | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.26.0 | [Link](https://github.com/askui/askui/releases/tag/v0.26.0) | -| Python Vision Agent | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | +| Python SDK | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | | VSCode | 1.98 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-1-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-1-release-notes.md index e37d312..cd1c13b 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-1-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-1-release-notes.md @@ -49,9 +49,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@0.28.0` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -94,6 +94,6 @@ To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to th | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.26.0 | [Link](https://github.com/askui/askui/releases/tag/v0.26.0) | -| Python Vision Agent | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | +| Python SDK | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | | VSCode | 1.98 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-2-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-2-release-notes.md index 9e95711..754134f 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-2-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-2-release-notes.md @@ -49,9 +49,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@0.28.0` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -93,7 +93,7 @@ To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to th | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.26.0 | [Link](https://github.com/askui/askui/releases/tag/v0.26.0) | -| Python Vision Agent | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | +| Python SDK | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | | VSCode | 1.98 | | | Mesa Driver | 25.2.0 | | diff --git a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-9-2-release-notes.md b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-9-2-release-notes.md index 726d8ad..6dd56b3 100644 --- a/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-9-2-release-notes.md +++ b/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-9-2-release-notes.md @@ -49,9 +49,9 @@ To update your [AskUI Typescript ADK](https://github.com/askui/askui) to the new 2. Enter the AskUI Shell by `askui-shell` 3. Update AskUI by `npm install --dev askui@0.28.1` -### AskUI Vision Agent (Python) +### AskUI Python SDK -To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to the new version: +To update your [AskUI Python SDK](https://github.com/askui/vision-agent) to the new version: 1. Open your project in VSCode 2. Enable your virtual environment. @@ -96,7 +96,7 @@ To update your [AskUI Vision Agent](https://github.com/askui/vision-agent) to th | ADE.PluginManager | 0.1.0 | | | ADE.EnvironmentManager | 0.1.0 | | | AskUI Typescript ADK | 0.26.0 | [Link](https://github.com/askui/askui/releases/tag/v0.26.0) | -| Python Vision Agent | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | +| Python SDK | 0.5.3 | [Link](https://github.com/askui/vision-agent/releases/tag/v0.5.3) | | VSCode | 1.98 | | | Mesa Driver | 25.2.0 | | diff --git a/05-additional-resources/release-notes/02-agent-frameworks/python-vision-agent-release-notes.mdx b/05-additional-resources/release-notes/02-agent-frameworks/python-vision-agent-release-notes.mdx index 5517e3f..61d3d92 100644 --- a/05-additional-resources/release-notes/02-agent-frameworks/python-vision-agent-release-notes.mdx +++ b/05-additional-resources/release-notes/02-agent-frameworks/python-vision-agent-release-notes.mdx @@ -1,5 +1,5 @@ --- -title: "AskUI Vision Agent (Python)" +title: "AskUI Python SDK" url: "https://github.com/askui/vision-agent/releases" --- diff --git a/README.md b/README.md index 25bcc89..9edb596 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This is the AskUI documentation. The documentation covers: -- Python Vision Agent +- Python SDK - AskUI Suite - Workspaces Service API - AskUI Inference API @@ -48,7 +48,7 @@ npx mintlify dev pdm install ``` -2. Install newest version of askui-vision agent +2. Install newest version of AskUI Python SDK ``` pdm add -d askui@ ``` @@ -87,7 +87,7 @@ Then the `mint.json` needs to be updated to render new pages: Example: ```diff { - "group": "Python Vision Agent", + "group": "Python Python SDK", "pages": [ "02-api-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent", "02-api-reference/01-agent-frameworks/02-python/02-vision-agent-api/locators", diff --git a/index.mdx b/index.mdx index 4a29dbe..95346ec 100644 --- a/index.mdx +++ b/index.mdx @@ -64,7 +64,7 @@ Our documentation is organized into four main sections: diff --git a/mint.json b/mint.json index e1ca227..47dee5e 100644 --- a/mint.json +++ b/mint.json @@ -190,7 +190,7 @@ ] }, { - "group": "Python Vision Agent", + "group": "Python SDK", "pages": [ "04-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent", "04-reference/01-agent-frameworks/02-python/02-vision-agent-api/android-vision-agent",