Kennisbank

De Kennisbank vormt de kern van de expertise van je AI-agent en bevat alle informatie waarmee de AI vragen beantwoordt. Met deze endpoints beheer je de configuratie van de Kennisbank en volg je de verwerkingsstatus van de inhoud.

De Kennisbank gebruikt artikelen die je maakt, van websites importeert of als bestanden uploadt. Opnieuw trainen is niet nodig: elk artikel dat je maakt, bijwerkt of verwijdert, wordt automatisch op de achtergrond verwerkt. Zodra dat klaar is, geldt de wijziging in gesprekken.

Instellingen ophalen

Haal de configuratie van je Kennisbank op.

Bereik: 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()

Antwoord 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
}

Veld	Beschrijving
one_word_description string	Naam van de AI-agent. Dashboard: Identiteit > AI-persona > Naam
short_description string	Systeemprompt / Hoofdprompt. Dashboard: Identiteit > AI-persona > Hoofdprompt
ai_commands array van strings	Gedragsrichtlijnen, één per array-item. Dashboard: Identiteit > AI-persona > Richtlijnen. Maximaal 250 items, 5.000 tekens per item en 10.000 tekens over alle items samen.
pending_embed_count integer	Artikelen die nog worden verwerkt. 0 betekent dat alles wat je hebt ingediend beschikbaar is
failed_embed_count integer	Artikelen waarvan de verwerking is mislukt. Probeer opnieuw met Mislukte artikelen opnieuw verwerken

Wachten tot inhoud beschikbaar is

Vraag dit endpoint periodiek op na een schrijfactie en wacht totdat pending_embed_count gelijk is aan 0. De status per artikel is ook beschikbaar in het veld embed_state bij Artikelen.

Opmerking

Deze drie velden (one_word_description, short_description, ai_commands) worden gedeeld met Chatbotinstellingen. Bijwerken via een van beide endpoints wijzigt dezelfde onderliggende gegevens.

Instellingen bijwerken

Bereik: write_all

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

Requestbody

Parameter	Beschrijving
one_word_description string	Naam van de AI-agent
short_description string	Systeemprompt / beschrijving van de AI-agent. De API accepteert bij elk abonnement maximaal 25.000 tekens; de editor in de app beperkt dit tot de limiet van je abonnement, vanaf 15.000. Een te lange waarde retourneert 422.
ai_commands array van strings	AI-richtlijnen, één per array-item. Maximaal 250 items, 5.000 tekens per item en 10.000 tekens over alle items samen. Een te lange waarde retourneert 422.

Hoe richtlijnen worden opgeslagen

Elk array-item is één richtlijn en wordt exact opgeslagen zoals je die verstuurt. Leestekens, inclusief puntkomma’s, blijven behouden. Een richtlijn met ; werd vroeger als twee afzonderlijke richtlijnen teruggegeven. Als je puntkomma’s daarom vermeed, hoeft dat niet meer.

Dit endpoint accepteerde eerder richtlijnen van elke lengte. De bovenstaande limieten gelden hier nu ook en zijn exact gelijk aan die van Chatbotinstellingen.

Laat ai_commands weg of stuur null om de richtlijnen ongewijzigd te laten. Stuur [] om ze te wissen.

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

Antwoord 200 OK: retourneert de bijgewerkte Kennisbank-instellingen (hetzelfde schema als Instellingen ophalen).

Mislukte artikelen opnieuw verwerken

Verwerk elk artikel opnieuw waarvan de verwerking is mislukt. Artikelen die al beschikbaar zijn of nog worden verwerkt, blijven ongewijzigd. Je kunt de aanroep veilig herhalen.

Mislukte artikelen worden ook automatisch opnieuw geprobeerd. Dit endpoint is dus alleen nodig als je daar niet op wilt wachten.

Bereik: 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>"},
)

Antwoord 200 OK

{
  "retried": 2
}

Veld	Beschrijving
retried integer	Hoeveel mislukte artikelen in de wachtrij zijn gezet om opnieuw te verwerken

Kennisbank opnieuw trainen Verouderd

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

Opnieuw trainen bestaat niet meer: artikelwijzigingen worden automatisch verwerkt. Dit endpoint blijft alleen bestaan zodat bestaande integraties blijven werken. Het accepteert de aanvraag, doet niets en retourneert 200 OK.

Je kunt deze aanroep uit je integratie verwijderen. Als je periodiek controleerde of het trainen klaar was, wacht dan in plaats daarvan totdat pending_embed_count gelijk is aan 0 in Instellingen ophalen.

---