Not
Åtkomst till denna sida kräver auktorisation. Du kan prova att logga in eller byta katalog.
Åtkomst till denna sida kräver auktorisation. Du kan prova att byta katalog.
ProgrammetAG-UI Dojo tillhandahåller en interaktiv miljö för att testa och utforska Microsoft Agent Framework-agenter som implementerar AG-UI-protokollet. Dojo erbjuder ett visuellt gränssnitt för att ansluta till dina agenter och interagera med alla 7 AG-UI funktioner.
Förutsättningar
Kontrollera att du har följande innan du börjar:
- Python 3.10 eller senare
- uv för beroendehantering
- En OpenAI API-nyckel eller Azure OpenAI-slutpunkt
- Node.js och pnpm (för att köra Dojo-klientdelen)
Installation
1. Klona AG-UI-lagringsplatsen
Klona först den AG-UI lagringsplatsen som innehåller Dojo-programmet och Microsoft Agent Framework-integreringsexempel:
git clone https://github.com/ag-oss/ag-ui.git
cd ag-ui
2. Navigera till Exempelkatalog
cd integrations/microsoft-agent-framework/python/examples
3. Installera beroenden för Python
Använd uv för att installera nödvändiga beroenden:
uv sync
4. Konfigurera miljövariabler
Skapa en .env fil från den angivna mallen:
cp .env.example .env
.env Redigera filen och lägg till dina API-autentiseringsuppgifter:
# For OpenAI
OPENAI_API_KEY=your_api_key_here
OPENAI_CHAT_MODEL_ID="gpt-4.1"
# Or for Azure OpenAI
AZURE_OPENAI_ENDPOINT=your_endpoint_here
AZURE_OPENAI_API_KEY=your_api_key_here
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME=your_deployment_here
Anmärkning
Om du använder DefaultAzureCredential, istället för en api_key för autentisering, kontrollera att du är autentiserad med Azure (t.ex. via az login). Mer information finns i dokumentationen om Azure Identity.
Köra Dojo-programmet
Starta backend-servern
I exempelkatalogen, starta bakgrundsservern med exempelagenterna.
cd integrations/microsoft-agent-framework/python/examples
uv run dev
Servern kommer att starta på http://localhost:8888 som standard.
2. Starta Dojo-klientdelen
Öppna ett nytt terminalfönster, navigera till roten på AG-UI-lagringsplatsen och gå sedan till Dojo-programkatalogen:
cd apps/dojo
pnpm install
pnpm dev
Dojo-klientdelen kommer att vara tillgänglig på http://localhost:3000.
3. Anslut till din agent
Öppna
http://localhost:3000i webbläsarenKonfigurera server-URL:en till
http://localhost:8888Välj "Microsoft Agent Framework (Python)" i listrutan
Börja utforska exempelagenterna
Tillgängliga exempelagenter
Integreringsexemplen visar alla 7 AG-UI funktioner via olika agentslutpunkter:
| Endpoint | Egenskap | Description |
|---|---|---|
/agentic_chat |
Funktion 1: Agentisk chatt | Grundläggande konversationsagent med verktygsanrop |
/backend_tool_rendering |
Funktion 2: Återgivning av Backend-verktyg | Agent med anpassad verktygsgränssnittsrendering |
/human_in_the_loop |
Funktion 3: Människa i loopet | Agent med arbetsflöden för godkännande |
/agentic_generative_ui |
Funktion 4: Agentic Generative UI | Agent som delar upp uppgifter i steg med strömmande uppdateringar |
/tool_based_generative_ui |
Funktion 5: Verktygsbaserat generativt användargränssnitt | Agent som genererar anpassade gränssnittskomponenter |
/shared_state |
Funktion 6: Delat tillstånd | Agent med dubbelriktad tillståndssynkronisering |
/predictive_state_updates |
Funktion 7: Uppdateringar av förutsägande tillstånd | Agent med prediktiva tillståndsuppdateringar under verktygskörning |
Testa dina egna agenter
Så här testar du dina egna agenter med Dojo:
1. Skapa din agent
Skapa en ny agent enligt guiden Komma igång :
from agent_framework import Agent
from agent_framework_azure_ai import AzureOpenAIChatClient
# Create your agent
chat_client = AzureOpenAIChatClient(
endpoint=os.getenv("AZURE_OPENAI_ENDPOINT"),
api_key=os.getenv("AZURE_OPENAI_API_KEY"),
deployment_name=os.getenv("AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"),
)
agent = Agent(
name="my_test_agent",
chat_client=chat_client,
system_message="You are a helpful assistant.",
)
2. Lägg till agenten på servern
I ditt FastAPI-program registrerar du agentslutpunkten:
from fastapi import FastAPI
from agent_framework_ag_ui import add_agent_framework_fastapi_endpoint
import uvicorn
app = FastAPI()
# Register your agent
add_agent_framework_fastapi_endpoint(
app=app,
path="/my_agent",
agent=agent,
)
if __name__ == "__main__":
uvicorn.run(app, host="127.0.0.1", port=8888)
3. Test i Dojo
- Starta servern
- Öppna Dojo på
http://localhost:3000 - Ange serverns URL till
http://localhost:8888 - Din agent visas i listrutan för slutpunkten som "my_agent"
- Välj den och börja testa
Projektstruktur
Integreringsexemplen för AG-UI-lagringsplatsen följer den här strukturen:
integrations/microsoft-agent-framework/python/examples/
├── agents/
│ ├── agentic_chat/ # Feature 1: Basic chat agent
│ ├── backend_tool_rendering/ # Feature 2: Backend tool rendering
│ ├── human_in_the_loop/ # Feature 3: Human-in-the-loop
│ ├── agentic_generative_ui/ # Feature 4: Streaming state updates
│ ├── tool_based_generative_ui/ # Feature 5: Custom UI components
│ ├── shared_state/ # Feature 6: Bidirectional state sync
│ ├── predictive_state_updates/ # Feature 7: Predictive state updates
│ └── dojo.py # FastAPI application setup
├── pyproject.toml # Dependencies and scripts
├── .env.example # Environment variable template
└── README.md # Integration examples documentation
Felsökning
Problem med serveranslutning
Om Dojo inte kan ansluta till servern:
- Kontrollera att servern körs på rätt port (standard: 8888)
- Kontrollera att server-URL:en i Dojo matchar din serveradress
- Kontrollera att ingen brandvägg blockerar anslutningen
- Leta efter CORS-fel i webbläsarkonsolen
Agenten visas inte
Om din agent inte visas i listrutan Dojo:
- Kontrollera att agentslutpunkten är korrekt registrerad
- Kontrollera om det finns startfel i serverloggarna
- Kontrollera att anropet
add_agent_framework_fastapi_endpointhar slutförts
Problem med miljövariabler
Om du ser autentiseringsfel:
-
.envKontrollera att filen finns i rätt katalog - Kontrollera att alla nödvändiga miljövariabler har angetts
- Kontrollera att API-nycklar och slutpunkter är giltiga
- Starta om servern efter att du har ändrat miljövariabler
Nästa steg
- Utforska exempelagenterna för att se implementeringsmönster
- Lär dig mer om bakgrundsverktygsrendering för att anpassa verktygsgränssnitt.
Ytterligare resurser
Kommer snart.