Skip to content

Commit 4442b24

Browse files
chore: Fix docs so can be deployed (#4149)
# What does this PR do? Building/Deploying docs is failing here: https://github.com/llamastack/llamastack.github.io/actions/runs/19333785864/job/55303209627#step:8:49 Needs the playground file. Updated it to reflect current admin status. <!-- If resolving an issue, uncomment and update the line below --> <!-- Closes #[issue-number] --> ## Test Plan <!-- Describe the tests you ran to verify your changes with result summaries. *Provide clear instructions so the plan can be easily re-executed.* --> Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>
1 parent aeaf4eb commit 4442b24

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: Admin UI & Chat Playground
3+
description: Web-based admin interface and chat playground for Llama Stack
4+
sidebar_label: Playground
5+
sidebar_position: 10
6+
---
7+
8+
# Admin UI & Chat Playground
9+
10+
The Llama Stack UI provides a comprehensive web-based admin interface for managing your Llama Stack server, with an integrated chat playground for interactive testing. This admin interface is the primary way to monitor, manage, and debug your Llama Stack applications.
11+
12+
## Quick Start
13+
14+
Launch the admin UI with:
15+
16+
```bash
17+
npx llama-stack-ui
18+
```
19+
20+
Then visit `http://localhost:8322` to access the interface.
21+
22+
## Admin Interface Features
23+
24+
The Llama Stack UI is organized into three main sections:
25+
26+
### 🎯 Create
27+
**Chat Playground** - Interactive testing environment
28+
- Real-time chat interface for testing agents and models
29+
- Multi-turn conversations with tool calling support
30+
- Agent SDK integration (will be migrated to Responses API)
31+
- Custom system prompts and model parameter adjustment
32+
33+
### 📊 Manage
34+
**Logs & Resource Management** - Monitor and manage your stack
35+
- **Responses Logs**: View and analyze agent responses and interactions
36+
- **Chat Completions Logs**: Monitor chat completion requests and responses
37+
- **Vector Stores**: Create, manage, and monitor vector databases for RAG workflows
38+
- **Prompts**: Full CRUD operations for prompt templates and management
39+
- **Files**: Forthcoming file management capabilities
40+
41+
## Key Capabilities for Application Development
42+
43+
### Real-time Monitoring
44+
- **Response Tracking**: Monitor all agent responses and tool calls
45+
- **Completion Analysis**: View chat completion performance and patterns
46+
- **Vector Store Activity**: Track RAG operations and document processing
47+
- **Prompt Usage**: Analyze prompt template performance
48+
49+
### Resource Management
50+
- **Vector Store CRUD**: Create, update, and delete vector databases
51+
- **Prompt Library**: Organize and version control your prompts
52+
- **File Operations**: Manage documents and assets (forthcoming)
53+
54+
### Interactive Testing
55+
- **Chat Playground**: Test conversational flows before production deployment
56+
- **Agent Prototyping**: Validate agent behaviors and tool integrations
57+
58+
## Development Workflow Integration
59+
60+
The admin UI supports your development lifecycle:
61+
62+
1. **Development**: Use chat playground to prototype and test features
63+
2. **Monitoring**: Track system performance through logs and metrics
64+
3. **Management**: Organize prompts, vector stores, and other resources
65+
4. **Debugging**: Analyze logs to identify and resolve issues
66+
67+
## Architecture Notes
68+
69+
- **Current**: Chat playground uses Agents SDK
70+
- **Future**: Migration to Responses API for improved performance and consistency
71+
- **Admin Focus**: Primary emphasis on monitoring, logging, and resource management
72+
73+
## Getting Started
74+
75+
1. **Launch the UI**: Run `npx llama-stack-ui`
76+
2. **Explore Logs**: Start with Responses and Chat Completions logs to understand your system activity
77+
3. **Test in Playground**: Use the chat interface to validate your agent configurations
78+
4. **Manage Resources**: Create vector stores and organize prompts through the UI
79+
80+
For detailed setup and configuration, see the [Llama Stack UI documentation](/docs/distributions/llama_stack_ui).
81+
82+
## Next Steps
83+
84+
- Set up your [first agent](/docs/building_applications/agent)
85+
- Implement [RAG functionality](/docs/building_applications/rag)
86+
- Add [evaluation metrics](/docs/building_applications/evals)
87+
- Configure [safety measures](/docs/building_applications/safety)

0 commit comments

Comments
 (0)