Aracılığıyla paylaş

API Referansı

DevUI, aracılarınız ve iş akışlarınızla etkileşime geçmek için OpenAI SDK'sını veya herhangi bir HTTP istemcisini kullanmanıza olanak sağlayan OpenAI uyumlu bir Yanıtlar API'sini sağlar.

Çok Yakında

C# için DevUI belgeleri yakında kullanıma sunulacaktır. Kavramsal yönergeler için lütfen daha sonra tekrar kontrol edin veya Python belgelerine bakın.

Temel URL

http://localhost:8080/v1

Bağlantı noktası CLI seçeneğiyle --port yapılandırılabilir.

Authentication

Varsayılan olarak DevUI, yerel geliştirme için kimlik doğrulaması gerektirmez. ile --authçalışırken Taşıyıcı belirteci kimlik doğrulaması gerekir.

OpenAI SDK'sını kullanma

Temel İstek

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)

Yayın

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)

Çok Aşamalı Konuşmalar

Çok aşamalı konuşmalar için standart OpenAI conversation parametresini kullanın:

# 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 konuşmanın ileti geçmişini otomatik olarak alır ve aracıya geçirir.

REST API Uç Noktaları

Yanıtlar API'si (OpenAI Standard)

Aracı veya iş akışı yürütme:

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?"
  }'

Konuşmalar API'si (OpenAI Standard)

Bitiş noktası Yöntem Description
/v1/conversations PAYLAŞ Konuşma oluşturma
/v1/conversations/{id} GET Konuşma ayrıntılarını alma
/v1/conversations/{id} PAYLAŞ Konuşma meta verilerini güncelleştirme
/v1/conversations/{id} DELETE Konuşmayı silme
/v1/conversations?agent_id={id} GET Konuşmaları listeleme (DevUI uzantısı)
/v1/conversations/{id}/items PAYLAŞ Konuşmaya öğe ekleme
/v1/conversations/{id}/items GET Konuşma öğelerini listeleme
/v1/conversations/{id}/items/{item_id} GET Konuşma öğesi alma

Varlık Yönetimi (DevUI Uzantısı)

Bitiş noktası Yöntem Description
/v1/entities GET Bulunan aracıları/iş akışlarını listeleme
/v1/entities/{entity_id}/info GET Ayrıntılı varlık bilgilerini alma
/v1/entities/{entity_id}/reload PAYLAŞ Sık erişimli yeniden yükleme varlığı (geliştirici modu)

Sistem Durumu Denetimi

curl http://localhost:8080/health

Sunucu Meta Verileri

Sunucu yapılandırmasını ve özelliklerini alma:

curl http://localhost:8080/meta

İadeler

  • ui_mode - Geçerli mod (developer veya user)
  • version - DevUI sürümü
  • framework - Çerçeve adı (agent_framework)
  • runtime - Arka uç çalışma zamanı (python)
  • capabilities - Özellik bayrakları (izleme, OpenAI ara sunucusu, dağıtım)
  • auth_required - Kimlik doğrulamasının etkinleştirilip etkinleştirilmediği

Olay Eşleme

DevUI, Agent Framework olaylarını OpenAI Yanıtları API olaylarıyla eşler. Aşağıdaki tabloda eşleme gösterilmektedir:

Yaşam Döngüsü Olayları

OpenAI Olayı Agent Framework Olayı
response.created + response.in_progress AgentStartedEvent
response.completed AgentCompletedEvent
response.failed AgentFailedEvent
response.created + response.in_progress WorkflowStartedEvent
response.completed WorkflowCompletedEvent
response.failed WorkflowFailedEvent

İçerik Türleri

OpenAI Olayı Agent Framework İçeriği
response.content_part.added + response.output_text.delta TextContent
response.reasoning_text.delta TextReasoningContent
response.output_item.added FunctionCallContent (başlangıç)
response.function_call_arguments.delta FunctionCallContent (args)
response.function_result.complete FunctionResultContent
response.output_item.added (resim) DataContent (görüntüler)
response.output_item.added (dosya) DataContent (dosyalar)
error ErrorContent

İş Akışı Olayları

OpenAI Olayı Agent Framework Olayı
response.output_item.added (YürütücüActionItem) WorkflowEvent ile type="executor_invoked"
response.output_item.done (YürütücüActionItem) WorkflowEvent ile type="executor_completed"
response.output_item.added (ResponseOutputMessage) WorkflowEvent ile type="output"

DevUI Özel Uzantıları

DevUI, Agent Framework'e özgü işlevler için özel olay türleri ekler:

  • response.function_approval.requested - İşlev onay istekleri
  • response.function_approval.responded - İşlev onayı yanıtları
  • response.function_result.complete - Sunucu tarafı işlev yürütme sonuçları
  • response.workflow_event.complete - İş akışı olayları
  • response.trace.complete - Yürütme izlemeleri

Bu özel uzantılar ad alanıdır ve standart OpenAI istemcileri tarafından güvenle yoksayılabilir.

OpenAI Proxy Modu

DevUI, OpenAI modellerini özel aracılar oluşturmadan doğrudan arabirim üzerinden test eden bir OpenAI Proxy özelliği sağlar. Kullanıcı arabirimindeki Ayarlar aracılığıyla etkinleştirin.

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

Uyarı

Ara sunucu modu, arka uçta yapılandırılmış ortam değişkeni gerektirir OPENAI_API_KEY .

Sonraki Adımlar

  • Last updated on