Sdílet prostřednictvím

Referenční informace k rozhraní API

DevUI poskytuje rozhraní API pro odpovědi kompatibilní s OpenAI, které umožňuje používat sadu OpenAI SDK nebo libovolného klienta HTTP k interakci s vašimi agenty a pracovními postupy.

Novinky

Dokumentace k DevUI pro C# bude brzy k dispozici. Zkontrolujte to prosím později nebo se obraťte na dokumentaci k Pythonu pro konceptuální pokyny.

Základní adresa URL

http://localhost:8080/v1

Port je možné nakonfigurovat pomocí možnosti rozhraní příkazového --port řádku.

Autentizace

Ve výchozím nastavení DevUI nevyžaduje ověřování pro místní vývoj. Při spuštění se vyžaduje ověřování nosným tokenem --auth.

Použití sady OpenAI SDK

Základní požadavek

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)

Streamová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)

Konverzace s vícenásobným otáčením

Pro více konverzací použijte standardní parametr 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 automaticky načte historii zpráv konverzace a předá ji agentovi.

Koncové body rozhraní REST API

Rozhraní API pro odpovědi (OpenAI Standard)

Spusťte agenta nebo pracovní postup:

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

Rozhraní API pro konverzace (OpenAI Standard)

Endpoint Metoda Description
/v1/conversations PŘÍSPĚVEK Vytvoření konverzace
/v1/conversations/{id} získej Získání podrobností o konverzaci
/v1/conversations/{id} PŘÍSPĚVEK Aktualizace metadat konverzace
/v1/conversations/{id} DELETE Odstranění konverzace
/v1/conversations?agent_id={id} získej Seznam konverzací (rozšíření DevUI)
/v1/conversations/{id}/items PŘÍSPĚVEK Přidání položek do konverzace
/v1/conversations/{id}/items získej Výpis položek konverzace
/v1/conversations/{id}/items/{item_id} získej Získání položky konverzace

Správa entit (rozšíření DevUI)

Endpoint Metoda Description
/v1/entities získej Výpis zjištěných agentů nebo pracovních postupů
/v1/entities/{entity_id}/info získej Získání podrobných informací o entitách
/v1/entities/{entity_id}/reload PŘÍSPĚVEK Entita opětovného načítání za provozu (vývojářský režim)

Kontrola stavu

curl http://localhost:8080/health

Metadata serveru

Získejte konfiguraci a možnosti serveru:

curl http://localhost:8080/meta

Návraty:

  • ui_mode - Aktuální režim (developer nebo user)
  • version – Verze DevUI
  • framework – Název architektury (agent_framework)
  • runtime – Modul runtime back-endu (python)
  • capabilities – Příznaky funkcí (trasování, proxy OpenAI, nasazení)
  • auth_required – Určuje, jestli je povolené ověřování.

Mapování událostí

DevUI mapuje události rozhraní Agent Framework na události rozhraní API pro odpovědi OpenAI. Následující tabulka ukazuje mapování:

Události životního cyklu

Událost OpenAI Událost rozhraní agenta
response.created + response.in_progress AgentStartedEvent
response.completed AgentCompletedEvent
response.failed AgentFailedEvent
response.created + response.in_progress WorkflowStartedEvent
response.completed WorkflowCompletedEvent
response.failed WorkflowFailedEvent

Typy obsahu

Událost OpenAI Obsah rozhraní Agent Framework
response.content_part.added + response.output_text.delta TextContent
response.reasoning_text.delta TextReasoningContent
response.output_item.added FunctionCallContent (počáteční)
response.function_call_arguments.delta FunctionCallContent (args)
response.function_result.complete FunctionResultContent
response.output_item.added (obrázek) DataContent (obrázky)
response.output_item.added (soubor) DataContent (soubory)
error ErrorContent

Události pracovního postupu

Událost OpenAI Událost rozhraní agenta
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"

Vlastní rozšíření DevUI

DevUI přidává vlastní typy událostí pro funkce specifické pro rozhraní Agent Framework:

  • response.function_approval.requested – Žádosti o schválení funkcí
  • response.function_approval.responded - Odpovědi na schválení funkce
  • response.function_result.complete - Výsledky provádění funkce na straně serveru
  • response.workflow_event.complete - Události pracovního postupu
  • response.trace.complete - Trasování provádění

Tato vlastní rozšíření jsou obor názvů a dají se bezpečně ignorovat standardními klienty OpenAI.

Režim proxy serveru OpenAI

DevUI poskytuje funkci Proxy OpenAI pro testování modelů OpenAI přímo prostřednictvím rozhraní bez vytváření vlastních agentů. Povolte nastavení v uživatelském rozhraní.

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

Poznámka:

Režim proxy serveru vyžaduje OPENAI_API_KEY proměnnou prostředí nakonfigurovanou v back-endu.

Další kroky

  • Last updated on