Bagikan melalui

Referensi API

DevUI menyediakan API Respons yang kompatibel dengan OpenAI, memungkinkan Anda menggunakan OpenAI SDK atau klien HTTP apa pun untuk berinteraksi dengan agen dan alur kerja Anda.

Segera hadir

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

URL Dasar

http://localhost:8080/v1

Port dapat dikonfigurasi dengan --port opsi CLI.

Authentication

Secara default, DevUI tidak memerlukan autentikasi untuk pengembangan lokal. Saat berjalan dengan --auth, autentikasi token Pembawa diperlukan.

Menggunakan OpenAI SDK

Permintaan Dasar

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)

Siaran Langsung

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)

Percakapan Multi-giliran

Gunakan parameter OpenAI conversation standar untuk percakapan multi-giliran:

# 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 secara otomatis mengambil riwayat pesan percakapan dan meneruskannya ke agen.

Titik Akhir REST API

Responses API (OpenAI Standard)

Jalankan agen atau alur kerja:

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

API Percakapan (OpenAI Standard)

Titik akhir Metode Deskripsi
/v1/conversations PENGUMUMAN Membuat percakapan
/v1/conversations/{id} DAPATKAN Mendapatkan detail percakapan
/v1/conversations/{id} PENGUMUMAN Memperbarui metadata percakapan
/v1/conversations/{id} DELETE Menghapus percakapan
/v1/conversations?agent_id={id} DAPATKAN Mencantumkan percakapan (ekstensi DevUI)
/v1/conversations/{id}/items PENGUMUMAN Menambahkan item ke percakapan
/v1/conversations/{id}/items DAPATKAN Mencantumkan item percakapan
/v1/conversations/{id}/items/{item_id} DAPATKAN Mendapatkan item percakapan

Manajemen Entitas (Ekstensi DevUI)

Titik akhir Metode Deskripsi
/v1/entities DAPATKAN Mencantumkan agen/alur kerja yang ditemukan
/v1/entities/{entity_id}/info DAPATKAN Mendapatkan informasi entitas terperinci
/v1/entities/{entity_id}/reload PENGUMUMAN Entitas isi ulang panas (mode pengembang)

Pemeriksaan Kesehatan

curl http://localhost:8080/health

Server Metadata

Dapatkan konfigurasi dan kemampuan server:

curl http://localhost:8080/meta

Pengembalian:

  • ui_mode - Mode saat ini (developer atau user)
  • version - Versi DevUI
  • framework - Nama kerangka kerja (agent_framework)
  • runtime - Runtime backend (python)
  • capabilities - Bendera fitur (pelacakan, proksi OpenAI, penyebaran)
  • auth_required - Apakah autentikasi diaktifkan

Pemetaan Peristiwa

DevUI memetakan peristiwa Agent Framework ke peristiwa OPENAI Responses API. Tabel di bawah ini memperlihatkan pemetaan:

Peristiwa Siklus Hidup

Acara OpenAI Peristiwa Kerangka Kerja Agen
response.created + response.in_progress AgentStartedEvent
response.completed AgentCompletedEvent
response.failed AgentFailedEvent
response.created + response.in_progress WorkflowStartedEvent
response.completed WorkflowCompletedEvent
response.failed WorkflowFailedEvent

Tipe Isi

Acara OpenAI Isi Kerangka Kerja Agen
response.content_part.added + response.output_text.delta TextContent
response.reasoning_text.delta TextReasoningContent
response.output_item.added FunctionCallContent (inisial)
response.function_call_arguments.delta FunctionCallContent (Args)
response.function_result.complete FunctionResultContent
response.output_item.added (gambar) DataContent (gambar)
response.output_item.added (file) DataContent (file)
error ErrorContent

Kejadian Alur Kerja

Acara OpenAI Peristiwa Kerangka Kerja Agen
response.output_item.added (ExecutorActionItem) WorkflowEvent dengan type="executor_invoked"
response.output_item.done (ExecutorActionItem) WorkflowEvent dengan type="executor_completed"
response.output_item.added (ResponseOutputMessage) WorkflowEvent dengan type="output"

Ekstensi Kustom DevUI

DevUI menambahkan jenis peristiwa kustom untuk fungsionalitas khusus Agent Framework:

  • response.function_approval.requested - Permintaan persetujuan fungsi
  • response.function_approval.responded - Respons persetujuan fungsi
  • response.function_result.complete - Hasil eksekusi fungsi sisi server
  • response.workflow_event.complete - Peristiwa alur kerja
  • response.trace.complete - Jejak eksekusi

Ekstensi kustom ini diberi namespace dan dapat diabaikan dengan aman oleh klien OpenAI standar.

Mode Proksi OpenAI

DevUI menyediakan fitur OpenAI Proxy untuk menguji model OpenAI secara langsung melalui antarmuka tanpa membuat agen kustom. Aktifkan melalui Pengaturan di UI.

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

Nota

Mode proksi memerlukan variabel lingkungan yang OPENAI_API_KEY dikonfigurasi pada backend.

Langkah Selanjutnya

  • Last updated on