База знаний

База знаний составляет основу компетенций AI-агента: она содержит всю информацию, которую AI использует для ответов. Эти endpoints позволяют управлять конфигурацией Базы знаний и отслеживать обработку её содержимого.

База знаний использует статьи, которые вы создаёте, импортируете с сайтов или загружаете в виде файлов. Повторное обучение не требуется: каждая созданная, изменённая или удалённая статья автоматически обрабатывается в фоне, а изменения начинают действовать в разговорах сразу после завершения.

Получение настроек

Получите конфигурацию Базы знаний.

Права: 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 строка	Имя AI-агента. В панели управления: Идентичность > Личность AI > Название
short_description строка	Системный промпт / Основной промпт. В панели управления: Идентичность > Личность AI > Основной промпт
ai_commands массив строк	Инструкции по поведению, по одной на элемент массива. В панели управления: Идентичность > Личность AI > Инструкции. До 250 элементов, 5 000 символов в каждом и 10 000 символов суммарно.
pending_embed_count целое число	Статьи, которые ещё обрабатываются. 0 означает, что всё отправленное уже доступно
failed_embed_count целое число	Статьи с ошибкой обработки. Повторите обработку через Повторную обработку статей с ошибками

Ожидание публикации содержимого

После записи опрашивайте этот endpoint, пока pending_embed_count не станет равным 0. Статус отдельной статьи также доступен в поле embed_state у статей.

Заметка

Эти три поля (one_word_description, short_description, ai_commands) общие с Настройками чат-бота. Обновление через любой из endpoints меняет одни и те же данные.

Обновление настроек

Права: write_all

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

Тело запроса

Параметр	Описание
one_word_description строка	Имя AI-агента
short_description строка	Системный промпт / описание AI-агента. API принимает до 25 000 символов на любом тарифе; редактор приложения ограничивает длину согласно тарифу, начиная с 15 000. Превышение лимита возвращает 422.
ai_commands массив строк	Инструкции AI, по одной на элемент массива. До 250 элементов, 5 000 символов в каждом и 10 000 символов суммарно. Превышение лимита возвращает 422.

Как хранятся инструкции

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

Ранее этот endpoint принимал инструкции любой длины. Теперь указанные выше ограничения действуют и здесь и полностью совпадают с Настройками чат-бота.

Не передавайте 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: возвращает обновлённые настройки Базы знаний (схема как у Получения настроек).

Повторная обработка статей с ошибками

Запустите повторную обработку всех статей, обработка которых завершилась ошибкой. Уже опубликованные или ещё обрабатываемые статьи не затрагиваются. Вызов можно безопасно повторять.

Статьи с ошибками также повторно обрабатываются автоматически, поэтому endpoint нужен только если вы не хотите ждать.

Права: 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 целое число	Сколько статей с ошибками поставлено в очередь повторной обработки

Повторное обучение Базы знаний Устарело

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

Повторного обучения больше нет: изменения статей обрабатываются автоматически. Этот endpoint сохранён только для совместимости существующих интеграций: принимает запрос, ничего не делает и возвращает 200 OK.

Удалите этот вызов из интеграции. Если вы опрашивали статус до завершения обучения, вместо этого ждите, пока pending_embed_count не станет равным 0 в Получении настроек.

---