mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Jeff Handley
85484c0259
* Don't add OpenAIResponses as part of Dev UI You should be able to add and remove Dev UI without impacting your other production endpoints. * Remove `AddDevUI()` and do not map OpenAI endpoints from `MapDevUI()` * Fix comment wording * Revise documentation --------- Co-authored-by: Daniel Roth <daroth@microsoft.com>
61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
# DevUI Samples
|
|
|
|
This folder contains samples demonstrating how to use the DevUI in ASP.NET Core applications.
|
|
|
|
## What is DevUI?
|
|
|
|
The DevUI provides an interactive web interface for testing and debugging AI agents during development.
|
|
|
|
## Samples
|
|
|
|
### [DevUI_Step01_BasicUsage](./DevUI_Step01_BasicUsage)
|
|
|
|
Shows how to add DevUI to an ASP.NET Core application with multiple agents and workflows.
|
|
|
|
**Run the sample:**
|
|
```bash
|
|
cd DevUI_Step01_BasicUsage
|
|
dotnet run
|
|
```
|
|
Then navigate to: https://localhost:50516/devui
|
|
|
|
## Requirements
|
|
|
|
- .NET 8.0 or later
|
|
- ASP.NET Core
|
|
- Azure OpenAI credentials
|
|
|
|
## Quick Start
|
|
|
|
To add DevUI to your application:
|
|
|
|
```csharp
|
|
var builder = WebApplication.CreateBuilder(args);
|
|
|
|
// Set up the chat client
|
|
builder.Services.AddChatClient(chatClient);
|
|
|
|
// Register your agents
|
|
builder.AddAIAgent("my-agent", "You are a helpful assistant.");
|
|
|
|
// Register services for OpenAI responses and conversations (also required for DevUI)
|
|
builder.Services.AddOpenAIResponses();
|
|
builder.Services.AddOpenAIConversations();
|
|
|
|
var app = builder.Build();
|
|
|
|
// Map endpoints for OpenAI responses and conversations (also required for DevUI)
|
|
app.MapOpenAIResponses();
|
|
app.MapOpenAIConversations();
|
|
|
|
if (builder.Environment.IsDevelopment())
|
|
{
|
|
// Map DevUI endpoint to /devui
|
|
app.MapDevUI();
|
|
}
|
|
|
|
app.Run();
|
|
```
|
|
|
|
Then navigate to `/devui` in your browser.
|