UI-Tools
Die adk-ui Crate ermöglicht KI-Agenten, dynamisch reichhaltige Benutzeroberflächen durch Tool-Aufrufe zu generieren. Agenten können Formulare, Karten, Warnmeldungen, Tabellen, Diagramme und mehr rendern – alles über eine typsichere Rust API, die zu JSON für die Frontend-Nutzung serialisiert wird.
Was Sie erstellen werden
Schlüsselkonzepte:
- Formulare – Sammeln Sie Benutzereingaben mit verschiedenen Feldtypen
- Karten – Zeigen Sie Informationen mit Aktionsschaltflächen an
- Tabellen – Präsentieren Sie strukturierte Daten in Zeilen/Spalten
- Diagramme – Visualisieren Sie Daten mit Balken-, Linien-, Flächen- und Kreisdiagrammen
- Warnmeldungen – Zeigen Sie Benachrichtigungen und Statusmeldungen an
- Modale Dialoge – Bestätigungsdialoge und fokussierte Interaktionen
- Toasts – Kurze Statusbenachrichtigungen
Beispiel: Analyse-Dashboard
Beispiel: Registrierungsformular
Funktionsweise
┌─────────────────────────────────────────────────────────────────────────────┐
│ STEP 1: User requests something │
├─────────────────────────────────────────────────────────────────────────────┤
│ │
│ User: "I want to register for an account" │
│ │
│ ↓ │
│ │
│ ┌──────────────────────────────────────┐ │
│ │ AI AGENT (LLM) │ │
│ │ "I should show a registration form" │ │
│ └──────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────────────┘
↓
┌─────────────────────────────────────────────────────────────────────────────┐
│ STEP 2: Agent calls render_form tool │
├─────────────────────────────────────────────────────────────────────────────┤
│ │
│ 📞 Tool Call: render_form({ │
│ title: "Registration", │
│ fields: [ │
│ {name: "email", type: "email"}, │
│ {name: "password", type: "password"} │
│ ] │
│ }) │
│ │
└─────────────────────────────────────────────────────────────────────────────┘
↓
┌─────────────────────────────────────────────────────────────────────────────┐
│ STEP 3: Frontend renders the form │
├─────────────────────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────────────────────────────────────────┐ │
│ │ 📋 Registration │ │
│ │ ──────────────────────────────────────────── │ │
│ │ Email: [________________________] │ │
│ │ Password: [________________________] │ │
│ │ │ │
│ │ [ Register ] │ │
│ └─────────────────────────────────────────────────┘ │
│ │
│ ✅ User sees an interactive form, fills it out, clicks Register │
│ │
└─────────────────────────────────────────────────────────────────────────────┘
↓
┌─────────────────────────────────────────────────────────────────────────────┐
│ STEP 4: Form submission sent back to agent │
├─────────────────────────────────────────────────────────────────────────────┤
│ │
│ 📩 Event: { │
│ type: "form_submit", │
│ data: { email: "user@example.com", password: "***" } │
│ } │
│ │
│ Agent: "Great! I'll process your registration and show a success alert" │
│ │
│ 📞 Tool Call: render_alert({ │
│ title: "Registration Complete!", │
│ variant: "success" │
│ }) │
│ │
└─────────────────────────────────────────────────────────────────────────────┘Übersicht
UI tools ermöglichen Agents, Folgendes zu tun:
- Benutzereingaben über dynamische Formulare mit Textarea-Unterstützung zu erfassen
- Informationen mit cards, alerts und notifications anzuzeigen
- Daten in Tabellen und interaktiven Charts (Recharts) darzustellen
- Fortschritts- und Ladezustände (spinner, skeleton) anzuzeigen
- Dashboard-Layouts mit mehreren components zu erstellen
- Benutzerbestätigung über modals anzufordern
- toast notifications für Statusaktualisierungen anzuzeigen
Schnellstart
Fügen Sie dies Ihrer Cargo.toml hinzu:
[dependencies]
adk-rust = { version = "0.2.0", features = ["ui"] }
# Or use individual crates:
adk-ui = "0.2.0"
adk-agent = "0.2.0"
adk-model = "0.2.0"Grundlegende Verwendung
use adk_rust::prelude::*;
use adk_rust::ui::UiToolset;
use std::sync::Arc;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let model = Arc::new(GeminiModel::from_env("gemini-2.0-flash")?);
// Get all 10 UI tools
let ui_tools = UiToolset::all_tools();
// Create AI agent with UI tools
let mut builder = LlmAgentBuilder::new("ui_agent")
.model(model)
.instruction(r#"
You are a helpful assistant that uses UI components to interact with users.
Use render_form for collecting information.
Use render_card for displaying results.
Use render_alert for notifications.
Use render_modal for confirmation dialogs.
Use render_toast for brief status messages.
"#);
for tool in ui_tools {
builder = builder.tool(tool);
}
let agent = builder.build()?;
Ok(())
}Verfügbare Tools
render_form
Rendert interaktive Formulare zur Erfassung von Benutzereingaben.
{
"title": "Registration Form",
"description": "Create your account",
"fields": [
{"name": "username", "label": "Username", "type": "text", "required": true},
{"name": "email", "label": "Email", "type": "email", "required": true},
{"name": "password", "label": "Password", "type": "password", "required": true},
{"name": "newsletter", "label": "Subscribe to newsletter", "type": "switch"}
],
"submit_label": "Register"
}Wird gerendert als:
┌─────────────────────────────────────────────────┐
│ 📋 Registration Form │
│ Create your account │
│ ───────────────────────────────────────────── │
│ │
│ Username * │
│ ┌─────────────────────────────────────────┐ │
│ │ │ │
│ └─────────────────────────────────────────┘ │
│ │
│ Email * │
│ ┌─────────────────────────────────────────┐ │
│ │ │ │
│ └─────────────────────────────────────────┘ │
│ │
│ Password * │
│ ┌─────────────────────────────────────────┐ │
│ │ •••••••• │ │
│ └─────────────────────────────────────────┘ │
│ │
│ Subscribe to newsletter [○] │
│ │
│ ┌─────────────────────────────────────────┐ │
│ │ Register │ │
│ └─────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────┘Feldtypen: text, email, password, number, date, select, multiselect, switch, slider, textarea
render_card
Zeigt Informationskarten mit optionalen Aktionsschaltflächen an.
{
"title": "Order Confirmed",
"description": "Order #12345",
"content": "Your order has been placed successfully. Expected delivery: Dec 15, 2025.",
"actions": [
{"label": "Track Order", "action_id": "track", "variant": "primary"},
{"label": "Cancel", "action_id": "cancel", "variant": "danger"}
]
}Schaltflächenvarianten: primary, secondary, danger, ghost, outline
render_alert
Zeigt Benachrichtigungen und Statusmeldungen an.
{
"title": "Payment Successful",
"description": "Your payment of $99.00 has been processed.",
"variant": "success"
}Varianten: info, success, warning, error
render_confirm
Fordert Benutzerbestätigung vor Aktionen an.
{
"title": "Delete Account",
"message": "Are you sure you want to delete your account? This action cannot be undone.",
"confirm_label": "Delete",
"cancel_label": "Keep Account",
"variant": "danger"
}render_table
Zeigt tabellarische Daten an.
{
"title": "Recent Orders",
"columns": [
{"header": "Order ID", "accessor_key": "id"},
{"header": "Date", "accessor_key": "date"},
{"header": "Amount", "accessor_key": "amount"},
{"header": "Status", "accessor_key": "status"}
],
"data": [
{"id": "#12345", "date": "2025-12-10", "amount": "$99.00", "status": "Delivered"},
{"id": "#12346", "date": "2025-12-11", "amount": "$149.00", "status": "Shipped"}
]
}render_chart
Erstellt Datenvisualisierungen.
{
"title": "Monthly Sales",
"chart_type": "bar",
"x_key": "month",
"y_keys": ["revenue", "profit"],
"data": [
{"month": "Jan", "revenue": 4000, "profit": 2400},
{"month": "Feb", "revenue": 3000, "profit": 1398},
{"month": "Mar", "revenue": 5000, "profit": 3800}
]
}Diagrammtypen: bar, line, area, pie
render_progress
Zeigt den Aufgabenfortschritt mit optionalen Schritten an.
{
"title": "Installing Dependencies",
"value": 65,
"description": "Installing package 13 of 20...",
"steps": [
{"label": "Download", "completed": true},
{"label": "Extract", "completed": true},
{"label": "Install", "current": true},
{"label": "Configure", "completed": false}
]
}render_layout
Erstellt Dashboard-Layouts mit mehreren Abschnitten.
{
"title": "System Status",
"description": "Current system health overview",
"sections": [
{
"title": "Services",
"type": "stats",
"stats": [
{"label": "API Server", "value": "Healthy", "status": "operational"},
{"label": "Database", "value": "Degraded", "status": "warning"},
{"label": "Cache", "value": "Down", "status": "error"}
]
},
{
"title": "Recent Errors",
"type": "table",
"columns": [{"header": "Time", "key": "time"}, {"header": "Error", "key": "error"}],
"rows": [{"time": "10:30", "error": "Connection timeout"}]
}
]
}Abschnittstypen: stats, table, chart, alert, text
render_modal
Zeigt modale Dialoge für Bestätigungen oder fokussierte Interaktionen an.
{
"title": "Confirm Deletion",
"message": "Are you sure you want to delete this item? This action cannot be undone.",
"size": "medium",
"closable": true,
"confirm_label": "Delete",
"cancel_label": "Cancel",
"confirm_action": "delete_confirmed"
}Größen: small, medium, large, full
render_toast
Zeigt kurze Toast-Benachrichtigungen für Statusaktualisierungen an.
{
"message": "Settings saved successfully",
"variant": "success",
"duration": 5000,
"dismissible": true
}Varianten: info, success, warning, error
Gefilterte Tools
Wählen Sie nur die Tools aus, die Ihr Agent benötigt:
let toolset = UiToolset::new()
.without_chart() // Diagramme deaktivieren
.without_table() // Tabellen deaktivieren
.without_progress() // Fortschritt deaktivieren
.without_modal() // Modals deaktivieren
.without_toast(); // Toasts deaktivieren
// Oder nur Formulare verwenden
let forms_only = UiToolset::forms_only();Behandlung von UI Events
Wenn Benutzer mit der gerenderten Benutzeroberfläche interagieren (Formulare absenden, Schaltflächen anklicken), werden Events an den Agent zurückgesendet:
use adk_ui::{UiEvent, UiEventType};
// Struktur von UiEvent
pub struct UiEvent {
pub event_type: UiEventType, // FormSubmit, ButtonClick, InputChange
pub action_id: Option<String>,
pub data: Option<HashMap<String, Value>>,
}
// In Nachricht für den Agent umwandeln
let message = ui_event.to_message();Streaming von UI Updates
Für Echtzeit-UI-Updates verwenden Sie UiUpdate, um Komponenten nach ID zu patchen:
use adk_ui::{UiUpdate, UiOperation};
let update = UiUpdate {
target_id: "progress-bar".to_string(),
operation: UiOperation::Patch,
payload: Some(Component::Progress(Progress {
id: Some("progress-bar".to_string()),
value: 75,
label: Some("75%".to_string()),
})),
};Operationen: Replace, Patch, Append, Remove
Komponenten-Schema
Alle 28 Komponententypen unterstützen optionale id-Felder für Streaming-Updates:
Atome: Text, Button, Icon, Image, Badge Eingaben: TextInput, NumberInput, Select, MultiSelect, Switch, DateInput, Slider, Textarea Layouts: Stack, Grid, Card, Container, Divider, Tabs Daten: Table, List, KeyValue, CodeBlock Visualisierung: Chart (Balken, Linie, Fläche, Kreis via Recharts) Feedback: Alert, Progress, Toast, Modal, Spinner, Skeleton
React Client
Eine Referenzimplementierung für React wird bereitgestellt:
cd official_docs_examples/tools/ui_test
# UI-Server starten
cargo run --bin ui_server
# In einem anderen Terminal den React Client starten
cd ui_react_client
npm install && npm run dev -- --hostDer React Client umfasst:
- TypeScript-Typen, die dem Rust-Schema entsprechen
- Komponenten-Renderer für alle 28 Typen
- Recharts-Integration für interaktive Diagramme
- Unterstützung für Markdown-Rendering
- Unterstützung für den Dunkelmodus
- Handhabung von Formularübermittlungen
- Modal- und Toast-Komponenten
Architektur
┌─────────────┐ ┌─────────────┐
│ Agent │ ──[render_* tool]──│ UiResponse │
│ (LLM) │ │ (JSON) │
└─────────────┘ └──────┬──────┘
▲ │
│ │ SSE
│ ▼
│ ┌─────────────┐
└────── UiEvent ◄───────────│ Client │
(user action) │ (React) │
└─────────────┘Beispiele
Drei Beispiele demonstrieren UI-Tools:
| Beispiel | Beschreibung | Ausführungsbefehl |
|---|---|---|
ui_agent | Konsolen-Demo | cargo run --bin ui_agent |
ui_server | HTTP-Server mit SSE | cargo run --bin ui_server |
ui_react_client | React-Frontend | cd ui_react_client && npm run dev |
Ausführen von official_docs_examples/tools/ui_test/.
Beispiel-Prompts
Testen Sie die UI-Tools mit diesen Prompts:
# Forms
"I want to register for an account"
"Create a contact form"
"Create a feedback form with a comments textarea"
# Cards
"Show me my profile"
"Display a product card for a laptop"
# Alerts
"Show a success message"
"Display a warning about expiring session"
# Modals
"I want to delete my account" (shows confirmation modal)
"Show a confirmation dialog before submitting"
# Toasts
"Show a success toast notification"
"Display an error toast"
# Tables
"Show my recent orders"
"List all users"
# Charts
"Show monthly sales chart"
"Display traffic trends as a line chart"
"Show revenue breakdown as a pie chart"
# Progress & Loading
"Show upload progress at 75%"
"Display a loading spinner"
"Show skeleton loading state"
# Dashboards
"Show system status dashboard"Zurück: ← Browser-Tools | Weiter: MCP-Tools →