База знань

База знань є основою компетентності AI-агента: вона містить усю інформацію, яку AI використовує для відповідей. Ці ендпоїнти дають змогу керувати конфігурацією Бази знань і відстежувати стан обробки її контенту.

База знань складається зі Статей, які ви створюєте, імпортуєте із сайтів або завантажуєте як файли. Етапу перенавчання немає: кожна створена, оновлена або видалена стаття автоматично обробляється у фоні й впливає на розмови одразу після завершення.

Отримання налаштувань

Отримайте конфігурацію Бази знань.

Область доступу: 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()

Відповідь 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
}

Поле	Опис
one_word_description string	Назва AI-агента. Панель керування: Ідентичність > Особистість AI > Назва
short_description string	Системний промпт / Основний промпт. Панель керування: Ідентичність > Особистість AI > Основний промпт
ai_commands array of strings	Інструкції щодо поведінки, по одній на елемент масиву. Панель керування: Ідентичність > Особистість AI > Інструкції. До 250 елементів, 5 000 символів у кожному й 10 000 символів загалом.
pending_embed_count integer	Статті, які ще обробляються. 0 означає, що весь надісланий контент уже використовується
failed_embed_count integer	Статті з невдалою обробкою. Повторіть її через Повторну обробку невдалих статей

Очікування доступності контенту

Опитуйте цей ендпоїнт після запису й дочекайтеся, поки pending_embed_count стане 0. Стан кожної статті також доступний у полі embed_state у Статтях.

Заувага

Ці три поля (one_word_description, short_description, ai_commands) спільні з Налаштуваннями чатбота. Оновлення через будь-який ендпоїнт змінює ті самі дані.

Оновлення налаштувань

Область доступу: write_all

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

Тіло запиту

Параметр	Опис
one_word_description string	Назва AI-агента
short_description string	Системний промпт / опис AI-агента. API приймає до 25 000 символів на будь-якому тарифі; редактор у застосунку обмежує довжину лімітом тарифу, який починається з 15 000. Завелике значення повертає 422.
ai_commands array of strings	Інструкції AI, по одній на елемент масиву. До 250 елементів, 5 000 символів у кожному й 10 000 загалом. Завелике значення повертає 422.

Як зберігаються інструкції

Кожен елемент масиву є однією інструкцією й зберігається точно як надісланий. Пунктуація, зокрема крапки з комою, зберігається. Раніше інструкція з ; поверталася як дві окремі, тож якщо ви уникали крапок з комою через цю проблему, тепер це не потрібно.

Раніше цей ендпоїнт приймав інструкції будь-якої довжини. Тепер тут також діють наведені вище ліміти, які точно відповідають Налаштуванням чатбота.

Пропустіть ai_commands або надішліть null, щоб не змінювати інструкції. Надішліть [], щоб очистити їх.

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

Відповідь 200 OK. Повертає оновлені налаштування Бази знань (та сама схема, що й у Отриманні налаштувань).

Повторна обробка невдалих статей

Повторно обробіть усі статті, обробка яких завершилася помилкою. Статті, що вже використовуються або ще обробляються, не змінюються; виклик можна безпечно повторювати.

Невдалі статті також автоматично обробляються повторно, тому ендпоїнт потрібен лише тоді, коли ви не хочете чекати.

Область доступу: 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>"},
)

Відповідь 200 OK

{
  "retried": 2
}

Поле	Опис
retried integer	Кількість невдалих статей, поставлених у чергу повторної обробки

Перенавчання Бази знань Застаріло

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

Перенавчання більше не існує: зміни статей обробляються автоматично. Ендпоїнт збережений лише для сумісності наявних інтеграцій: приймає запит, нічого не робить і повертає 200 OK.

Можете прибрати цей виклик зі своєї інтеграції. Якщо ви опитували стан до завершення перенавчання, натомість чекайте, поки pending_embed_count стане 0 в Отриманні налаштувань.

---