Megosztás:

API-referencia

A DevUI egy OpenAI-kompatibilis Válasz API-t biztosít, amely lehetővé teszi az OpenAI SDK vagy bármely HTTP-ügyfél használatát az ügynökökkel és munkafolyamatokkal való interakcióhoz.

Hamarosan elérhető

A C# devUI-dokumentációja hamarosan elérhető lesz. Tekintse meg később, vagy tekintse meg a Python dokumentációját fogalmi útmutatásért.

Alap URL-cím

http://localhost:8080/v1

A port a CLI beállítással --port konfigurálható.

Authentication

Alapértelmezés szerint a DevUI nem igényel hitelesítést a helyi fejlesztéshez. A bearer token hitelesítése kötelező, ha a futtatáskor a tulajdonosi jogkivonatot --authkell használni.

Az OpenAI SDK használata

Alapszintű kérés

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)

Online közvetítés

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)

Többfordulós beszélgetések

Használja a standard OpenAI conversation paramétert többfordulós beszélgetésekhez:

# 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
)

A DevUI automatikusan lekéri a beszélgetés üzenetelőzményeit, és átadja az ügynöknek.

REST API-végpontok

Responses API (OpenAI Standard)

Ügynök vagy munkafolyamat végrehajtása:

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

Beszélgetések API (OpenAI Standard)

Végpont Metódus Description
/v1/conversations poszt Beszélgetés létrehozása
/v1/conversations/{id} SZEREZZE MEG Beszélgetés részleteinek lekérése
/v1/conversations/{id} poszt Beszélgetés metaadatainak frissítése
/v1/conversations/{id} töröl Beszélgetés törlése
/v1/conversations?agent_id={id} SZEREZZE MEG Beszélgetések listázása (DevUI-bővítmény)
/v1/conversations/{id}/items poszt Elemek hozzáadása a beszélgetéshez
/v1/conversations/{id}/items SZEREZZE MEG Beszélgetési elemek listázása
/v1/conversations/{id}/items/{item_id} SZEREZZE MEG Beszélgetési elem lekérése

Entitáskezelés (DevUI-bővítmény)

Végpont Metódus Description
/v1/entities SZEREZZE MEG Felderített ügynökök/munkafolyamatok listázása
/v1/entities/{entity_id}/info SZEREZZE MEG Részletes entitásadatok lekérése
/v1/entities/{entity_id}/reload poszt Gyakori elérésű újratöltési entitás (fejlesztői mód)

Állapot-ellenőrzés

curl http://localhost:8080/health

Kiszolgáló metaadatai

Kiszolgáló konfigurációjának és képességeinek lekérése:

curl http://localhost:8080/meta

Visszatérítések

  • ui_mode - Aktuális mód (developer vagy user)
  • version - DevUI-verzió
  • framework - Keretrendszer neve (agent_framework)
  • runtime - Háttérbeli futtatókörnyezet (python)
  • capabilities - Funkciójelzők (nyomkövetés, OpenAI-proxy, üzembe helyezés)
  • auth_required - Engedélyezve van-e a hitelesítés

Eseményleképezés

A DevUI az Ügynök-keretrendszer eseményeit OpenAI Responses API-eseményekké képezi le. Az alábbi táblázat a leképezést mutatja:

Életciklus-események

OpenAI-esemény Ügynök-keretrendszer eseménye
response.created + response.in_progress AgentStartedEvent
response.completed AgentCompletedEvent
response.failed AgentFailedEvent
response.created + response.in_progress WorkflowStartedEvent
response.completed WorkflowCompletedEvent
response.failed WorkflowFailedEvent

Tartalomtípusok

OpenAI-esemény Ügynök-keretrendszer tartalma
response.content_part.added + response.output_text.delta TextContent
response.reasoning_text.delta TextReasoningContent
response.output_item.added FunctionCallContent (kezdeti)
response.function_call_arguments.delta FunctionCallContent (args)
response.function_result.complete FunctionResultContent
response.output_item.added (kép) DataContent (képek)
response.output_item.added (fájl) DataContent (fájlok)
error ErrorContent

Munkafolyamat-események

OpenAI-esemény Ügynök-keretrendszer eseménye
response.output_item.added (ExecutorActionItem) WorkflowEvent és type="executor_invoked"
response.output_item.done (ExecutorActionItem) WorkflowEvent és type="executor_completed"
response.output_item.added (ResponseOutputMessage) WorkflowEvent és type="output"

Egyéni DevUI-bővítmények

A DevUI egyéni eseménytípusokat ad hozzá az Agent Framework-specifikus funkciókhoz:

  • response.function_approval.requested - Függvény-jóváhagyási kérelmek
  • response.function_approval.responded - Függvény-jóváhagyási válaszok
  • response.function_result.complete – Kiszolgálóoldali függvények végrehajtási eredményei
  • response.workflow_event.complete - Munkafolyamat-események
  • response.trace.complete - Végrehajtási nyomkövetések

Ezek az egyéni bővítmények névtérrel vannak elosztva, és a standard OpenAI-ügyfelek biztonságosan figyelmen kívül hagyhatják őket.

OpenAI proxy mód

A DevUI egy OpenAI proxyfunkciót biztosít az OpenAI-modellek teszteléséhez közvetlenül a felületen keresztül, egyéni ügynökök létrehozása nélkül. Engedélyezés a felhasználói felületen a Beállításokon keresztül.

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

Megjegyzés:

A proxy módhoz OPENAI_API_KEY a háttérrendszeren konfigurált környezeti változó szükséges.

Következő lépések

  • Last updated on