Skip to main content
Version: Next

Terminology

TermMeaning
access tokenGives 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.
actionA method in the AskUI Control Client API that describes an action to be taken against the operating system. For example click(), type().
annotationMarked area around an element with metadata name, text, and bounding box coordinates.
automationA system of multiple connected workflows.
bounding boxRectangle described by coordinates that describe an element's location. Displayed visually as red rectangle.
credentialsCombination of workspace id and access token living in the same workspace.
elementA user interface component which websites and blocks are build from.
element-descriptionA description for a UI element. In the AskUI Control Client API, for example, it is the coded description like button() or textfield().contains().text('Email').
inferenceThe process of annotating a user interface.
inference serverBackend which performs the inference.
instructionSingle AskUI directive which usually has following parts: action + (optional)element-description.
interactive annotationExploring the annotations of a user interface through an annotated screenshot.
UI Controller (legacy)Service to control inputs and observe the visuals on the operating system.
AskUI ControllerService to control inputs and observe the visuals on the operating system.
UI Control ClientRetrieves the annotations from the inference server and uses the given instructions to execute inputs on the operating system through the AskUI Controller.
AskUI Studio (former User Portal)In AskUI Studio you can create access tokens for your workspace.
AskUI-InstallerInstaller that sets up AskUI components on a machine.
AskUI Development Environment (ADE)Terminal environment to setup and manage AskUI components and projects.
AskUI RunnerSelf-hosted component that downloads and runs workflows from AskUI Studio.
workflowA set of instructions to complete a single task.
workspaceEvery registered user has exactly one workspace. Every workspace can contain multiple access tokens.
workspace idThe id of your workspace. Gives you access to the AskUI inference in combination with your access token.