KI-Anfragen

Führt eine synchrone KI-Anfrage gegen einen Provider aus und liefert das Ergebnis. POST und PUT sind gleichwertig.

POST /api/ai/requests

PUT /api/ai/requests

Senden Sie einen JSON-Body. Das Body-Objekt ist erforderlich. Alle Felder im Body sind optional.

REQUEST-Feld Werttyp Beschreibung
providerId string Provider-Anzeigename oder hyphenisierte Form. Leer oder weggelassen verwendet den Standard-Provider.
userText string Benutzer-Prompt. Standard ist ein leerer String.
systemPrompt string Optionaler System-Prompt.
previousConversation array Vorherige Konversationsschritte. Standard ist ein leeres Array.
resourceIds array of string Ressourcen-IDs aus einem vorherigen Upload.
allowedTools array of string Fehlt das Feld oder ist es null, sind alle Server-Tools verfügbar. Ist eine Liste gesetzt, sind nur die genannten Tools erlaubt. Bei Tool-Namen sind Leerzeichen und Unterstriche gleichwertig.
forceTool boolean Erzwingt die Tool-Ausführung, wenn die Pipeline das unterstützt.
maxToolCalls number Maximale Anzahl Tool-Aufrufe. Negative Werte werden als 0 behandelt.
contentSizeExceededStrategy string Enum-Name für zu große Inhalte. Unbekannte Werte fallen auf SEND_ANYWAY zurück.
timeoutMs number Timeout in Millisekunden. Standard: 120000.

Felder eines Konversationsschritts in previousConversation und in der Antwort history:

Feld Werttyp Beschreibung
text string Text des Schritts.
stepType string Einer der Werte system, user, assistant, tool.
toolCalls array Tool-Aufrufe bei Assistant-Schritten.
toolCallId string Tool-Call-ID bei Tool-Ergebnis-Schritten.
RESPONSE-Feld Werttyp Beschreibung
providerId string Verwendeter Provider-Identifier.
providerDisplayName string Anzeigename des Providers.
responseText string Antworttext.
errorText string Fehlertext, falls vorhanden.
lastHttpStatusCode number Letzter Upstream-HTTP-Status.
durationMs number Dauer in Millisekunden.
history array Konversationsverlauf einschließlich der neuen Schritte.

Der Aufruf wartet, bis der Provider fertig ist. Unbekannte Provider oder Communicators liefern 404. Timeout liefert 504. Fehlende oder fehlgeschlagene Provider-Antwort liefert 502. Falsche Methoden liefern 405.

Beispielanfrage

# Request
POST /api/ai/requests HTTP/1.1
Host: helpdesk.example.com
Authorization: Bearer <access_token>
Content-Type: application/json
 
{
  "providerId": "Primary Provider",
  "userText": "Summarize the uploaded notes.",
  "resourceIds": ["res_123"],
  "timeoutMs": 120000
}
 
# Response
HTTP/1.1 200 OK
Content-Type: application/json
 
{
  "providerId": "Primary Provider",
  "providerDisplayName": "Primary Provider",
  "responseText": "The notes describe ...",
  "errorText": "",
  "lastHttpStatusCode": 200,
  "durationMs": 1842,
  "history": [
    {
      "text": "Summarize the uploaded notes.",
      "stepType": "user"
    },
    {
      "text": "The notes describe ...",
      "stepType": "assistant"
    }
  ]
}