Работа с Telegram-ботом ViTalk
Visiology Robot (Unlicensed)
Губин Максим
Перед использованием Telegram-бота ViTalk необходимо провести его настройку и развёртывание.
Стандартная клавиатура
При успешном подключении пользователя к Telegram-боту, должна появится клавиатура.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200825-160207.png?version=1&modificationDate=1621332730821&cacheVersion=1&api=v2)
Если клавиатура отсутствует, её можно получить, введя команду /start.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200825-160346.png?version=1&modificationDate=1621332731033&cacheVersion=1&api=v2)
Стандартная клавиатура включает в себя следующие кнопки:
Новый запрос – сбрасывает состояние, которое было перед нажатием (например, ожидание уточнения предыдущего запроса, ожидание ввода настроек уведомлений).
Сохранить запрос –позволяет сохранить последний запрос, который был введён пользователем.
Сохранённые запросы – перечисляет сохраненные запросы, позволяет их выполнить или настроить уведомления по ним.
Демо тур – экскурсия по основным возможностям ViTalk. Позволяет лучше понять, как задавать вопросы ассистенту.
Что есть в базе? – экскурсия по базе данных. Позволяет понять, какие сущности (группы показателей, показатели, измерения, атрибуты и значения атрибутов) доступны в ViTalk, а также выяснить, какие ключевые слова используются для их выделения в запросах
Запросы к ViTalk
ViTalk принимает запросы на естественном языке в виде сообщений и выдаёт в качестве ответа виджет с визуальным представлением запрашиваемых данных.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200825-162346.png?version=1&modificationDate=1621332731227&cacheVersion=1&api=v2)
После получения виджета пользователь может дополнить запрос (кнопку “Уточнить запрос” при этом нажимать не обязательно).
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200825-162626.png?version=1&modificationDate=1621332731424&cacheVersion=1&api=v2)
Чтобы задать новый вопрос ViTalk, необходимо нажать кнопку “Новый запрос” (на стандартной клавиатуре или под сообщением). Нажимать её не обязательно, если после последнего запроса прошло более 5 минут.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200825-162750.png?version=1&modificationDate=1621332732039&cacheVersion=1&api=v2)
О том, как правильно задавать ViTalk вопросы и уточнять их, можно узнать, нажав кнопку “Демо тур”.
Сохранение запросов и настройка уведомлений
Последний выполненный запрос можно сохранить в течение 5 минут с последнего полученного сообщения.
Для этого после выполнения запроса нужно нажать кнопку “Сохранить запрос”.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-085630.png?version=1&modificationDate=1621332732243&cacheVersion=1&api=v2)
Далее, необходимо ввести имя запроса. Оно может быть любым, при условии, что у одного пользователя каждый сохраненный запрос имеет уникальное имя.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-085640.png?version=1&modificationDate=1621332732857&cacheVersion=1&api=v2)
Сохранив запрос, его можно найти в меню “Сохраненные запросы”.
Список сохраненных вопросов можно проматывать.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-085648.png?version=1&modificationDate=1621332733062&cacheVersion=1&api=v2)
Нажав на кнопку с интересующим запросом, можно его выполнить или отредактировать расписание.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-085700.png?version=1&modificationDate=1621332733257&cacheVersion=1&api=v2)
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-085716.png?version=1&modificationDate=1621332733870&cacheVersion=1&api=v2)
Чтобы регулярно получать уведомления по запросу, необходимо нажать на кнопку “Изменить расписание”. Далее, будет предложено выбрать периодичность уведомлений и время получения.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-085726.png?version=1&modificationDate=1621332734478&cacheVersion=1&api=v2)
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-085737.png?version=1&modificationDate=1621332734680&cacheVersion=1&api=v2)
Получение уведомлений по запросу
Если для запроса настроены уведомления, в назначенное время бот пришлёт сообщение с виджетом.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-085753.png?version=1&modificationDate=1621332734884&cacheVersion=1&api=v2)
Если вы хотите уточнить данные, присланные уведомлением, необходимо нажать кнопку “Уточнить запрос”. В противном случае уточнение не будет считаться относящимся к уведомлению. Это сделано на случай, если уведомление придёт в момент работы пользователя с другим запросом.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-085802.png?version=1&modificationDate=1621332735515&cacheVersion=1&api=v2)
Инциденты при использовании
“Идет проверка актуальности cache и версии платформы.
Нажмите "Далее", чтобы вывести статус проверки.” - сообщение появляется в ответ на запрос, если платформа или сервер ViTalk были перезапущены после последнего использования. Если ViTalk корректно настроен - достаточно нажать несколько раз кнопку “Далее” под сообщениями до появления приветствия.
![](https://visiology-doc.atlassian.net/wiki/download/attachments/124824685/image-20200826-081104.png?version=1&modificationDate=1621332735714&cacheVersion=1&api=v2)
На этой странице: