Delen via

Testen met AG-UI Dojo

De AG-UI Dojo-toepassing biedt een interactieve omgeving voor het testen en verkennen van Microsoft Agent Framework-agents die het AG-UI-protocol implementeren. Dojo biedt een visuele interface om verbinding te maken met uw agents en te communiceren met alle 7 AG-UI functies.

Vereiste voorwaarden

Voordat u begint, moet u ervoor zorgen dat u het volgende hebt:

  • Python 3.10 of hoger
  • uv voor afhankelijkheidsbeheer
  • Een OpenAI API-sleutel of Azure OpenAI-eindpunt
  • Node.js en pnpm (voor het uitvoeren van de Dojo-front-end)

Installatie

1. Kloon de AG-UI Opslagplaats

Kloon eerst de AG-UI opslagplaats die de Dojo-toepassing en Microsoft Agent Framework-integratievoorbeelden bevat:

git clone https://github.com/ag-oss/ag-ui.git
cd ag-ui

2. Navigeer naar de directory Voorbeelden

cd integrations/microsoft-agent-framework/python/examples

3. Python-afhankelijkheden installeren

Gebruik uv dit om de vereiste afhankelijkheden te installeren:

uv sync

4. Omgevingsvariabelen configureren

Maak een .env bestand op basis van de opgegeven sjabloon:

cp .env.example .env

Bewerk het .env bestand en voeg uw API-referenties toe:

# 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

Opmerking

Als u DefaultAzureCredential in plaats van een api_key gebruikt voor verificatie, controleer of u bent geverifieerd met Azure, bijvoorbeeld via az login. Zie de Documentatie voor Azure Identity voor meer informatie.

De Dojo-toepassing uitvoeren

1. De back-endserver starten

Start in de voorbeeldenmap de back-endserver met de voorbeeldagents:

cd integrations/microsoft-agent-framework/python/examples
uv run dev

De server wordt standaard opgestart op http://localhost:8888.

2. Start de Dojo Frontend

Open een nieuw terminalvenster, navigeer naar de hoofdmap van de AG-UI opslagplaats en ga vervolgens naar de map van de Dojo-toepassing:

cd apps/dojo
pnpm install
pnpm dev

De Dojo-front-end is beschikbaar op http://localhost:3000.

3. Verbinding maken met uw agent

  1. Openen http://localhost:3000 in uw browser

  2. De server-URL configureren voor http://localhost:8888

  3. Selecteer Microsoft Agent Framework (Python) in de vervolgkeuzelijst

  4. Begin met het verkennen van de voorbeeldagenten

Beschikbare voorbeeldagenten

De integratievoorbeelden laten alle 7 AG-UI functies zien via verschillende agenteindpunten:

Eindpunt Feature Description
/agentic_chat Functie 1: Agentic Chat Basisgespreksagent met aanroepen van hulpprogramma's
/backend_tool_rendering Functie 2: Rendering van backendsysteemhulpprogramma Agent met aangepaste weergave van de gebruikersinterface van het hulpprogramma
/human_in_the_loop Functie 3: Menselijke tussenkomst. Agent met goedkeuringswerkstromen
/agentic_generative_ui Functie 4: Agentische Generatieve UI Agent die taken opsplitst in stappen met doorlopende updates
/tool_based_generative_ui Functie 5: Op hulpprogramma's gebaseerde generatieve gebruikersinterface Agent waarmee aangepaste UI-onderdelen worden gegenereerd
/shared_state Kenmerk 6: Gedeelde status Agent met synchronisatie van bidirectionele status
/predictive_state_updates Functie 7: Voorspellende statusupdates Agent met voorspellende statusupdates tijdens het uitvoeren van het hulpprogramma

Uw eigen agents testen

Uw eigen agents testen met Dojo:

1. Uw agent maken

Maak een nieuwe agent aan de hand van de introductiehandleiding :

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. De agent toevoegen aan uw server

Registreer het agenteindpunt in uw FastAPI-toepassing:

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. Testen in Dojo

  1. De server starten
  2. Open Dojo op http://localhost:3000
  3. De server-URL instellen op http://localhost:8888
  4. Uw agent wordt weergegeven in de eindpuntenvervolgkeuzelijst als 'my_agent'
  5. Selecteer deze en begin met testen

Projectstructuur

De integratievoorbeelden van de AG-UI-opslagplaats volgen deze structuur:

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

Probleemoplossingsproces

Verbindingsproblemen met de server

Als Dojo geen verbinding kan maken met uw server:

  • Controleer of de server wordt uitgevoerd op de juiste poort (standaard: 8888)
  • Controleer of de server-URL in Dojo overeenkomt met uw serveradres
  • Zorg ervoor dat de verbinding niet wordt geblokkeerd door een firewall
  • Zoeken naar CORS-fouten in de browserconsole

Agent wordt niet weergegeven

Als uw agent niet wordt weergegeven in de vervolgkeuzelijst Dojo:

  • Controleer of het eindpunt van de agent juist is geregistreerd
  • Serverlogboeken controleren op opstartfouten
  • Controleren of de add_agent_framework_fastapi_endpoint aanroep is voltooid

Problemen met omgevingsvariabelen

Als u authenticatiefouten ziet:

  • Controleer of het .env bestand zich in de juiste map bevindt
  • Controleer of alle vereiste omgevingsvariabelen zijn ingesteld
  • Zorg ervoor dat API-sleutels en -eindpunten geldig zijn
  • Start de server opnieuw op nadat u omgevingsvariabelen hebt gewijzigd

Volgende stappen

Aanvullende informatiebronnen

Binnenkort beschikbaar.

  • Last updated on