Базы знаний

Методы раздела управляют базами знаний рабочего пространства: создают и настраивают их, наполняют документами, правят фрагменты и привязывают теги. Так базу знаний можно пополнять автоматически из внешних систем — CRM, CMS, ERP.

Ключ баз знаний

  • Ключ создаётся в любой базе знаний с поиском: вкладка Управление → блок API → API Ключ. Он начинается с evo_kb_.

  • Ключ относится ко всему рабочему пространству, а не к одной базе. Он видит и меняет базы знаний пространства так, как их видит владелец пространства в интерфейсе, — если у базы включён доступ по API.

  • База знаний с доступом Только я, созданная другим участником, ключу не видна.

  • Ключ агента к методам баз знаний не подходит: ответ 401 с кодом invalid_api_key.

Типы баз знаний

База знаний с поиском (RAG) — rag

Файловая база знаний — files

Как работает

Документы разбиваются на фрагменты, индексируются, агент ищет по ним

Файлы хранятся целиком и передаются агенту как есть

Форматы

CSV, DOC, DOCX, HTM, HTML, MARKDOWN, MD, MDX, PDF, PPT, PPTX, PROPERTIES, TXT, VTT, XLS, XLSX

CSV, XLS, XLSX

Размер файла

До 50 МБ

До 100 МБ

Документ после добавления

Проходит обработку: queued → processing → enabled

Сразу enabled

Фрагменты

Есть — см. Фрагменты

Нет: запросы к фрагментам получают 400 с кодом chunks_not_supported

Лимиты

Лимиты документов и объёма тарифа

Предел числа файлов и общего объёма базы; тариф их не меняет

Подробнее о типах — в разделах База знаний с поиском и Файловая база знаний.

У файловой базы знаний в интерфейсе нет блока API, но она доступна ключу баз знаний так же, как база знаний с поиском, и есть в общем списке баз знаний.

Что API делает само

  • Параметры индексации, нарезки и поиска нового документа — те же, что применяет интерфейс при добавлении документа. Через API их не передают и не получают.

  • Базы знаний и документы, созданные раньше с другими параметрами, сохраняют свои параметры: API их не меняет.

  • Добавить сайт или каталог, архивировать документ, создать фрагмент вручную и проверить поиск через API нельзя — это делается в интерфейсе.

Методы

Метод

Путь

Страница

Список баз знаний

GET /v1/knowledge-bases

Создание и настройка

Создание базы знаний

POST /v1/knowledge-bases

Создание и настройка

База знаний

GET /v1/knowledge-bases/{knowledge_base_id}

Создание и настройка

Изменение базы знаний

PATCH /v1/knowledge-bases/{knowledge_base_id}

Создание и настройка

Удаление базы знаний

DELETE /v1/knowledge-bases/{knowledge_base_id}

Создание и настройка

Список документов

GET /v1/knowledge-bases/{knowledge_base_id}/documents

Документы

Добавление документа

POST /v1/knowledge-bases/{knowledge_base_id}/documents

Документы

Документ

GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}

Документы

Изменение документа

PATCH /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}

Документы

Удаление документа

DELETE /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}

Документы

Список фрагментов

GET …/documents/{document_id}/chunks

Фрагменты

Фрагмент

GET …/documents/{document_id}/chunks/{chunk_id}

Фрагменты

Изменение фрагмента

PATCH …/documents/{document_id}/chunks/{chunk_id}

Фрагменты

Удаление фрагмента

DELETE …/documents/{document_id}/chunks/{chunk_id}

Фрагменты

Список тегов

GET /v1/tags

Теги

Создание тега

POST /v1/tags

Теги

Переименование тега

PATCH /v1/tags/{tag_id}

Теги

Удаление тега

DELETE /v1/tags/{tag_id}

Теги

Привязка тега

PUT /v1/knowledge-bases/{knowledge_base_id}/tags/{tag_id}

Теги

Отвязка тега

DELETE /v1/knowledge-bases/{knowledge_base_id}/tags/{tag_id}

Теги

… в путях — это /v1/knowledge-bases/{knowledge_base_id}.