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 śledzić status przetwarzania jej treści.

Baza Wiedzy czerpie z Artykułów, które tworzysz, importujesz ze stron internetowych lub przesyłasz jako pliki. Nie ma kroku ponownego trenowania: każdy artykuł, który tworzysz, aktualizujesz lub usuwasz, jest przetwarzany automatycznie w tle i zaczyna obowiązywać w rozmowach, gdy tylko przetwarzanie się zakończy.

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"],
  "pending_embed_count": 0,
  "failed_embed_count": 0
}

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
pending_embed_count integer	Artykuły, które są jeszcze przetwarzane. 0 oznacza, że wszystko, co zostało przesłane, działa już na żywo
failed_embed_count integer	Artykuły, których przetwarzanie się nie powiodło. Ponów je przez Retry Failed Articles

Czekanie, aż treść zacznie działać

Odpytuj ten endpoint po zapisie i poczekaj, aż pending_embed_count osiągnie 0. Status pojedynczych artykułów jest też dostępny jako pole embed_state w Artykułach.

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

Retry Failed Articles

Przetwórz ponownie każdy artykuł, którego przetwarzanie się nie powiodło. Artykuły, które już działają na żywo lub są wciąż w trakcie przetwarzania, pozostają nietknięte, a wywołanie można bezpiecznie powtarzać.

Nieudane artykuły są ponawiane automatycznie również bez Twojego udziału, więc ten endpoint jest potrzebny tylko wtedy, gdy nie chcesz na to czekać.

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

Response 200 OK

{
  "retried": 2
}

Field	Description
retried integer	Ile nieudanych artykułów zostało skierowanych do ponownego przetworzenia

Retrain Knowledge Base Deprecated

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

Ponowne trenowanie już nie istnieje — zmiany w artykułach są przetwarzane automatycznie. Ten endpoint pozostaje wyłącznie po to, aby istniejące integracje nadal działały: przyjmuje żądanie, nic nie robi i zwraca 200 OK.

Możesz usunąć to wywołanie ze swojej integracji. Jeśli Twoja integracja odpytywała endpoint aż do zakończenia ponownego trenowania, zamiast tego poczekaj, aż pending_embed_count osiągnie 0 w Get Settings.

---