Compartir a través de

Detección de directorios

DevUI puede detectar automáticamente agentes y flujos de trabajo de una estructura de directorios. Esto le permite organizar varias entidades e iniciarlas todas con un solo comando.

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.

Estructura de directorios

Para que DevUI detecte los agentes y los flujos de trabajo, deben organizarse en una estructura de directorio específica. Cada entidad debe tener un __init__.py archivo que exporte la variable necesaria (agent o workflow).

entities/
    weather_agent/
        __init__.py      # Must export: agent = Agent(...)
        agent.py         # Agent implementation (optional, can be in __init__.py)
        .env             # Optional: API keys, config vars
    my_workflow/
        __init__.py      # Must export: workflow = WorkflowBuilder(start_executor=...)...
        workflow.py      # Workflow implementation (optional)
        .env             # Optional: environment variables
    .env                 # Optional: shared environment variables

Ejemplo del agente

Cree un directorio para su agente con el requerido __init__.py.

weather_agent/__init__.py:

from agent_framework import Agent
from agent_framework.openai import OpenAIChatClient

def get_weather(location: str) -> str:
    """Get weather for a location."""
    return f"Weather in {location}: 72F and sunny"

agent = Agent(
    name="weather_agent",
    chat_client=OpenAIChatClient(),
    tools=[get_weather],
    instructions="You are a helpful weather assistant."
)

El requisito clave es que el __init__.py archivo debe exportar una variable denominada agent (para agentes) o workflow (para flujos de trabajo).

Ejemplo de flujo de trabajo

my_workflow/__init__.py:

from agent_framework.workflows import WorkflowBuilder

workflow = (
    WorkflowBuilder(start_executor="my_executor")
    .add_executor(...)
    .add_edge(...)
    .build()
)

Variables de entorno

DevUI carga .env automáticamente los archivos si están presentes:

  1. .envNivel de entidad: se coloca en el directorio agent/workflow, cargado solo para esa entidad.
  2. Nivel de entidad principal .env: se coloca en el directorio raíz de entidades, se carga para todas las entidades.

Archivo .env de ejemplo:

OPENAI_API_KEY=sk-...
AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com/

Sugerencia

Cree un .env.example archivo para documentar las variables de entorno necesarias sin exponer valores reales. Nunca añada archivos .env con credenciales reales al control de código fuente.

Inicio con detección de directorios

Una vez configurada la estructura de directorios, inicie DevUI:

# Discover all entities in ./entities directory
devui ./entities

# With custom port
devui ./entities --port 9000

# With auto-reload for development
devui ./entities --reload

Cuando DevUI comienza sin entidades detectadas, muestra una galería de ejemplo con ejemplos seleccionados del repositorio de Agent Framework. Ustedes pueden:

  • Examinar los flujos de trabajo y agentes de ejemplo disponibles
  • Descarga de ejemplos para revisar y personalizar
  • Ejecutar muestras localmente para comenzar rápidamente

Solución de problemas

Entidad no detectada

  • Asegúrese de que el archivo __init__.py exporte agent o la variable workflow
  • Comprobación de errores de sintaxis en los archivos de Python
  • Verifique que el directorio esté directamente bajo la ruta que se pasa a devui

Variables de entorno no cargadas

  • Asegúrese de que el .env archivo está en la ubicación correcta.
  • Comprueba los permisos de archivo
  • Usar --reload indicador para recoger los cambios durante el desarrollo

Pasos siguientes

  • Last updated on