Types
askui.exceptions.AiElementNotFound
Exception raised when an AI element is not found.
Arguments:
name
str - The name of the AI element that was not found.locations
list[pathlib.Path] - The locations that were searched for the AI element.
askui.exceptions.AutomationError
Exception raised when the automation step cannot complete.
Arguments:
message
str - The error message.
askui.exceptions.ElementNotFoundError
Exception raised when an element cannot be located.
Arguments:
message
str - The error message.
askui.Img
Type of the input images for askui.VisionAgent.get()
, askui.VisionAgent.locate()
, etc.
Accepts:
PIL.Image.Image
- Relative or absolute file path (
str
orpathlib.Path
) - Data URL (e.g.,
"data:image/png;base64,..."
)
askui.ModelComposition
A composition of models (list of ModelDefinition
) to be used for a task, e.g., locating an element on the screen to be able to click on it or extracting text from an image.
askui.ModelDefinition
A definition of a model.
Arguments:
task
str - The task the model is trained for, e.g., end-to-end OCR ("e2e_ocr"
) or object detection ("od"
)architecture
str - The architecture of the model, e.g.,"easy_ocr"
or"yolo"
version
str - The version of the modelinterface
str - The interface the model is trained for, e.g.,"online_learning"
use_case
str, optional - The use case the model is trained for. In the case of workspace specific AskUI models, this is often the workspace id but with ”-” replaced by ”_”. Defaults to"00000000_0000_0000_0000_000000000000"
(custom null value).tags
list[str], optional - Tags for identifying the model that cannot be represented by other properties, e.g.,["trained", "word_level"]
askui.ModifierKey
Modifier keys for keyboard actions.
askui.PcKey
PC keys for keyboard actions.
askui.Point
A tuple of two integers representing the coordinates of a point on the screen.
askui.ResponseSchema
Type of the responses of data extracted, e.g., using askui.VisionAgent.get()
.
The following types are allowed:
ResponseSchemaBase
: Custom Pydantic models that extendResponseSchemaBase
str
: String responsesbool
: Boolean responsesint
: Integer responsesfloat
: Floating point responses
Usually, serialized as a JSON schema, e.g., str
as {"type": "string"}
, to be passed to model(s).
Also used for validating the responses of the model(s) used for data extraction.
askui.ResponseSchemaBase
Base class for response schemas to be used for defining the response of data extraction, e.g., using askui.VisionAgent.get()
.
This class extends Pydantic’s BaseModel and adds constraints and configuration on top so that it can be used with models to define the schema (type) of the data to be extracted.
Example: