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 nach Inhaltsänderungen ein Retraining auslösen.

Die Wissensdatenbank schöpft aus Artikeln, die Sie erstellen, von Websites importieren oder als Dateien hochladen. Nachdem Sie Änderungen an Artikeln vorgenommen haben, müssen Sie die Wissensdatenbank neu trainieren, damit die Aktualisierungen in Konversationen wirksam werden.

Get Settings

Rufen Sie die Konfiguration Ihrer Wissensdatenbank ab.

Scope: 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"],
  "retrain_state": null
}

Field	Description
one_word_description string	Name des KI-Agenten. Dashboard: Identity > Profile > AI Agent Name
short_description string	System-Prompt / Beschreibung des KI-Agenten. Dashboard: Identity > Profile > AI Agent Description
ai_commands array of strings	Verhaltensrichtlinien. Dashboard: Identity > Conversation Style > AI Guidelines
retrain_state string or null	Aktueller Trainingsstatus: null (aktuell oder nie trainiert), "to_be_retrained", "in_progress", "up_to_date" oder "failed"

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

Scope: 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
ai_commands array of strings	AI Guidelines

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

Retrain Knowledge Base

Ein asynchrones Retraining der Wissensdatenbank auslösen.

Scope: write_all

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

Shell

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

Python

import requests

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

Antwort 202 Accepted

Hinweis

Ein Retraining ist erforderlich, nachdem Artikeländerungen veröffentlicht wurden, um sicherzustellen, dass der KI-Agent die neuesten Inhalte verwendet. Sie können den Fortschritt über das Feld retrain_state in Get Settings verfolgen — es wechselt von "to_be_retrained" über "in_progress" zu "up_to_date".

---