Bagikan melalui

Penemuan Direktori

DevUI dapat secara otomatis menemukan agen dan alur kerja dari struktur direktori. Ini memungkinkan Anda untuk mengatur beberapa entitas dan meluncurkan semuanya dengan satu perintah.

Segera hadir

Dokumentasi DevUI untuk C# akan segera hadir. Silakan periksa kembali nanti atau lihat dokumentasi Python untuk panduan konseptual.

Struktur Direktori

Agar agen dan alur kerja Anda ditemukan oleh DevUI, mereka harus diatur dalam struktur direktori tertentu. Setiap entitas harus memiliki __init__.py file yang mengekspor variabel yang diperlukan (agent atau 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

Contoh Agen

Buat direktori untuk agen Anda dengan file yang diperlukan __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."
)

Persyaratan utama adalah bahwa __init__.py file harus mengekspor variabel bernama agent (untuk agen) atau workflow (untuk alur kerja).

Contoh Alur Kerja

my_workflow/__init__.py:

from agent_framework.workflows import WorkflowBuilder

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

Variabel Lingkungan

DevUI secara otomatis memuat .env file jika ada:

  1. Tingkat .enventitas : Ditempatkan di direktori agen/alur kerja, dimuat hanya untuk entitas tersebut
  2. Tingkat .envinduk : Ditempatkan di direktori akar entitas, dimuat untuk semua entitas

Contoh .env file:

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

Petunjuk / Saran

Buat file untuk mendokumentasikan variabel lingkungan yang diperlukan tanpa mengekspos nilai sebenarnya. Jangan pernah mengunggah .env file dengan kredensial nyata ke sistem pengendalian versi.

Peluncuran dengan Penemuan Direktori

Setelah struktur direktori Anda disiapkan, luncurkan DevUI:

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

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

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

Ketika DevUI dimulai tanpa entitas yang ditemukan, DevUI menampilkan galeri sampel dengan contoh yang dikumpulkan dari repositori Kerangka Kerja Agen. Kamu bisa:

  • Telusuri agen sampel dan alur kerja yang tersedia
  • Mengunduh sampel untuk ditinjau dan disesuaikan
  • Jalankan sampel secara lokal untuk memulai dengan cepat

Troubleshooting

Entitas tidak ditemukan

  • Pastikan file __init__.py mengekspor variabel agent atau workflow
  • Periksa kesalahan sintaks dalam file Python Anda
  • Verifikasi bahwa direktori berada langsung di bawah jalur yang diteruskan ke devui

Variabel lingkungan tidak dimuat

  • .env Pastikan file berada di lokasi yang benar
  • Periksa izin file
  • Gunakan --reload flag untuk mendeteksi perubahan selama pengembangan

Langkah Selanjutnya

  • Last updated on