Knowledge Base

Baza Wiedzy to rdzeń wiedzy Twojego AI Agenta — zawiera wszystkie informacje, których Twoje AI używa do odpowiadania na pytania. Te endpointy pozwalają zarządzać konfiguracją Bazy Wiedzy i wyzwalać ponowne trenowanie po zmianach treści.

Baza Wiedzy czerpie z Artykułów, które tworzysz, importujesz ze stron internetowych lub przesyłasz jako pliki. Po wprowadzeniu zmian w artykułach musisz ponownie wytrenować Bazę Wiedzy, aby aktualizacje zaczęły obowiązywać w rozmowach.

Get Settings

Pobierz konfigurację swojej Bazy Wiedzy.

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

Response 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	Nazwa AI Agenta. Dashboard: Identity > Profile > AI Agent Name
short_description string	System prompt / opis AI Agenta. Dashboard: Identity > Profile > AI Agent Description
ai_commands array of strings	Wytyczne dotyczące zachowania. Dashboard: Identity > Conversation Style > AI Guidelines
retrain_state string or null	Aktualny status trenowania: null (aktualne lub nigdy nietrenowane), "to_be_retrained", "in_progress", "up_to_date" lub "failed"

Notatka

Te trzy pola (one_word_description, short_description, ai_commands) są współdzielone z Chatbot Settings. Aktualizacja przez którykolwiek z endpointów modyfikuje te same dane.

Update Settings

Scope: write_all

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

Request Body

Parameter	Description
one_word_description string	Nazwa AI Agenta
short_description string	System prompt / opis AI Agenta
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()

Response 200 OK — Zwraca zaktualizowane ustawienia Bazy Wiedzy (ten sam schemat co Get Settings).

Retrain Knowledge Base

Wyzwól asynchroniczne ponowne trenowanie Bazy Wiedzy.

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

Response 202 Accepted

Notatka

Ponowne trenowanie jest potrzebne po opublikowaniu zmian w artykułach, aby AI Agent korzystał z najnowszej treści. Postęp możesz monitorować przez pole retrain_state w Get Settings — zmienia się ono z "to_be_retrained" na "in_progress", a następnie na "up_to_date".

---