Поиск по базе знаний
svod.search
Ищет страницы корпоративной базы знаний (Свод) по заголовку. Помогает найти регламенты, инструкции и документацию по ключевым словам перед ответом пользователю. Возвращает краткие карточки найденных страниц — заголовок и фрагмент текста; за полным содержимым нужно запросить страницу по её идентификатору. Архивные страницы в выдачу не попадают. Только чтение.
Входы
| Ключ | Тип | Описание |
|---|---|---|
| query* | string | Поисковый запрос |
| limit | integer | Лимит |
Выходы
| Ключ | Тип | Описание |
|---|---|---|
| items | array | Найденные страницы |
| count | integer | Количество |
Что делает
Нода ищет страницы корпоративной базы знаний «Свод» по заголовку. По ключевым словам она подбирает подходящие регламенты, инструкции и документы и возвращает их коротким списком. Каждая найденная страница приходит в виде карточки: заголовок, ссылка (слаг), иконка, статус и небольшой фрагмент текста со страницы. Полное содержимое нода не отдаёт — так ответ остаётся компактным; чтобы прочитать страницу целиком, её запрашивают по идентификатору. Архивные страницы в выдачу не включаются.
Когда применять
Основной сценарий — найти нужный документ в базе знаний перед ответом сотруднику. Например, пользователь спрашивает ассистента, как оформить командировку или какой регламент действует при возврате товара, — ассистент по ключевым словам находит соответствующие страницы «Свода», показывает их заголовки и краткие фрагменты, а затем при необходимости открывает нужную страницу целиком. Подходит и для автоматизаций, где по теме обращения надо подтянуть ссылку на актуальную инструкцию. Нода только читает данные и ничего не меняет.
Что на входе
Обязательный параметр — поисковый запрос: ключевые слова, по которым ищутся заголовки страниц. Дополнительно можно задать лимит — сколько страниц вернуть в ответе; по умолчанию выдаётся небольшой список наиболее подходящих страниц.
Что приходит в ответе
Список найденных страниц и их количество. По каждой странице приходят идентификатор, заголовок, слаг (адрес страницы), иконка, статус и короткий фрагмент текста для предпросмотра. Идентификатор затем можно использовать, чтобы открыть полную страницу, а слаг — чтобы дать пользователю прямую ссылку на документ.