Skip to main content

Documentation Index

Fetch the complete documentation index at: https://askui-docs-on-premise-architecture.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Navigation elements like sidebars, menus, and lists are essential UI components. Learn how to extract these structures.

​
Basic List Extraction

from askui import VisionAgent, ResponseSchemaBase
from typing import List


class SidebarItem(ResponseSchemaBase):
    name: str
    children: List["SidebarItem"]

class Sidebar(ResponseSchemaBase):
    sidebar: List["SidebarItem"]


with VisionAgent() as agent:
    agent.tools.webbrowser.open_new("https://docs.askui.com")
    agent.wait(3)  # Wait for page to load
    
    result = agent.get("Can you extract me the sidebar?", response_schema=Sidebar)
    print(result.model_dump_json(indent=2))

​
Best Practices

  1. Handle Empty Lists: Always check if lists are empty 
    items = agent.get("What are the menu items?", response_schema=List[str])

if not items:
    print("No menu items found")
else:
    print(f"Found {len(items)} menu items")