مرجع API

يوفر DevUI واجهة برمجة تطبيقات استجابات متوافقة مع OpenAI، مما يسمح لك باستخدام OpenAI SDK أو أي عميل HTTP للتفاعل مع الوكلاء ومهام سير العمل.

قريباً

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

عنوان URL الأساسي

http://localhost:8080/v1

يمكن تكوين المنفذ باستخدام --port خيار CLI.

Authentication

بشكل افتراضي، لا تتطلب DevUI مصادقة للتطوير المحلي. عند التشغيل مع --auth، يلزم مصادقة الرمز المميز للحامل.

استخدام OpenAI SDK

الطلب الأساسي

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)

البث المباشر

response = client.responses.create(
    metadata={"entity_id": "weather_agent"},
    input="What's the weather in Seattle?",
    stream=True
)

for event in response:
    # Process streaming events
    print(event)

محادثات متعددة الأدوار

استخدم معلمة OpenAI conversation القياسية للمحادثات متعددة الأدوار:

# Create a conversation
conversation = client.conversations.create(
    metadata={"agent_id": "weather_agent"}
)

# First turn
response1 = client.responses.create(
    metadata={"entity_id": "weather_agent"},
    input="What's the weather in Seattle?",
    conversation=conversation.id
)

# Follow-up turn (continues the conversation)
response2 = client.responses.create(
    metadata={"entity_id": "weather_agent"},
    input="How about tomorrow?",
    conversation=conversation.id
)

تقوم DevUI باسترداد محفوظات رسائل المحادثة تلقائيا وتمريرها إلى العامل.

نقاط نهاية واجهة برمجة تطبيقات REST

واجهة برمجة تطبيقات الاستجابات (OpenAI Standard)

تنفيذ عامل أو سير عمل:

curl -X POST http://localhost:8080/v1/responses \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {"entity_id": "weather_agent"},
    "input": "What is the weather in Seattle?"
  }'

واجهة برمجة تطبيقات المحادثات (OpenAI Standard)

نقطة النهاية	الاسلوب	Description
/v1/conversations	منصب	إنشاء محادثة
/v1/conversations/{id}	GET	الحصول على تفاصيل المحادثة
/v1/conversations/{id}	منصب	تحديث بيانات تعريف المحادثة
/v1/conversations/{id}	DELETE	حذف محادثة
/v1/conversations?agent_id={id}	GET	سرد المحادثات (ملحق DevUI)
/v1/conversations/{id}/items	منصب	إضافة عناصر إلى المحادثة
/v1/conversations/{id}/items	GET	عناصر قائمة المحادثات
/v1/conversations/{id}/items/{item_id}	GET	الحصول على عنصر محادثة

إدارة الكيانات (ملحق DevUI)

نقطة النهاية	الاسلوب	Description
/v1/entities	GET	قائمة العوامل/مهام سير العمل المكتشفة
/v1/entities/{entity_id}/info	GET	الحصول على معلومات مفصلة عن الكيان
/v1/entities/{entity_id}/reload	منصب	وحدة إعادة التحميل السريع (وضع المطور)

فحص السلامة

curl http://localhost:8080/health

بيانات تعريف الخادم

الحصول على تكوين الخادم وقدراته:

curl http://localhost:8080/meta

ارجاع:

• ui_mode - الوضع الحالي (developer أو user)
• version - إصدار DevUI
• framework - اسم إطار العمل (agent_framework)
• runtime - وقت تشغيل الخلفية (python)
• capabilities - علامات الميزة (التتبع، وكيل OpenAI، التوزيع)
• auth_required - ما إذا كانت المصادقة ممكنة

تعيين الحدث

يقوم DevUI بتعيين أحداث إطار عمل العامل إلى أحداث واجهة برمجة تطبيقات استجابات OpenAI. يوضح الجدول أدناه التعيين:

أحداث دورة الحياة

حدث OpenAI	حدث إطار عمل العامل
response.created + response.in_progress	AgentStartedEvent
response.completed	AgentCompletedEvent
response.failed	AgentFailedEvent
response.created + response.in_progress	WorkflowEvent مع type="started"
response.completed	WorkflowEvent مع type="completed"
response.failed	WorkflowEvent مع type="failed"

أنواع المحتويات

حدث OpenAI	محتوى إطار عمل العامل
response.content_part.added + response.output_text.delta	Content(type="text")
response.reasoning_text.delta	Content(type="text_reasoning")
response.output_item.added	Content(type="function_call") (الحرف الأولي)
response.function_call_arguments.delta	Content(type="function_call") (args)
response.function_result.complete	Content(type="function_result")
response.output_item.added (صورة)	Content(type="data") (صور)
response.output_item.added (ملف)	Content(type="data") (ملفات)
error	Content(type="error")

أحداث سير العمل

حدث OpenAI	حدث إطار عمل العامل
response.output_item.added (ExecutorActionItem)	WorkflowEvent مع type="executor_invoked"
response.output_item.done (ExecutorActionItem)	WorkflowEvent مع type="executor_completed"
response.output_item.added (ResponseOutputMessage)	WorkflowEvent مع type="output"

ملحقات DevUI المخصصة

يضيف DevUI أنواع أحداث مخصصة للوظائف الخاصة ب Agent Framework:

• response.function_approval.requested - طلبات الموافقة على الدالة
• response.function_approval.responded - استجابات الموافقة على الدالة
• response.function_result.complete - نتائج تنفيذ الدالة من جانب الخادم
• response.workflow_event.completed - أحداث سير العمل
• response.trace.complete - تتبعات التنفيذ

يتم مساحات أسماء هذه الملحقات المخصصة ويمكن تجاهلها بأمان من قبل عملاء OpenAI القياسيين.

وضع وكيل OpenAI

يوفر DevUI ميزة وكيل OpenAI لاختبار نماذج OpenAI مباشرة من خلال الواجهة دون إنشاء وكلاء مخصصين. تمكين عبر الإعدادات في واجهة المستخدم.

curl -X POST http://localhost:8080/v1/responses \
  -H "X-Proxy-Backend: openai" \
  -d '{"model": "gpt-4.1-mini", "input": "Hello"}'

Note

يتطلب OPENAI_API_KEY وضع الوكيل متغير بيئة تم تكوينه على الواجهة الخلفية.

Note

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

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

• التتبع وقابلية المراقبة - عرض تتبعات لتصحيح الأخطاء
• الأمان والنشر - تأمين توزيع DevUI الخاص بك