Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
DevUI es una aplicación de ejemplo ligera e independiente para ejecutar agentes y flujos de trabajo en Microsoft Agent Framework. Proporciona una interfaz web para pruebas interactivas junto con un back-end de API compatible con OpenAI, lo que le permite depurar, probar e iterar visualmente en agentes y flujos de trabajo que se compilan antes de integrarlos en las aplicaciones.
Importante
DevUI es una aplicación de ejemplo que le ayuda a visualizar y depurar los agentes y flujos de trabajo durante el desarrollo. No está pensado para su uso en producción.
Próximamente.
La documentación de DevUI para C# estará disponible próximamente. Por favor, vuelva a comprobar más tarde o consulte la documentación de Python para obtener instrucciones conceptuales.
Características
- Interfaz web: interfaz de usuario interactiva para probar agentes y flujos de trabajo
- Tipos de entrada flexibles: compatibilidad con tipos de entrada personalizados, cargas de archivos y texto en función del primer ejecutor del flujo de trabajo
- Descubrimiento Basado en Directorio: descubrir automáticamente agentes y flujos de trabajo de una estructura de directorios
- Registro en memoria: registrar entidades mediante programación sin necesidad de configurar el sistema de archivos
- OpenAI-Compatible API: uso del SDK de Python de OpenAI para interactuar con los agentes
- Galería de Muestras: explorar y descargar ejemplos seleccionados cuando no se descubren entidades
- Seguimiento: visualización de seguimientos de OpenTelemetry para la depuración y la observabilidad
Tipos de entrada
DevUI adapta su interfaz de entrada en función del tipo de entidad:
- Agentes: admiten la entrada de texto y los datos adjuntos de archivos (imágenes, documentos, etc.) para interacciones multimodales.
- Flujos de trabajo: la interfaz de entrada se genera automáticamente en función del tipo de entrada del primer ejecutor. DevUI introduce el flujo de trabajo y refleja el esquema de entrada esperado, lo que facilita la prueba de flujos de trabajo con tipos de entrada estructurados o personalizados.
Este control de entrada dinámico permite probar los agentes y los flujos de trabajo exactamente igual que recibirían entradas en la aplicación.
Installation
Instale DevUI desde PyPI:
pip install agent-framework-devui --pre
Quick Start
Opción 1: Registro mediante programación
Inicie DevUI con agentes registrados en memoria:
from agent_framework import Agent
from agent_framework.openai import OpenAIChatClient
from agent_framework.devui import serve
def get_weather(location: str) -> str:
"""Get weather for a location."""
return f"Weather in {location}: 72F and sunny"
# Create your agent
agent = Agent(
name="WeatherAgent",
chat_client=OpenAIChatClient(),
tools=[get_weather]
)
# Launch DevUI
serve(entities=[agent], auto_open=True)
# Opens browser to http://localhost:8080
Opción 2: Detección de directorios (CLI)
Si tiene agentes y flujos de trabajo organizados en una estructura de directorios, inicie DevUI desde la línea de comandos:
# Launch web UI + API server
devui ./agents --port 8080
# Web UI: http://localhost:8080
# API: http://localhost:8080/v1/*
Consulte Detección de directorios para obtener más información sobre la estructura de directorios necesaria.
Uso del SDK de OpenAI
DevUI proporciona una API de respuestas compatibles con OpenAI. Puede usar el SDK de Python de OpenAI para interactuar con los agentes:
from openai import OpenAI
client = OpenAI(
base_url="http://localhost:8080/v1",
api_key="not-needed" # API key not required for local DevUI
)
response = client.responses.create(
metadata={"entity_id": "weather_agent"}, # Your agent/workflow name
input="What's the weather in Seattle?"
)
# Extract text from response
print(response.output[0].content[0].text)
Para más información sobre la API, consulte Referencia de API.
Opciones de la CLI
devui [directory] [options]
Options:
--port, -p Port (default: 8080)
--host Host (default: 127.0.0.1)
--headless API only, no UI
--no-open Don't automatically open browser
--tracing Enable OpenTelemetry tracing
--reload Enable auto-reload
--mode developer|user (default: developer)
--auth Enable Bearer token authentication
--auth-token Custom authentication token
Pasos siguientes
- Detección de directorios : aprenda a estructurar los agentes para la detección automática
- Referencia de API : exploración de los puntos de conexión de API compatibles con OpenAI
- Seguimiento y observabilidad : ver seguimientos de OpenTelemetry en DevUI
- Seguridad e implementación : procedimientos recomendados para proteger DevUI
- Ejemplos - Explorar agentes y flujos de trabajo de ejemplo