Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/extracting-data.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/file-support.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/using-models.md
Original file line number Diff line number Diff line change
@@ -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!

Expand Down
2 changes: 1 addition & 1 deletion src/askui/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""AskUI Vision Agent"""
"""AskUI Python SDK"""

__version__ = "0.22.11"

Expand Down
4 changes: 2 additions & 2 deletions src/askui/reporting.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ def generate(self) -> None:
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Vision Agent Report - {{ timestamp }}</title>
<title>AskUI Python SDK Report - {{ timestamp }}</title>
<link rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css">
<script
Expand Down Expand Up @@ -649,7 +649,7 @@ def generate(self) -> None:
<div class="theme-toggle" onclick="toggleTheme()" title="Toggle dark/light mode">
<div class="theme-toggle-slider"></div>
</div>
<h1>Vision Agent Report</h1>
<h1>AskUI Python SDK Report</h1>
<p>Generated: {{ timestamp }}</p>
</div>

Expand Down