Для работы с Телеграм ботом Базы знаний необходимо добавить бота @kdb24_bot в нужный Телеграм чат по инструкции по ссылке. После этого в чате можно будет вызвать команды из списка команд бота, которые представлены в таблице ниже.
РВП означает расширенная версия приложения База знаний. Информацию о ней можно посмотреть на нашем сайте: https://it-solution.ru/b24apps/prilozhenie_bitrix24_baza_znanii/#!/tab/626994267-2.
Информация о кейсе GPT также представлена на официальном сайте IT-Solution: https://it-solution.ru/b24apps/prilozhenie_bitrix24_baza_znanii/#!/tab/626994267-3
! Обратите внимание, что при привязке разделов к топикам необходимо использовать команду /dir_bind, а при использовании команд кейса GPT нужно привязывать разделы с помощью команду /bind_dir.
| № | Команда | Что делает команда | Особенности использования команды | Нужна РВП? |
Нужен Кейс GPT? | Где доступна команда? | Демонстрация команды |
|---|---|---|---|---|---|---|---|
| 1 | /auth |
Позволяет авторизоваться для работы с ботом
|
/auth portalname.bitrix24.ru - запустит процесс авторизации на портале portalname.bitrix24.ruПередавать адрес портала можно также реплаем на следующее сообщение после команды /auth - авторизует в чате без дополнительных параметров, как в предыдущем чате |
Нет | Нет |
В чате с топиками и в чате без топиков | |
| 2 | /info |
Отправляет информацию о чате: ID чата и каким образом данный чат связан с Битриксом |
Нет |
Нет |
В чате с топиками и в чате без топиков |
||
| 3 |
/search |
Искать по статьям Базы знаний
После команды через пробел ожидается запрос, по которому будет производится поиск. В ответ бот вернет ссылки на найденный статьи и разделы в алфавитном порядке. При нажатии кнопки «Поиск по тексту статей» поиск будет проходить по содержимому статей. Бот вернет ссылки на найденные статьи в алфавитном порядке. |
Обратите внимание, что если к чату НЕ привязана директория через /bind_dir, то поиск будет производится по всей Базе знаний |
Да | Нет | В чате с топиками и в чате без топиков |
|
| 4 |
/create_article |
Помогает создать статью в Базе знаний.
После команды через пробел ожидается текст, который станет заголовком создаваемой статьи. |
Если привязка чата к разделу выполнена (см. /bind_dir), то статья создастся внутри привязанного раздела. Если нет, то статья создастся в корневой директории Базы знаний.
Статья создается пустой, без текста в ней. Важно помнить, что в данном контексте поддерживаются только текст и эмодзи, картинки, файлы и прочее передать в статью не получится. |
Нет | Нет |
В чате с топиками и в чате без топиков |
|
| 5 |
/get_article |
Перейти в режим работы со статьей.
После введенной команды через пробел ожидается URL статьи с портала, на котором пользователь авторизован в текущем чате. Бот возвращает сообщение «Выбрана статья /*название статьи со ссылкой на нее*/» и кнопку «Дописать статью». При нажатии на кнопку «Дописать статью» можно будет добавить в статью текст. Важно помнить, что в данном контексте поддерживаются только текст и эмоджи, картинки, файлы и прочее передать в статью не получится |
Нет | Нет | В чате с топиками и в чате без топиков |
||
| 6 |
/bind_dir |
Привязать директорию/раздел Базы знаний
После введенной команды через пробел ожидается ID раздела. В ответ бот возвращает сообщение о том, получилось ли привязать раздел или нет. |
Если раздел привязан к чату, то поиск с помощью /search будет проводиться исключительно внутри раздела. То же касается и /create_article – статьи будут создаваться внутри привязанного раздела. Обратите внимание, что команда позволяет привязывать несколько папок. Создаваться статьи при этом будут в последней привязанной. |
Нет |
Нет |
В чате с топиками и в чате без топиков |
|
| 7 |
/unbind_dir |
Отвязать раздел
После команды через пробел ожидается ID привязанного раздела. Бот возвращает сообщение с тем, получилось ли отвязать раздел или нет. |
Нет |
Нет |
В чате с топиками и в чате без топиков |
|
|
| 8 |
/bind_student |
Привязать студента курсов и получать события по нему |
Нет |
Нет |
В чате с топиками и в чате без топиков |
||
| 9 |
/prompt |
Задать GPT-боту вопрос. Помимо ссылок на статьи в ответах бота могут отображаться дополнительные ссылки из самих статей или релевантные картинки из них, которые будут отправлены следующими сообщениями после ответа бота. |
Возможность использовать команду /prompt есть только при условии подключения Кейса GPT. От версии приложения это не зависит (даже если у вас есть расширенная версия, команда /prompt не будет работать). Если активирован кейс GPT, в Телеграм чат добавлен бот Базы знаний и к Телеграм чату привязан раздел с помощью /bind_dir, то бот ответит на основании статей из привязанного раздела и предложит ссылки на статьи, в которых можно подробнее изучить информацию. Если использовать команду /prompt в чате, где есть бот Базы знаний и у вас активирован кейс GPT, но не привязан раздел, то поиск ответа ботом будет происходить по всему содержимому в Базе знаний. Если при вопросе вам нужно учесть контекст прошлого вопроса и ответа, то вы можете сделать реплай на ответ бота и задать новый вопрос. Шаг 1: Задайте первый вопрос Шаг 2: Получите ответ от бота Шаг 3: Сделайте реплай на ответ бота (а не пишите новое сообщение) Используйте функцию "ответить на сообщение" (reply), если вы хотите уточнить что-то или задать связанный вопрос. Шаг 4: Продолжайте цепочку реплаев Если нужно сохранить весь контекст, отвечайте именно на последний ответ бота в цепочке. Так бот будет учитывать всю предыдущую переписку. Важно помнить: Если вы не используете реплай, бот может не понять, что речь идёт о предыдущем разговоре. |
Нет |
Да | В чате с топиками и в чате без топиков |
Вы также можете отправить команду и потом передать запрос таким образом Пример запроса с реплаем |
| 10 |
/turn_on_prompt_mode /turn_off_prompt_mode |
Включить и отключить режим "prompt" Когда режим активирован, то боту можно задавать вопросы без команды - бот будет искать ответ на любые сообщения в чате. |
У бота должны быть права администратора в чате. Вызвать команду может только администратор портала или Базы знаний. При вызове команды в чате с топиками меняется указанная настройка по умолчанию для всех топиков. Возможность задавать вопросы через команду /prompt сохранится. |
Нет | Да | В чате с топиками (в топике General) и в чате без топиков |
|
| 11 |
/turn_on_topic_prompt_mode /turn_off_topic_prompt_mode |
Включить и отключить режим "prompt" для топика Когда режим активирован, то боту можно задавать вопросы без команды - бот будет искать ответ на любые сообщения в топике. |
Команда работает для отдельных топиков и у бота должны быть права администратора в чате. Вызвать команду может только администратор портала или Базы знаний. Если команда ни разу не вызывалась, то будут использованы настройки чата (см. пункт 10). При этом возможность задавать вопросы через команду /prompt сохранится. |
Нет |
Да | В чате с топиками (для каждого топика) |
|
| 12 |
/reset_topic_prompt_mode |
Сбросить настройки режима "prompt" для топиков. |
Вызвать команду может только администратор портала или Базы знаний. При выполнении команды в топике настройки для топика будут сброшены и будут использоваться настройки чата. |
Нет |
Да | В чате с топиками (для каждого топика) |
|
| 13 |
/turn_on_link_mode |
Включить и отключить режим ссылок для чата Когда активирован режим ссылок, то к ответу бота прикладываются ссылки на подходящие статьи. Если отключить режим ссылок, то бот будет выдавать ответ без ссылок. |
Команда работает для всего чата и у бота должны быть права администратора в чате. При вызове команды в чате с топиками меняется указанная настройка по умолчанию для всех топиков. Вызвать команду может только администратор портала или Базы знаний. |
Нет |
Да | В чате с топиками (в топике General) и в чате без топиков |
|
| 14 |
/turn_on_topic_link_mode |
Включить и отключить режим ссылок для топика Когда активирован режим ссылок, то к ответу бота прикладываются ссылки на подходящие статьи. Если отключить режим ссылок, то бот будет выдавать ответ без ссылок. |
Команда работает для отдельных топиков и у бота должны быть права администратора в чате. Вызвать команду может только администратор портала или Базы знаний. По умолчанию используются настройки чата. |
Нет |
Да | В чате с топиками (для каждого топика) |
|
| 15 |
/reset_topic_link_mode |
Сбросить настройки режима ссылок для топиков. |
При выполнении команды в топике настройки для топика будут сброшены и будут использоваться настройки чата. Вызвать команду может только администратор портала или Базы знаний |
Нет |
Да | В чате с топиками (для каждого топика) |
|
| 16 |
/article_new |
Создаёт новую статью и прикрепляет её к данному топику |
Нет |
Нет |
В чате с топиками |
||
| 17 |
/article_get |
Выдаёт панель управления над прикреплённой статьёй с быстрыми командами |
Нет |
Нет |
В чате с топиками |
||
| 18 |
/article_append_text |
Добавляет переданный текст в конец статьи |
Нет |
Нет |
В чате с топиками |
||
| 19 |
/article_to_pdf |
Генерирует и возвращает pdf-файл со всем содержимым статьи. |
Нет |
Нет |
В чате с топиками |
||
| 20 |
/article_external_link |
Создаёт и возвращает внешнюю ссылку на статью. |
Нет |
Нет |
В чате с топиками |
||
| 21 |
/article_add_comment |
Добавляет комментарий к статье.
Если ответить на сообщение с комментарием в телеграмме, то к статье добавится ответ к комментарию |
В Базовой версии приложения можно добавить только 2 комментария |
Нет |
Нет |
В чате с топиками |
|
| 22 |
/article_bind |
Привязывает переданную статью к топику |
Нет |
Нет |
В чате с топиками |
||
| 23 |
/article_unbind |
Отвязывает переданную статью от топика. |
Нет |
Нет |
В чате с топиками |
||
| 24 |
/dir_bind |
Привязывает переданный раздел ко всему чату. Одна директория может быть привязана только к одному чату. |
Нет |
Нет |
В чате с топиками |
||
| 25 |
/dir_unbind |
Отвязывает переданный раздел от чата. |
Нет |
Нет |
В чате с топиками |
||
| 26 |
/dir_check |
Проверяет, какой раздел привязан к чату |
Нет |
Нет |
В чате с топиками |
||
| 27 |
/article_suggest |
Предлагает вариант для контента статьи на основании информации в топике |
Нет | Да | В чате с топиками |