diff --git a/README.md b/README.md index 3bcf60e0..6762dd75 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 🤖 AskUI Vision Agent +# 🤖 AskUI Python SDK [![Release Notes](https://img.shields.io/github/release/askui/vision-agent?style=flat-square)](https://github.com/askui/vision-agent/releases) [![PyPI - License](https://img.shields.io/pypi/l/langchain-core?style=flat-square)](https://opensource.org/licenses/MIT) @@ -22,7 +22,7 @@ Join the [AskUI Discord](https://discord.gg/Gu35zMGxbx). ## 📖 Introduction -AskUI Vision Agent is a powerful automation framework that enables you and AI agents to control your desktop, mobile, and HMI devices and automate tasks. With support for multiple AI models, multi-platform compatibility, and enterprise-ready features, +AskUI Python SDK is a powerful automation framework that enables you and AI agents to control your desktop, mobile, and HMI devices and automate tasks. With support for multiple AI models, multi-platform compatibility, and enterprise-ready features, https://github.com/user-attachments/assets/a74326f2-088f-48a2-ba1c-4d94d327cbdf diff --git a/docs/chat.md b/docs/chat.md index c1190834..2abc3b73 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -2,7 +2,7 @@ **⚠️ Warning:** AskUI Chat is currently in an experimental stage and has several limitations (see below). -AskUI Chat is a web application that allows interacting with an AskUI Vision Agent similar how it can be +AskUI Chat is a web application that allows interacting with an AskUI Python SDK similar how it can be done with `VisionAgent.act()` or `AndroidVisionAgent.act()` but in a more interactive manner that involves less code. ## Table of Contents @@ -35,8 +35,8 @@ pip install askui[chat] To use the chat, configure the following environment variables: -- `ASKUI_TOKEN`: AskUI Vision Agent behind chat uses currently the AskUI API -- `ASKUI_WORKSPACE_ID`: AskUI Vision Agent behind chat uses currently the AskUI API +- `ASKUI_TOKEN`: AskUI Python SDK behind chat uses currently the AskUI API +- `ASKUI_WORKSPACE_ID`: AskUI Python SDK behind chat uses currently the AskUI API - `ASKUI__CHAT_API__DATA_DIR` (optional, defaults to `$(pwd)/chat`): Currently, the AskUI chat stores all data in a directory locally. You can change the default directory by setting this environment variable. - `ASKUI__CHAT_API__HOST` (optional, defaults to `127.0.0.1`): The host to bind the chat API to. - `ASKUI__CHAT_API__PORT` (optional, defaults to `9261`): The port to bind the chat API to. diff --git a/docs/extracting-data.md b/docs/extracting-data.md index a6670dd2..2787525a 100644 --- a/docs/extracting-data.md +++ b/docs/extracting-data.md @@ -1,6 +1,6 @@ # Extracting Data -This guide covers how to extract information from screens using AskUI Vision Agent's `get()` method, including structured data extraction, response schemas, and working with different data sources. +This guide covers how to extract information from screens using AskUI Python SDK's `get()` method, including structured data extraction, response schemas, and working with different data sources. ## Table of Contents diff --git a/docs/file-support.md b/docs/file-support.md index 38ec40ce..d4011b9f 100644 --- a/docs/file-support.md +++ b/docs/file-support.md @@ -1,10 +1,10 @@ -# File Format Support in AskUI Vision Agent +# File Format Support in AskUI Python SDK -This document provides comprehensive information about how different file formats are supported in the AskUI Vision Agent, including their processing methods and integration with Large Language Models (LLMs). +This document provides comprehensive information about how different file formats are supported in the AskUI Python SDK, including their processing methods and integration with Large Language Models (LLMs). ## Supported File Formats -The AskUI Vision Agent supports the following file formats for data extraction and processing: +The AskUI Python SDK supports the following file formats for data extraction and processing: ### 📄 PDF Files (.pdf) diff --git a/docs/using-models.md b/docs/using-models.md index 127bf58a..4ccad91a 100644 --- a/docs/using-models.md +++ b/docs/using-models.md @@ -1,6 +1,6 @@ # Using Models -This guide covers all the AI models available in AskUI Vision Agent, their capabilities, how to authenticate with them, and how to create custom models. AskUI Vision Agent supports multiple AI model providers and self-hosted models, each with different strengths and use cases. +This guide covers all the AI models available in AskUI Python SDK, their capabilities, how to authenticate with them, and how to create custom models. AskUI Python SDK supports multiple AI model providers and self-hosted models, each with different strengths and use cases. **Important Note:** Although we would love to support all kinds of models, models hosted by us (AskUI) are our primary focus and receive the most comprehensive support, testing, and optimization. Other models rely on community contributions and may have varying levels of support. We highly appreciate community contributions to improve support for other models! diff --git a/src/askui/__init__.py b/src/askui/__init__.py index 04683d05..68c550c2 100644 --- a/src/askui/__init__.py +++ b/src/askui/__init__.py @@ -1,4 +1,4 @@ -"""AskUI Vision Agent""" +"""AskUI Python SDK""" __version__ = "0.22.11" diff --git a/src/askui/reporting.py b/src/askui/reporting.py index 1116f009..beb20e17 100644 --- a/src/askui/reporting.py +++ b/src/askui/reporting.py @@ -194,7 +194,7 @@ def generate(self) -> None: - Vision Agent Report - {{ timestamp }} + AskUI Python SDK Report - {{ timestamp }}