mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Kim
133 lines
4.0 KiB
Markdown
133 lines
4.0 KiB
Markdown
# Testing DevUI - Quick Setup Guide
|
|
|
|
Here are the step-by-step instructions to test the new DevUI feature:
|
|
|
|
## 1. Get the Code
|
|
|
|
```bash
|
|
git clone https://github.com/microsoft/agent-framework.git
|
|
cd agent-framework
|
|
```
|
|
|
|
(or use the latest main branch if merged)
|
|
|
|
## 2. Setup Environment
|
|
|
|
Navigate to the Python directory and install dependencies:
|
|
|
|
```bash
|
|
cd python
|
|
uv sync --dev
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
## 3. Configure Environment Variables
|
|
|
|
Create a `.env` file in the `python/` directory with your API credentials:
|
|
|
|
```bash
|
|
# Copy the example file
|
|
cp .env.example .env
|
|
```
|
|
|
|
Then edit `.env` and add your API keys:
|
|
|
|
```bash
|
|
# For OpenAI (minimum required)
|
|
OPENAI_API_KEY="your-api-key-here"
|
|
OPENAI_CHAT_MODEL_ID="gpt-4o-mini"
|
|
|
|
# Or for Azure OpenAI
|
|
AZURE_OPENAI_ENDPOINT="your-endpoint"
|
|
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME="your-deployment-name"
|
|
```
|
|
|
|
## 4. Test DevUI
|
|
|
|
**Option A: In-Memory Mode (Recommended for quick testing)**
|
|
|
|
```bash
|
|
cd packages/devui/samples
|
|
python in_memory_mode.py
|
|
```
|
|
|
|
This runs a simple example with predefined agents and opens your browser automatically at http://localhost:8090
|
|
|
|
**Option B: Directory-Based Discovery**
|
|
|
|
```bash
|
|
cd packages/devui/samples
|
|
devui
|
|
```
|
|
|
|
This launches the UI with all example agents/workflows at http://localhost:8080
|
|
|
|
## 5. What You'll See
|
|
|
|
- A web interface for testing agents interactively
|
|
- Multiple example agents (weather assistant, general assistant, etc.)
|
|
- OpenAI-compatible API endpoints for programmatic access
|
|
|
|
## 6. API Testing (Optional)
|
|
|
|
You can also test via API calls:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:8080/v1/responses \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"model": "agent-framework",
|
|
"input": "What is the weather in Seattle?",
|
|
"extra_body": {"entity_id": "weather_agent"}
|
|
}'
|
|
```
|
|
|
|
## API Mapping
|
|
|
|
Messages and events from agents/workflows are mapped to OpenAI response types in `agent_framework_devui/_mapper.py`. See the mapping table below:
|
|
|
|
| Agent Framework Content | OpenAI Event | Type |
|
|
| --------------------------------- | ----------------------------------------- | -------- |
|
|
| `TextContent` | `ResponseTextDeltaEvent` | Official |
|
|
| `TextReasoningContent` | `ResponseReasoningTextDeltaEvent` | Official |
|
|
| `FunctionCallContent` | `ResponseFunctionCallArgumentsDeltaEvent` | Official |
|
|
| `FunctionResultContent` | `ResponseFunctionResultComplete` | Custom |
|
|
| `ErrorContent` | `ResponseErrorEvent` | Official |
|
|
| `UsageContent` | `ResponseUsageEventComplete` | Custom |
|
|
| `DataContent` | `ResponseTraceEventComplete` | Custom |
|
|
| `UriContent` | `ResponseTraceEventComplete` | Custom |
|
|
| `HostedFileContent` | `ResponseTraceEventComplete` | Custom |
|
|
| `HostedVectorStoreContent` | `ResponseTraceEventComplete` | Custom |
|
|
| `FunctionApprovalRequestContent` | Custom event | Custom |
|
|
| `FunctionApprovalResponseContent` | Custom event | Custom |
|
|
| `WorkflowEvent` | `ResponseWorkflowEventComplete` | Custom |
|
|
|
|
## Frontend Development
|
|
|
|
To build the frontend:
|
|
|
|
```bash
|
|
cd frontend
|
|
yarn install
|
|
|
|
# Create .env.local with backend URL
|
|
echo 'VITE_API_BASE_URL=http://localhost:8000' > .env.local
|
|
|
|
# Create .env.production (empty for relative URLs)
|
|
echo '' > .env.production
|
|
|
|
# Development
|
|
yarn dev
|
|
|
|
# Build (copies to backend)
|
|
yarn build
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
- **Missing API key**: Make sure your `.env` file is in the `python/` directory with valid credentials. Or set environment variables directly in your shell before running DevUI.
|
|
- **Import errors**: Run `uv sync --dev` again to ensure all dependencies are installed
|
|
- **Port conflicts**: DevUI uses ports 8080 and 8090 by default - close other services using these ports
|
|
|
|
Let me know if you run into any issues!
|