AI Answers – API-Referenz

Senden Sie eine POST-Anfrage an die API-Adresse des Projekts mit einem JSON-Hauptteil. Verwenden Sie dabei folgende Header:

Der Textkörper enthält folgende Felder. Alle Felder sind Pflichtfelder, mit Ausnahme von history:

Die API speichert keine Unterhaltungen. Um eine Folgefrage zu stellen, senden Sie bitte die früheren Fragen und Antworten aus history.

Zum Beispiel:

curl -N -X POST "<API address>" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API key>" \
  -d '{
    "tenantId": "<tenant ID>",
    "projectId": "<project ID>",
    "language": "en",
    "message": "Can I publish it to more than one channel?",
    "history": [
      {"role": "user", "content": "How do I publish a topic?"},
      {"role": "assistant", "content": "To publish a topic, add it to a publication and select Publish."}
    ]
  }'

Die Antwort wird als Strom von vom Server gesendeten Ereignissen zurückgegeben, sodass Ihre Anwendung den Text bereits anzeigen kann, während er noch geschrieben wird. Jedes Ereignis besteht aus einer Zeile, die mit data: beginnt, gefolgt von einem JSON-Objekt. Das Feld type gibt an, um welche Art von Ereignis es sich handelt:

Wenn die Antwort vollständig ist, enthält das done -Ereignis keinen reason. Wenn es einen reason enthält, gibt dieser an, warum die Antwort beendet wurde:

Zum Beispiel:

data: {"type": "answer", "answerId": "<answer ID>"}

data: {"type": "text", "content": "To publish a topic, add it to "}

data: {"type": "text", "content": "a publication and select Publish."}

data: {"type": "sources", "sources": [{"url": "en/publish/publish-a-publication", "title": "Publish a publication"}]}

data: {"type": "done"}

Das Streamen einer Antwort dauert in der Regel 5 bis 20 Sekunden.

Fehler werden als HTTP-Statuscode zurückgegeben, bevor Ereignisse gesendet werden: