Knowledge Base

Die Wissensdatenbank ist der Kern der Expertise Ihres KI-Agenten — sie enthält alle Informationen, die Ihre KI zum Beantworten von Fragen verwendet. Mit diesen Endpunkten können Sie die Konfiguration der Wissensdatenbank verwalten und den Verarbeitungsstatus ihrer Inhalte verfolgen.

Die Wissensdatenbank schöpft aus Artikeln, die Sie erstellen, von Websites importieren oder als Dateien hochladen. Es gibt keinen Retraining‑Schritt: Jeder Artikel, den Sie erstellen, aktualisieren oder löschen, wird automatisch im Hintergrund verarbeitet und wird in Konversationen wirksam, sobald die Verarbeitung abgeschlossen ist.

Get Settings

Rufen Sie die Konfiguration Ihrer Wissensdatenbank ab.

Berechtigungsumfang: read_all

GET https://app.quickchat.ai/v1/api/knowledge_base/

Shell

curl https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

Antwort 200 OK

{
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"],
  "pending_embed_count": 0,
  "failed_embed_count": 0
}

Field	Description
one_word_description string	Name des KI-Agenten. Dashboard: Identität > AI Persona > Name
short_description string	System-Prompt / Haupt-Prompt. Dashboard: Identität > AI Persona > Haupt-Prompt
ai_commands array of strings	Verhaltensrichtlinien, eine Richtlinie pro Array-Element. Dashboard: Identität > AI Persona > Richtlinien. Bis zu 250 Einträge, 5.000 Zeichen pro Eintrag und 10.000 Zeichen über alle Einträge hinweg.
pending_embed_count integer	Artikel, die noch verarbeitet werden. 0 bedeutet, dass alles, was Sie übermittelt haben, live ist
failed_embed_count integer	Artikel, deren Verarbeitung fehlgeschlagen ist. Wiederholen Sie sie mit Retry Failed Articles

Warten, bis Inhalte live sind

Fragen Sie diesen Endpunkt nach einem Schreibvorgang ab und warten Sie, bis pending_embed_count den Wert 0 erreicht. Der Status pro Artikel steht außerdem als Feld embed_state bei Articles zur Verfügung.

Hinweis

Diese drei Felder (one_word_description, short_description, ai_commands) werden mit Chatbot Settings geteilt. Eine Aktualisierung über einen der beiden Endpunkte ändert dieselben zugrunde liegenden Daten.

Update Settings

Berechtigungsumfang: write_all

PATCH https://app.quickchat.ai/v1/api/knowledge_base/

Request-Body

Parameter	Description
one_word_description string	Name des KI-Agenten
short_description string	System-Prompt / Beschreibung des KI-Agenten. Die API akzeptiert auf allen Tarifen bis zu 25.000 Zeichen; der In-App-Editor begrenzt den Wert auf das Maximum Ihres Tarifs, das bei 15.000 beginnt. Ein zu langer Wert gibt 422 zurück.
ai_commands array of strings	AI Guidelines, eine Richtlinie pro Array-Element. Bis zu 250 Einträge, 5.000 Zeichen pro Eintrag und 10.000 Zeichen über alle Einträge hinweg. Ein zu langer Wert gibt 422 zurück.

Wie Richtlinien gespeichert werden

Jedes Array-Element ist eine Richtlinie und wird genau so gespeichert, wie Sie sie senden. Satzzeichen bleiben erhalten, Semikolons eingeschlossen. Früher wurde eine Richtlinie mit ; als zwei getrennte Richtlinien zurückgegeben. Wenn Sie Semikolons deshalb vermieden haben, ist das nicht mehr nötig.

Dieser Endpunkt hat Richtlinien zuvor in beliebiger Länge akzeptiert. Die oben genannten Limits gelten jetzt auch hier und stimmen exakt mit Chatbot Settings überein.

Lassen Sie ai_commands weg oder senden Sie null, um die Richtlinien unverändert zu lassen. Senden Sie [], um sie zu löschen.

Shell

curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "one_word_description": "Sales Bot"
}'

Python

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={"one_word_description": "Sales Bot"},
)
data = response.json()

Antwort 200 OK — Gibt die aktualisierten Einstellungen der Wissensdatenbank zurück (gleiches Schema wie Get Settings).

Retry Failed Articles

Verarbeitet jeden Artikel neu, dessen Verarbeitung fehlgeschlagen ist. Artikel, die bereits live sind oder noch verarbeitet werden, bleiben unberührt, und der Aufruf kann gefahrlos wiederholt werden.

Fehlgeschlagene Artikel werden auch automatisch erneut verarbeitet — dieser Endpunkt wird also nur benötigt, wenn Sie darauf nicht warten möchten.

Berechtigungsumfang: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)

Antwort 200 OK

{
  "retried": 2
}

Field	Description
retried integer	Wie viele fehlgeschlagene Artikel zur erneuten Verarbeitung eingereiht wurden

Retrain Knowledge Base Veraltet

POST https://app.quickchat.ai/v1/api/knowledge_base/retrain/

Retraining gibt es nicht mehr — Artikeländerungen werden automatisch verarbeitet. Dieser Endpunkt bleibt nur erhalten, damit bestehende Integrationen weiterhin funktionieren: Er nimmt die Anfrage entgegen, tut nichts und gibt 200 OK zurück.

Sie können den Aufruf aus Ihrer Integration entfernen. Falls Sie bisher abgefragt haben, bis das Retraining abgeschlossen war, warten Sie stattdessen, bis pending_embed_count in Get Settings den Wert 0 erreicht.

---