اكتشاف الدليل

يمكن ل DevUI اكتشاف العوامل ومهام سير العمل تلقائيا من بنية الدليل. يمكنك هذا من تنظيم كيانات متعددة وتشغيلها جميعا باستخدام أمر واحد.

قريباً

ستتوفر وثائق DevUI ل C# قريبا. يرجى التحقق مرة أخرى لاحقا أو الرجوع إلى وثائق Python للحصول على إرشادات تصورية.

بنية الدليل

لكي يتم اكتشاف عواملك ومهام سير العمل بواسطة DevUI، يجب تنظيمها في بنية دليل معينة. يجب أن يكون لكل __init__.py كيان ملف يقوم بتصدير المتغير المطلوب (agent أو 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

مثال العامل

إنشاء دليل للوكيل الخاص بك مع المطلوب __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",
    client=OpenAIChatClient(),
    tools=[get_weather],
    instructions="You are a helpful weather assistant."
)

المطلب الرئيسي هو أن الملف يجب أن __init__.py يقوم بتصدير متغير يسمى agent (للوكلاء) أو workflow (لسير العمل).

مثال سير العمل

my_workflow/__init__.py:

from agent_framework import WorkflowBuilder, WorkflowContext, executor
from typing_extensions import Never


@executor(id="my_executor")
async def my_executor(message: str, ctx: WorkflowContext[Never, str]) -> None:
    await ctx.yield_output(message)


workflow = WorkflowBuilder(start_executor=my_executor).build()

متغيرات البيئة

يقوم DevUI تلقائيا بتحميل الملفات .env إذا كانت موجودة:

1. مستوى .envالكيان: تم وضعه في دليل العامل/سير العمل، محمل فقط لهذا الكيان
2. مستوى .envالأصل : وضع في الدليل الجذر للكيانات، محملة لجميع الكيانات

مثال .env على الملف:

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

Tip

.env.example إنشاء ملف لتوثيق متغيرات البيئة المطلوبة دون الكشف عن القيم الفعلية. لا تقم أبدا بتثبيت .env الملفات باستخدام بيانات اعتماد حقيقية للتحكم بالمصادر.

بدء التشغيل مع اكتشاف الدليل

بمجرد إعداد بنية الدليل، قم بتشغيل DevUI:

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

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

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

معرض العينات

عندما يبدأ DevUI بدون كيانات مكتشفة، فإنه يعرض معرض نماذج مع أمثلة منسقة من مستودع Agent Framework. بإمكانك:

• استعراض نماذج العوامل ومهام سير العمل المتوفرة
• تنزيل العينات لمراجعة وتخصيص
• تشغيل العينات محليا للبدء بسرعة

Troubleshooting

لم يتم اكتشاف الكيان

• تأكد من تصدير الملف __init__.py أو workflow متغيره agent
• التحقق من وجود أخطاء في بناء الجملة في ملفات Python
• تحقق من أن الدليل يقع مباشرة ضمن المسار الذي تم تمريره إلى devui

متغيرات البيئة غير محملة

• تأكد من أن .env الملف في الموقع الصحيح
• التحقق من أذونات الملف
• استخدام --reload العلامة لالتقاط التغييرات أثناء التطوير

Note

سيتوفر الدعم لهذه الميزة قريبا. راجع مستودع Agent Framework Go للحصول على أحدث حالة.

الخطوات التالية

• مرجع واجهة برمجة التطبيقات - تعرف على واجهة برمجة التطبيقات المتوافقة مع OpenAI
• التتبع وإمكانية المراقبة - تصحيح أخطاء وكلائك باستخدام التتبعات