Testowanie za pomocą AG-UI Dojo

AplikacjaAG-UI Dojo udostępnia interaktywne środowisko do testowania i eksplorowania agentów programu Microsoft Agent Framework, którzy implementują protokół AG-UI. Dojo oferuje wizualny interfejs umożliwiający łączenie się z agentami i interakcję ze wszystkimi 7 AG-UI funkcjami.

Wymagania wstępne

Przed rozpoczęciem upewnij się, że masz:

• Środowisko Python w wersji 3.10 lub nowszej
• uv do zarządzania zależnościami
• Klucz interfejsu API openAI lub punkt końcowy usługi Azure OpenAI
• Node.js i pnpm (na potrzeby uruchamiania frontonu Dojo)

Instalacja

1. Sklonuj repozytorium AG-UI

Najpierw sklonuj repozytorium AG-UI zawierające aplikację Dojo i przykłady integracji z programem Microsoft Agent Framework:

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

2. Przejdź do katalogu Przykłady

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

3. Instalowanie zależności języka Python

Użyj uv, aby zainstalować wymagane zależności.

uv sync

4. Konfigurowanie zmiennych środowiskowych

.env Utwórz plik na podstawie podanego szablonu:

cp .env.example .env

Edytuj plik .env i dodaj poświadczenia API.

# 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

Uwaga / Notatka

W przypadku używania elementu DefaultAzureCredential zamiast api_key do uwierzytelniania, upewnij się, że jesteś uwierzytelniony na platformie Azure (np. za pomocą az login). Aby uzyskać więcej informacji, zobacz dokumentację usługi Azure Identity.

Uruchamianie aplikacji Dojo

1. Uruchamianie serwera zaplecza

W katalogu examples uruchom serwer zaplecza przy użyciu przykładowych agentów:

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

Serwer zostanie domyślnie uruchomiony http://localhost:8888 .

2. Uruchamianie frontonu Dojo

Otwórz nowe okno terminalu, przejdź do katalogu głównego repozytorium AG-UI, a następnie do katalogu aplikacji Dojo:

cd apps/dojo
pnpm install
pnpm dev

Fronton Dojo będzie dostępny pod adresem http://localhost:3000.

3. Nawiązywanie połączenia z agentem

1. Otwórz http://localhost:3000 w przeglądarce

2. Konfigurowanie adresu URL serwera do http://localhost:8888

3. Wybierz pozycję "Microsoft Agent Framework (Python)" z listy rozwijanej

4. Rozpocznij eksplorowanie przykładowych agentów

Dostępni przykładowi agenci

Przykłady integracji przedstawiają wszystkie 7 funkcji AG-UI za pośrednictwem różnych punktów końcowych agentów.

Endpoint	Funkcja	Description
/agentic_chat	Funkcja 1. Czat agenta	Podstawowy agent konwersacyjny z wywoływaniem narzędzi
/backend_tool_rendering	Funkcja 2. Renderowanie narzędzi zaplecza	Agent z niestandardowym renderowaniem interfejsu użytkownika narzędzia
/human_in_the_loop	Funkcja 3. Człowiek w pętli	Agent z workflowami zatwierdzania
/agentic_generative_ui	Funkcja 4: Interfejs użytkownika generatywnego agencji	Agent, który dzieli zadania na kroki z uaktualnieniami przesyłanymi strumieniowo
/tool_based_generative_ui	Funkcja 5: Generatywny interfejs użytkownika oparty na narzędziach	Agent, który generuje niestandardowe składniki interfejsu użytkownika
/shared_state	Funkcja 6. Stan udostępniony	Agent z synchronizacją stanu dwukierunkowego
/predictive_state_updates	Funkcja 7. Aktualizacje stanu predykcyjnego	Agent z aktualizacjami stanu predykcyjnego podczas wykonywania narzędzia

Testowanie własnych agentów

Aby przetestować własnych agentów za pomocą narzędzia Dojo:

1. Tworzenie agenta

Utwórz nowego agenta zgodnie z przewodnikiem Wprowadzenie :

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. Dodaj agenta do serwera

W aplikacji FastAPI zarejestruj punkt końcowy agenta:

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. Testowanie w dojo

1. Uruchamianie serwera
2. Otwórz witrynę Dojo pod adresem http://localhost:3000
3. Ustaw adres URL serwera na http://localhost:8888
4. Agent pojawi się na liście rozwijanej punktów końcowych jako "my_agent"
5. Wybierz go i rozpocznij testowanie

Struktura projektu

Przykłady integracji repozytorium AG-UI są zgodne z tą strukturą:

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

Rozwiązywanie problemów

Problemy z połączeniem serwera

Jeśli usługa Dojo nie może nawiązać połączenia z serwerem:

• Sprawdź, czy serwer jest uruchomiony na poprawnym porcie (wartość domyślna: 8888)
• Sprawdź, czy adres URL serwera w usłudze Dojo jest zgodny z adresem serwera
• Upewnij się, że żadna zapora nie blokuje połączenia
• Wyszukaj błędy MECHANIZMU CORS w konsoli przeglądarki

Agent się nie pojawia

Jeśli agent nie jest wyświetlany w menu rozwijanym Dojo:

• Sprawdź, czy punkt końcowy agenta jest poprawnie zarejestrowany
• Sprawdzanie dzienników serwera pod kątem błędów uruchamiania
• Upewnij się, że wywołanie add_agent_framework_fastapi_endpoint zostało ukończone pomyślnie

Problemy ze zmienną środowiskową

Jeśli zobaczysz błędy uwierzytelniania:

• Sprawdź, czy plik .env znajduje się w poprawnym katalogu.
• Sprawdź, czy ustawiono wszystkie wymagane zmienne środowiskowe
• Upewnij się, że klucze interfejsu API i punkty końcowe są prawidłowe
• Uruchom ponownie serwer po zmianie zmiennych środowiskowych

Dalsze kroki

• Eksplorowanie przykładowych agentów w celu wyświetlenia wzorców implementacji
• Dowiedz się więcej o renderowaniu narzędzi zaplecza w celu dostosowania interfejsów użytkownika narzędzi

Dodatkowe zasoby

• DokumentacjaAG-UI

• Repozytorium AG-UI na GitHubie

• Aplikacja Dojo

• Przykłady integracji z programem Microsoft Agent Framework

Wkrótce.