Работа с данными шагов
Это значения переменных, которые формируются по факту прохождения шага клиентом в конкретном сценарии. Например, если это сообщение клиента в чат-боте, то мы получаем: текст сообщения, время отправки, id отправителя.
Данные шагов для клиента становятся доступны после того, как вы запустите сценарий, и клиент пройдет его шаги. Их можно использовать для настройки фильтров в сценарии, обновлении переменных клиента в профиле, подстановки значений в сообщения и другое.
Обратите внимание, что данные шагов клиента в сценарии — это не значения переменных этого клиента, записанные в профиле. Данные шагов хранятся в системе до тех пор, пока не будет очищена сессия прохождения сценария клиентом.
Примеры:
1. Обновление данных профиля клиента после получения данных из профиля ВК — в этом случае на шаге обновления переменных клиента необходимо использовать данные шага получения этих значений из профиля ВК.
Подробнее об этом можно прочесть в инструкции.
2. Значение данных шагов как условие для запуска определенной ветки сценария — в этом случае через данные шагов настраиваем соответствие нужному значению в фильтре при настройке условия проверки. Например, чтобы отправить клиенту уведомление об успешном платеже, необходимо проверить статус платежа, и сформировать сообщение для клиента в том случае, если платеж успешно прошел. Для этого настраивается фильтр с помощью данных шага «Проверка статуса платежа»: статус платежа — Равно succeeded:
В качестве примера можно посмотреть шаблон «Приём платежей через ЮКасса в мессенджере». Инструкция к данному шаблону https://help.apicxhub.ru/integratsiya-s-yukassa#priem-plategey-cherez-yukassa-v-messendgere
3. Бот отправляет клиенту сообщение со сгенерированным ИИ текстом — в этом случае для настройки текста сообщения бота необходимо использовать данные шага генерации текста.
Данные шагов состоят из переменных и их значений. Названия переменных будут одинаковыми для всех клиентов в рамках сценария, а значения — индивидуальные для каждого клиента.
Для использования данных шагов достаточно, чтобы хотя бы один клиент прошел сценарий. После этого появятся переменные и значения шагов по нему, и вы сможете использовать эти данные для настройки последующих шагов сценария.
Важно! Если очистить сессию клиента, данные шагов удалятся, и не получится найти необходимые переменные для дальнейшей настройки. Не удаляйте сессию клиента пока не завершите настройку шагов, где используются полученные данные.
Разберем детально пример:
Сценарий, в котором ИИ определяет эмоциональную окраску нового комментария в сообществе, генерирует ответ в виде одного из трех значений: «позитивный», «нейтральный», «негативный». Далее, в зависимости от окраски комментария ИИ генерирует ответ на него.
В данном сценарии в шагах 2.1-2.3 настраивается фильтр для проверки на соответствие одному из трех значений, которое было получено от ИИ на предшествующем шаге определения эмоциональной окраски:
Для настройки проверки в шаге 2.1 необходимо:
1. Получить данные по предшествующему шагу — это возможно сделать путем прохождения клиентом шага в сценарии:
- Настроить предшествующие шаги, включая тот, по которому нужно получить данные.
- Запустить сценарий — ничего страшного, что последующие шаги не будут настроены. Это нормально. Если отсутствие настроек по каким-то дальнейшим шагам препятствует запуску сценария, можно временно удалить эти шаги или указать любые значения в настройках. На этом этапе последующие шаги не важны.
- Пройти сценарий — можно пройти не весь, главное, чтобы был пройден шаг, по которому получаем данные.
2. Убедиться, что данные шага получены.
- Открыть в сценарии сессии клиента:
- По идентификатору и его значению найти клиента, который прошел необходимый шаг сценария:
- Развернуть окно с данными шага и посмотреть путь, куда записывается значение необходимой переменной, в данном случае ответ ИИ. Это пригодится на этапе настройки следующего шага, в котором будут использоваться полученные данные:
Если сценарий не был пройден клиентом, вы увидите следующее сообщение:
3. Настроить использование данных шагов в других шагах:
- Открыть окно редактирования шага, в котором необходимо использовать полученные данные. В нашем примере это шаг с проверкой, для которого нужно настроить фильтр:
- Нажать «Добавить фильтр» и в первом поле в выпадающем списке выбрать «Данные шагов»:
- Нажать «Условие», далее с помощью идентификатора и его значения найти клиента, по которому мы получили необходимые данные шагов:
Если клиент прошел сценарий, по нему появятся данные всех шагов, которые он прошел:
Если клиент не прошел необходимые шаги сценария, появится сообщение:
- Найти необходимую переменную в списке (путь к переменной соответствует тому, что видели в сессии клиента) и использовать ее для настройки фильтра:
- Нажать на необходимую переменную, и в появившемся окне задать для нее необходимые значения, и затем нажать «Применить»:
- Нажать «Сохранить» фильтр
- Нажать «Сохранить» шаг
- Настроить аналогичным образом другие шаги, где используются данные шагов
4. Перезапустить сценарий, очистив сессии всех клиентов, и протестировать его.