В данном проекте ведется работа по разработке описания сценария цифрового помощника. При подготовке структуры описания сценария ключевым критерием является соблюдение баланса между гибкостью настройки сценария и простотой его описания.
Цифровой помощник - это цифровая система, которая предоставляет полезную автоматизацию взаимодействия в формате диалога на естественном языке с возможностью быстрой настройки поведения и интеграции в другие информационные системы. Предпочтительным средством коммуникация для человека является диалог, поэтому цифровые помощники как средство взаимодействия с информационными системами довольно востребованы.
Цифровой помощник объединяет в себе три независимых слоя:
- описание поведения
- исполнитель поведения
- средство диалога
Поведение цифрового помощника зависимо от реакции использующего его пользователя, поэтому описание поведения помощника названо сценарием. Под сценарием понимается совокупность алгоритмов поведения, которые последовательно исполняются в зависимости от реакции пользователя.
Форматом записи сценария выбран json-формат как наилучший формат, предоставляющий баланс для одновременного понимания вычислительной машиной и человеком. Кроме того структура json может быть описана в его же формате с помощью json scheme. В проекте в качестве артефакта представлена json-схема описания сценария (схема).
Так как цифровой помощник представляет собой информационную систему, то поведение ее естественно описывать опираясь на принципы структурного программирования. Структурное программирование предполагает, что описание поведения состоит всего из трех структур управления:
- последовательности (sequence)
- ветвления (selection)
- цикла (iteration)
Учитывая что необходимо описывать сценарий, введены дополнительные структуры реакции пользователя:
- команда (command)
- ответ (reply)
- выбор из предлагаемых вариантов (choice)
Сценарий описывает в виде последовательности операций ответную реакцию помощника на действие пользователя. Описание вполне отдельной операции из последовательности назовем актом (/$def/act).
Акты исполняются последовательно в логике их типов:
- сообщение пользователю message (/$def/message);
- изменение контекста (/$def/context),
- ветвление selection (/$def/selection).
Сообщение пользователю является базовой операцией. Собственно через отправку сообщений и реализуется диалоговая форма взаимодействия со стороны помощника. Сообщение формируется из шаблона фразы на естественном языке пользователя, в которой могут быть использованы переменные. Шаблон фразы задается в атрибуте message акта сообщения. В момент формирования сообщения в шаблон подставляются значения переменных.
Вместе с сообщением можно отправить варианты выбора choices. Варианты задаются через массив из выбора choice либо через переменную типа ключ-значение. Выбор choice определяется значением value и текстом text.
При задании вариантов выбора через переменную в параметрах value и text выбора доступна зарезервированная переменная $$choice (см ниже). В параметре choice можно задать шаблон для value и text, которые будут заполняться при каждой итерации перебора указанной переменной. Если параметр choice не задан, то value = $$choice[key] и text = $$choice[value]
При выборе пользователем варианта выбранный вариант доступен в следующем акте через зарезервированную переменную $$choice (см ниже)
Совокупность значений переменных сценария является контекстом его исполнения. Управление контекстом описывается в специальном акте context. Управление контекстом осуществляется за счет изменения значений переменных. Изменение контекста может задаваться строго в сценарии либо запрашиваться у стороннего сервиса.
Обращение к стороннему сервису доступно в формате REST и jsonRPC.
Ветвление предоставляет вариативность исполнения сценария. Если условие, заданное в параметре if истинно, то исполняется последовательность успеха then, иначе последовательность неуспеха else. Последовательность неуспеха может быть не определена.
Команды являются исходными точками для начала исполнения сценария помощником и всегда доступны пользователю. Команда сбрасывает статус исполнения сценария до первого акта команды.
В сценарии цикл применяется в сценарии как итерация по переменной типа ключ-значение.
- определение списка вариантов для выбора клиенту, заданный через переменную, в акте типа message.
- цикличное повторение последовательности
Конечный сценарий хранится в совокупности файлах json-формата. Один файл - базовый файл сценария, хранит список команд. В остальных файлах хранятся последовательности. Каждая последовательность в отдельном файле. В название файла рекомендовано включать идентификатор и обозначение типа данных, которые содержит данный файл. Например:
- шаблон имени файла сценария: {id}.scenario.json
- шаблон имени файла последовательности: {id}.sequence.json
В качестве идентификатора сценария и последовательности рекомендовано использовать UUID.
Переменные сценария бывают пользовательские и зарезервированные. При использовании переменных необходимо перед именем переменной прописывать знак $.
Пользовательские переменные используются в шаблонах сообщений, условных сообщениях, вариантах выбора и при присвоении значения. Возможные пользовательские переменные задаются в описании сценария в разделе vars (/vars).
Имя пользовательской переменной имеет специальную структуру и ограничения. Имя переменной может состоять из букв (в кодировке utf-8), цифр, символа нижнего подчеркивания и символов квадратных скобок, которые допустимо использовать только особым образом (см ниже Нотация квадратных скобок).
Переменная
Переменные принимают значения стокового типа данных. Приведение к другим типам происходит при интерпретации значений в условных актах и в интеграции с другими системами через вызов удаленных процедур и REST методов.
За счет нотации квадратных скобок переменные можно организовать в структуры типа ключ-значение (список).
После основного имени переменной в квадратных скобках указывается имя свойства переменной. Например,
Переменная[Свойство]
При этом ограничение на имя свойства такое же как и для имени простой переменной.
Вложенность свойств может быть произвольной. Например,
Переменная[Свойство][ЕщеОдноСвойство]
Если две и более переменных имеют одинаковую часть имени до закрывающейся квадратной скобки, то эти переменные можно использовать как список. Например, если заданы две переменные
Переменная[Свойство][ОдноСвойство]
и
Переменная[Свойство][ДругоеСвойство]
то можно использовать список
$Переменная[Свойство]
как переменную в итерациях
Состав переменных и их значения определены и доступны в своей области видимости. Область видимости переменных ограничена последовательностью и ее дочерними последовательностями первого уровня. Причем не происходит переопределения значения переменных родительской последовательности в дочерних последовательностях. В дочерних последовательностях первого уровня доступны только значения переменных родительской последовательности. Значения переменных родительских переменных в дочерних последовательности могут быть переопределены.
Зарезервированные переменные принимают определенные значения в зависимости от этапа исполнения сценария. Значения зарезервированным переменным присваиваются либо при исполнении акта либо по итогу исполнения предыдущего акта. Во втором случае назначенные значения зарезервированных переменных доступны только в следующем акте. Если требуется использование значения зарезервированной переменной присвойте ее пользовательской переменной.
При указании зарезервированных переменных При использовании зарезервированных переменных необходимо перед именем переменной прописывать двойной знак $$.
Ниже перечислены зарезервированные переменные
Переменная доступна после исполнения акта типа message в следующем акте. Исполнение акта message завершается ответом пользователя. Ответ пользователя доступен через свойства этой переменной
- $$reply[message] - текст сообщения;
- $$reply[files] - массив ссылок на файлы, переданные в сообщении пользователем;
- $$reply[choice] - переменная содержит значение выбора, сделанного пользователем из предоставленных вариантов:
- $$reply[choice][text] - текст выбора;
- $$reply[choice][value] - значение выбора.
Переменная доступна в акте message, в котором используется список вариантов выбора listChoices ( /$def/listChoices). Для формирования списка вариантов выбора с использованием цикла по переменной. При этом в шаблоне варианта выбора можно использовать переменные:
- $$choice[key] - ключ элемента списка;
- $$choice[value] - значение элемента списка.
Переменная доступна в цикле последовательности (/$def/sequenceCycle)
- $$sequence[key] - ключ элемента списка;
- $$sequence[value] - значение элемента списка.
В определенных случах требуется особый расчет значения переменной, алгоритм расчета которого не описан в сценарии. Для этого служит особый тип присвоения переменной (/$def/endpointAssign). При исполнении акта присвоения через вызов внешнего endpoint'а на указанный адрес endpoint'а отправляется post запрос с телом, содержащим массив переменных с текущими значениями, в формате json. В ответ с кодом 200 должно вернуться значение, которое присваивается указанной переменной.
Описание сценария использует исполнитель сценария для реализации поведения цифрового помощника. Описание сценария не ограничивает выбор языка программирования или технологию реализации исполнителя. Реализация предполагается в виде отдельных приложений, плагинов или модулей.
В ходе взаимодействия цифрового помощника с пользователем исполнение сценария находится на определенном акте. Нахождение исполнения сценария на определенном этапе назовем состоянием исполнения сценария. Состояние исполнения сценария хранится для каждого отдельного пользователя. Состояние определяется текущим актом и контекстом. Под контекстом понимается совокупность значений переменных сценария.
1d44f96e-712d-415d-b12a-188c0529a412__start/587b116c-9f45-4ed4-be12-f3e049e7761e_2/8726ad27-8b53-4ee3-92ca-edd5e97c6ea1_4