Table of Contents

absoluteUrl	true

Общее описание

Сценарии позволяют описывать диалоги системы autoFAQ с пользователями. Диалог может включать в себя переписку с пользователем, обращение к данным во внешних системах и обогащение ответов.

Система позволяет создавать сценарии диалогов произвольной сложности и прикреплять их напрямую к документам в базах знаний или событиям в работе над диалогами. В случае когда база знаний по запросу пользователя определяет документ, содержащий вместо ответа сценарий, бот начнет вести с пользователем описанный в сценарии диалог.

Описание сценариев в системе ведется при помощи языка DSL autoFAQ. Тело сценария состоит из последовательных операций. Каждая операция располагается в отдельной строке, для связи со следующей операцией в конце строки требуется указание символа "+". Некоторые операции могут содержать 1 или несколько опциональных модификаторов.

Системные переменные

Для работы с контекстом в сценариях доступны следующие системные переменные:

Code Block

{userFullName} - имя пользователя

{userLogin} - логин пользователя

{userEmail} - электронная почта пользователя

{userPayload.<название_даных>} - дополнительные данные о пользователе, полученные при идентификации пользователя во внешней системе

{platformInMessageQuery} - текст запроса пользователя

{http_code} - переменная содержит код статуса последнего запроса к API

Пользовательские переменные

В сценариях возможно создавать и использовать для хранения данных любые пользовательские переменные. Значение переменной будет потеряно после завершения сценария.

Code Block
{userSaidYes} - пример пользовательской переменной

Списки

Переменная attachments[] хранит не одно значение, а список значений, при записи новых значений в данную переменная они будут дописаны в конец списка.

Code Block

запроситьФайл("Приложите файл").сохранитьРезультат("file")+    -   полученные данные перезапишут значение переменной
запроситьФайл("Приложите файл").сохранитьРезультат("files[]")+ -   полученные данные будут дописаны в список

Порядок выполнения шагов сценария

Anchor

	order
	order

Все шаги сценария выполняются последовательно с первой до последней строки. Если вы хотите временно исключить одну из строк из процесса выполнения сценария - установите в начале данной строки символ //

Code Block

breakoutMode	wide

сообщениеПользователю.сШаблоном("Привет")+						- шаг будет выполнен
//сообщениеПользователю.сШаблоном("Привет, {userFullName}")+ 	- шаг не будет выполнен

В конце сценария обязательно размещение одного из шагов завершения сценария:

Code Block

breakoutMode	wide
language	py

завершить - завершение сценария
завершитьСШаблоном("Пока!") - завершение сценария с выводом сообщения пользователю
завершитьСНовымЗапросом("Новый запрос") - завершение сценария и одновременный запуск в работу нового сообщения
завершитьИПеревестиНаОператора - звершение сценария и перевод диалога в очередь оператору
завершитьИЗакрытьДиалог() - завершение сценария и закрытие диалога, следующая реплика пользователя начнет новый диалог

Если в условии сценария применен один из шагов завершения, то сценарий может завершить работу досрочно:

Code Block

breakoutMode	wide

если("{http_code} != 200").то(
  комментарий("Данные пользователя не обновлены")+
  завершитьИПеревестиНаОператора 
)+
комментарий("Обовлены данные пользователя. Новые данные отправлены в CRM")+
завершить

Список команд языка DSL

Шаги переписки с пользователями

сообщениеПользователю.сШаблоном(

"сообщение"

*args)

Вывод простого Шаг отправки текстового сообщения пользователю без ожидания ответной реакции. Сообщение может содержать HTML форматирование, а также использовать вставку значений переменных. Сообщение будет передано в текущий открытый диалог, в тот же канал В качестве аргумента шаг принимает текст сообщения или переменную, которая содержит такой текст. Сообщения без текста не будут отправлены.

Текст сообщения может содержать HTML теги для форматирования сообщения. Текст сообщения также может включать в себя вставку значений из переменных. Система самостоятельно проверит форматирование сообщения на соответствие требованиям канала.

Пример вывода простого текстового сообщения:

Code Block

breakoutMode	wide

сообщениеПользователю.сШаблоном("Текст сообщения")Спасибо и всего хорошего") +	вывод простого текстового сообщения

...

Пример вывода текстового сообщения с переменой:

Code Block

breakoutMode	wide

сообщениеПользователю.сШаблоном("Сообщение от {userFullName}") +	вывод текстового сообщения с использованием данных из переменной

...

Пример вывода текстового сообщения с HTML форматированием ссылки:

Code Block

breakoutMode	wide

сообщениеПользователю.сШаблоном("Пройдите по <a href='https://yandex.ru'>ссылке</a>") +
вывод HTML форматированного сообщения...

сообщениеПользователю.сФайлами(111).сШаблоном(

"сообщение"

*args)

Расширением предыдущей команды служит часть ".сФайлами", которая позволяет отправить пользователю файлы из текущего документа.

Code Block

breakoutMode	wide

сообщениеПользователю.сФайлами(523).сШаблоном("Высылаю файл") - отправка файла с идентификатором 523 пользователю вместе с сопровождающим текстом
сообщениеПользователю.сФайлами(523, 524, 525).сШаблоном("Высылаю файл") - отправка нескольких файлов пользователю
сообщениеПользователю.сФайлами(523).сШаблоном("") - отправка файла пользователю без сопровождающего текста

Идентификатор файла копируется из формы прикладывания файла к документу.

Info
Передача файлов пользователю поддерживается только для сценариев в документах баз знаний и не поддерживается для сценариев приветствия и интеграций.

задатьПользователюВопрос

("сообщение"

**(args).сохранитьРезультат(args)**

Вывод текстовой информации и ожидание ввода пользователя. Поддерживает вывод форматированного сообщения с использованием переменных, получение и проверку данных на соответствие шаблону. Время ожидания ответа от пользователя устанавливается таймером сценариев в разделе Настройки - Запросы - Сценарии.

Шаг отправки пользователю вопроса пользователю и ожидания ответа.

В качестве аргумента для задатьПользователюВопрос принимается текст вопроса или переменную, которая содержит такой текст. Сообщения без текста не будут отправлены. Текст вопроса может содержать HTML теги для форматирования сообщения. Текст сообщения также может включать в себя вставку значений из переменных. Система самостоятельно проверит форматирование сообщения на соответствие требованиям канала.

В качестве аргумента для сохранитьРезультат принимается название переменной, в которую сценарий поместит ответ пользователя. Если указанная переменная ранее не была определена в сценарии - сценарий создаст её.

Пример простого вопроса пользователю:

Code Block

breakoutMode	wide

задатьПользователюВопрос("На какую дату нужен пропуск ?").сохранитьРезультат("daywhatDay")+

Система будет ожидать ответ пользователя все время жизни сценария. Время жизни сценария устанавливается в разделе Настройки - Запросы - Сценарии.

Функции операции:

.сВариантамиОтвета(варианты) - функция предоставляет пользователю варианты выбора из списка. В случае если канал позволяет отображать кнопки - варианты будет представлены кнопками, в противном случае варианты будут представлены автоматически сгенерированным списком. При этом пользователь сохраняет возможность написать ответ вручную минуя варианты выбора.

Code Block

breakoutMode	wide

задатьПользователюВопрос("На какую дату нужен пропуск ?").сВариантамиОтвета("Сегодня", "Завтра").сохранитьРезультат("day")+

.проверитьФормат(формат, сообщение) - функция проверяет полученные от пользователя данные на соответствие шаблону. Шаблон задается регулярным выражением. В случае соответствия ответной реплики пользователя шаблону шаг передает данные далее, в обратном случае - выводит текст сообщения и ожидает получения корректной информации без ограничений по количеству попыток ввода.

Code Block

breakoutMode	wide

//  выражение для проверки, что введенная строка соотвествует формату даты вида 02.12.2021
задатьПользователюВопрос("Укажите дату").проверитьФормат("(0[1-9]|[12][0-9]|3[01])[- \/.](0[1-9]|1[012])[- \/.](19|20)\\d\\d", "Не понял вас, повторите пожалуйста.").сохранитьРезультат("day")+

//  выражение для проверки, что введенная строка содержит адрес электронной почты
задатьПользователюВопрос("Напишите email").проверитьФормат("^\\S+@\\S+\\.[a-z]{2,}$", "Пожалуйста, введите корректный email").сохранитьРезультат("_email")+

.сохранитьРезультат(переменная) - функция сохраняет полученные данные в переменную для дальнейшего использования в сценарии.

Code Block

breakoutMode	wide

задатьПользователюВопрос("Как дела?").сохранитьРезультат("what")+
если("{what} != Хорошо").то(
  комментарий("А дела то не хорошо")+
  завершитьИПеревестиНаОператора 
)+
комментарий("Все отлично")+
завершить

вызвать

Вызывает внешние команды и системы. В настоящее время поддерживается только к HTTP(REST и SOAP) сервисам, планируется подключение к почтовым , FTP и прочим сервисам

Функции операции:

.внешнийСервис(адрес, тип) - обязательная функция, которая формирует вызов API сервисов. В параметрах указывается адрес сервиса и тип запроса. Поддерживаются основные HTTP запросы - GET, POST, PUT.

Code Block

breakoutMode	wide

вызвать.внешнийСервис("https://api.autofaq.ai/v1/ping","GET").сохранитьРезультат("result")+

.сПараметрами() - необязательная функция, передает в запрос список параметров адресной строки, параметры будут собраны в соответствующий запросу формат

Code Block

breakoutMode	wide

вызвать.внешнийСервис("https://server.com/api +
...

Пример сценария с вопросом и разбором результатов:

Code Block

breakoutMode	wide

задатьПользователюВопрос("Как дела?").сохранитьРезультат("what")+
если("{what} != Хорошо").то(
  комментарий("А дела то не хорошо")+
  завершитьИПеревестиНаОператора 
)+
комментарий("Все отлично")+
завершить

Время ожидания ответа от пользователя устанавливается таймером сценариев, значение которого можно указать в разделе Настройки - Сценарии. Если ответ от пользователя не поступит в указанное время, сценарий будет завершен. После завершения сценарий по таймеру система отправит пользователю соотвествующее служебное сообщение, текст которого можно указать в разделе Настройки - Сценарии.

Дополнительные модификаторы для данного шага включают в себя возможность указания вариантов ответа и правила проверки ответа по шаблону.

.сВариантамиОтвета(варианты)

Модификатор шага отправляет пользователю вместе с вопросом готовые варианты ответа. В случае если текущий пользовательский канал позволяет отображать кнопки - варианты будет представлены кнопками, в противном случае варианты будут представлены автоматически сгенерированным списком с номерами вариантов. В любом случае пользователь может выбрать вариант отправив в ответном сообщении его номер или может написать свой ответ вручную минуя варианты выбора.

Code Block

breakoutMode	wide

задатьПользователюВопрос("На какую дату нужен пропуск ?").сВариантамиОтвета("Сегодня", "Завтра").сохранитьРезультат("whatDay") +
...

.проверитьФормат(формат, сообщение)

Модификатор шага проверяет полученные от пользователя данные на соответствие шаблону. Шаблон задается регулярным выражением. В случае соответствия ответной реплики пользователя шаблону шаг передает данные далее, в обратном случае - выводит текст сообщения и ожидает получения корректной информации без ограничений по количеству попыток ввода.

Code Block

breakoutMode	wide

//  выражение для проверки, что введенная строка соотвествует формату даты вида 02.12.2021
задатьПользователюВопрос("Укажите дату").проверитьФормат("(0[1-9]|[12][0-9]|3[01])[- \/.](0[1-9]|1[012])[- \/.](19|20)\\d\\d", "Не понял вас, повторите пожалуйста.").сохранитьРезультат("day")+

//  выражение для проверки, что введенная строка содержит адрес электронной почты
задатьПользователюВопрос("Напишите email").проверитьФормат("^\\S+@\\S+\\.[a-z]{2,}$", "Пожалуйста, введите корректный email").сохранитьРезультат("_email")+

**запроситьФайл(*args).сохранитьРезультат(переменная)**

Шаг запроса файла у пользователя и записи его в переменную. В качестве аргумента шаг принимает текст просьбы или переменную с таким текстом. Файл будет сохранен в хранилище файлов диалога и будет доступен в указанной переменной.

Code Block

breakoutMode	wide

запроситьФайл("Приложите файл").сохранитьРезультат("file")+ +

Дополнительные модификаторы шага включает опцию пропуска отправки файла

.можноПропустить(сообщение) - функция позволяет пользователю пропустить отправку файла

Code Block

breakoutMode	wide

запроситьФайл("Приложите файл").можноПропустить("Пропустить")+

Шаги работы с внешними сервисами

Шаги обращения к внешним сервисам и разбора полученных данных. В настоящее время поддерживается API вызовы REST и SOAP сервисов, планируется подключение к почтовым, FTP и прочим сервисам.

Функции операции:

**вызвать.внешнийСервис(адрес, тип).сохранитьРезультат(*args)**

Шаг вызова REST API сервисов. Данный шаг ожидает получение ответа в формате плоского JSON. Для работы с SOAP сервисами используется данный шаг с модификаторам, которые будут указаны ниже.

В качестве аргументов для вызвать.внешнийСервис принимаются адрес ендпонта и тип вызова. Поддерживаются основные типы вызовов - GET, POST, PUT, DELETE. В качестве адреса ендпойнта принимается строка с адресом или переменная, которая содержит данную строку.

В качестве аргументов для сохранитьРезультат принимается список пар из названия поля в полученном JSON и названия переменной, в которую сценарий сохранит полученное значение.

Пример GET запроса, из ответа которого будет выбрано 1 поле result

Code Block

breakoutMode	wide

вызвать.внешнийСервис("https://api.autofaq.ai/v1/ping","GET").сохранитьРезультат(("result", "answer_code")) +

Пример POST запроса с указанием адреса вызова из переменной, телом запроса и разбором двух полей из ответа - message и code

Code Block

breakoutMode	wide

установитьПеременную("post_url", "https://api.autofaq.ai/v1/ping") +
...
вызвать.внешнийСервис("{post_url}", "POST").сТеломСообщения("{query}").сохранитьРезультат(("message", "response_message"),("code", "response_code")) +
...

Модификаторы шага позволяют указать URL параметры запроса, заголовки, тело сообщения или сохранить ответ со сложной структурой для дальнейшего разбора.

.сПараметрами()

Модификатор шага вызова сервиса для передачи URL параметров запроса. Параметры передаются парами в формате название параметра - значение параметра. Значение параметра может быть указано текстом или переменной, которая содержит данный текст.

Code Block

breakoutMode	wide

установитьПеременную("user_token", "1234567890abcd") +
...
вызвать.внешнийСервис("{url}","GET").сПараметрами(("fooquery","barorder"),("token",("{user_token","1234567}")).сохранитьРезультат(("result", "answer_code")) +
...

.сЗаголовками()

- необязательная функция, передает в запрос список заголовков в формате пар ключ:значение

Модификатор шага вызова сервиса для передачи заголовков запроса. Заголовки передаются парами в формате название заголовка - значение заголовка. Значение заголовка может быть указано текстом или переменной, которая содержит данный текст.

Code Block

breakoutMode	wide

установитьПеременную("user_token", "1234567890abcd") +
...
вызвать.внешнийСервис("https://server.com/api{url}", "POST").сЗаголовками(("Content-Type", "application/json"),("charset", "utf-8"),("Authorization","Bearer {user_token}")).сохранитьРезультат("result")+

.сТеломСообщения() - необязательная функция, передает тело запроса. Поддерживаются форматы x-www-form-urlencoded и json

Code Block

breakoutMode	wide

// передача JSON в виде строки
вызвать.внешнийСервис("https://server.com/api", "POST").сЗаголовками(("Content-Type", "application/json")).сТеломСообщениясохранитьРезультат(("{\"name\":\"new document\result", \"question\":\"new question\"}")+
answer_code")) +
...

.сТеломСообщения()

Модификатор шага вызова сервиса для передачи тела запроса.

Поддерживаются форматы x-www-form-urlencoded и json. JSON передается кодированный в строку. Названия и значения параметров принимаются строкой или переменной, которая содержит эту строку.

Code Block

breakoutMode	wide

// передача x-www-form-urlencoded JSON 
вызвать.внешнийСервис("https://server.com/api{url}", "POST").сЗаголовками(("Content-Type", "application/x-www-form-urlencodedjson")).сТеломСообщения("{\"name=\":\"new document\", question=\"question\":\"new question\"}")+.

сСоставнымТеломСообщения() - необязательная функция, передает multipart тело запроса для передачи файлов. При передаче файла можно указать либо полное название файла либо идентификатор файла в файловом хранилище диалога

Code Block

breakoutMode	wide

сохранитьРезультат(("result", "answer_code")) +
// передача файла через указание пути
x-www-form-urlencoded
вызвать.внешнийСервис("https://server.com/api{url}", "POST").сСоставнымТеломСообщениясЗаголовками(("contentContent-Type", -> "C:/docker.yml")).сохранитьРезультат("callRes")+
"application/x-www-form-urlencoded")).сТеломСообщения("name=new document, question=new question").сохранитьРезультат(("result", "answer_code")) +

.сСоставнымТеломСообщения()

необязательная функция, передает multipart тело запроса для передачи файлов. При передаче файла можно указать либо полное название файла либо идентификатор файла в файловом хранилище диалога

Code Block

breakoutMode	wide

// передача файла через идентификаторуказание впути
хранилище
вызвать.внешнийСервис("{post_url}https://server.com/api", "POST").сЗаголовками(("apikey","{apikey_var}")).сСоставнымТеломСообщения(("content" -> "{fileId}"),("type" -> "addAttachC:/docker.yml")).сохранитьРезультатКакСтрокусохранитьРезультат("callRes")+

.сохранитьРезультат() - функция обрабатывает полученный ответ в формате JSON, сохраняет значения указанных полей в переменные сценария. Функция обрабатывает каждое значение ключа ответа и сохраняет его в отдельной переменной. В качестве параметров команды указываются пары ключ ответа - переменная

Code Block

breakoutMode	wide


// передача файла через идентификатор в хранилище
вызвать.внешнийСервис("{post_url}", "POST").сТеломСообщениясЗаголовками(("apikey","{queryapikey_var}")).сохранитьРезультатсСоставнымТеломСообщения(("messagecontent", -> "response_message{fileId}"),("codetype", -> "response_codeaddAttach")).сохранитьРезультатКакСтроку("callRes")+

.сохранитьРезультатКакСтроку()

-

функция обрабатывает полученный ответ в формате JSON и сохраняет сериализованный в текст ответ целиком в переменную. Содержание переменной может быть разобрано далее по ходу сценария.

Code Block

breakoutMode	wide

// запрос и сохранение результата в строку
вызвать.внешнийСервис("{post_url}", "POST").сТеломСообщения("{query}").сохранитьРезультатКакСтроку("answer")+
// разбор ответа в JS коде (рассмотрено ниже)
выполнитьJs("""
  try {
    var answerParsed = JSON.parse(answer);
  } catch(err) {
    var answerParsed = {'results':[]};
  }
   
  var resultsLength = answerParsed.results.length;
  var exit = {'resultsLength ':resultsLength};
  exit;
""") +

установитьПеременную(переменная, значение)

Операция установки значений переменной, старое значение будет затерто. При указании значения допускается использование переменных. Переменная будет доступна только в рамках выполняемого сценария.

Code Block

breakoutMode	wide

установитьПеременную("date", "Сегодня {new_date}")+

**установитьПеременнуюВДиалог(*аргументы)**

Операция установки переменной для всего диалога. При указании значения допускается использование переменных. Переменная диалога сохраняет свое значение на протяжении всего диалога, может быть создана и прочтена в рамках любого сценария. В новом диалоге будет отсутствовать.

Может быть использована для хранения информации связанной с контекстом диалога, для хранения контекста пользователя в рамках всех диалогов необходимо воспользоваться созданием переменной пользователя.

Code Block

breakoutMode	wide

установитьПеременнуюВДиалог(
    ключ = "priority",                  - системное название задаваемой переменной, любой текст
    значение = "[\"v1\", \"v2\"]",      - значение, может быть пустым 
    название = "Выберите критичность",  - название, которое будет отображаться в интерфейсе, строка
    редактируемое = true,               - является ли поле редактируемым или нет, true/false
    показыватьОператору = true,         - показывать ли оператору в боковой панели, true/false
    обязательное = true,                - является ли обязательным для заполнения при закрытии диалога, true/false
    множественныйВыбор = true,          - можно ли выбрать несколько вариантов, применимо только для выпадающего списка, true/false
    тип = "Выпадающий список",          - тип задаваемой переменной, возможные значения в таблице ниже
    варианты = "{\"v1\": \"High\", \"v2\": \"Medium\"}" - список возможных значений, применимо только для выпадающего списка, можно задать как с помощью другой переменной, так и напрямую
)+

Список возможных типов с примерами использования:

Тип

Пример использования

Текст

Code Block

установитьПеременнуюВДиалог(
	ключ = "NonEditabletext",
    значение = "Нередактируемый текст",
    название = "Примечание",
    показыватьОператору = true,
    редактируемое = false,
    обязательное = false,
    тип = "Текст"
)

Code Block

установитьПеременнуюВДиалог(
    ключ = "textField",
    значение = "г.Москва Ул.Тверская",
    название = "Адрес",
    показыватьОператору = true,
    редактируемое = true,
    обязательное = true,
    тип = "Текст"
)

Число

Code Block

установитьПеременнуюВДиалог(
	ключ = "number",
    значение = "",
    название = "Возраст",
    показыватьОператору = true,
    редактируемое = true,
    обязательное = true,
    тип = "Число"
)

Выпадающий список

Code Block

установитьПеременную("priority", "{\"v1\": \"Blocker\", \"v2\": \"Critical\", \"v3\": \"Major\", \"v4\": \"Minor\"}")+
установитьПеременнуюВДиалог(
    ключ = "priority",
    значение = "[\"v1\", \"v2\"]",
    название = "Выберите критичность",
    редактируемое = true,
    показыватьОператору = true,
    обязательное = true,
    множественныйВыбор = true,
    тип = "Выпадающий список",
    варианты = "{priority}"
)

Code Block

установитьПеременнуюВДиалог(
    ключ = "severity",
    значение = "",
    название = "Выберите важность",
    редактируемое = true,
    показыватьОператору = true,
    обязательное = true,
    тип = "Выпадающий список",
    варианты = "{\"v1\": \"High\", \"v2\": \"Medium\", \"v3\": \"Low\"}"
)

Переключатель

Code Block

установитьПеременнуюВДиалог(
	ключ = "switcher",
    значение = "true",
    название = "Активный?",
    показыватьОператору = true,
    редактируемое = true,
    обязательное = true,
    тип = "Переключатель"
)

установитьПеременнуюПользователю(переменная, значение)

Операция установки переменной для пользователя. При указании значения допускается использование переменных. Переменная пользователя сохраняет свое значение до тех пор пока не будет очищена. Может быть создана и наполнена в любом сценарии. После создания переменная будет доступна в любом сценарии любого диалога.

Можно установить значение одной из фиксированных переменных пользователя или произвольной переменной в составе payload. Сохранение данных пользователя позволит передавать данные между разными диалогами.

Code Block

// установка фиксированной переменной
установитьПеременнуюПользователю("userEmail", "vasya@mail.ru")+
// установка переменной из payload
установитьПеременнуюПользователю("userPayload.lastLoginTS", "{nowTimeStamp}")+

если(условие)

Операция сравнения переменных. Доступны операции сравнения: равенство (==), больше (>), меньше (<), неравенство (!=).

Функции операции:

.то(список операций) - обязательный блок операций, которые будут выполнены в случае истинности проверки

Code Block

breakoutMode	wide

если("{error} == 1").то(сообщениеПользователю.сШаблоном("Система не работает"))+

Блок операций может состоять из нескольких операций, различные операции в блоке соединены знаком “+”, последняя операция в блоке не должна содержать “+“

Code Block

breakoutMode	wide

если("{when_error} == 1").то(
   задатьПользователюВопрос("Не разобрал дату. Введи пожалуйста еще раз").сохранитьРезультат("when")+
   вызвать.внешнийСервис("http://yandex.ru", "GET").сПараметрами(("text","{when}")).сЗаголовками().сохранитьРезультат(("name", "when"))
)+

.и(условие) - функция объединения условий

Code Block

breakoutMode	wide

если("{error} == 0").и("{connection_mistakes} == 0").то(сообщениеПользователю.сШаблоном("Система работает"))+

.или(условие) - функция выполняет дизъюнкцию

("text","{when}")).сЗаголовками().сохранитьРезультат(("name", "when"))
)+

.и(условие) - функция объединения условий

Code Block

breakoutMode	wide

если("{error} == 10").илии("{connection_mistakes} == 10").то(сообщениеПользователю.сШаблоном("Система не отвечает"))+

запроситьФайл("сообщение")

Процедура получения файла и записи его в переменную. Пользователю будет выведен текст сообщения. Файл будет сохранен в хранилище файлов диалога.

Code Block

breakoutMode	wide

запроситьФайл("Приложите файл")+

Функции операции:

.можноПропустить(сообщение) - функция позволяет пользователю пропустить отправку файла

сШаблоном("Система работает"))+

.или(условие) - функция выполняет дизъюнкцию условий

Code Block

breakoutMode	wide

запроситьФайлесли("Приложите файл{error} == 1").можноПропуститьили("Пропустить{connection_mistakes} == 1")+.

сохранитьРезультат(переменная) - функция сохраняет идентификатор полученного файла в переменную

Code Block

breakoutMode	wide

запроситьФайл("Приложи файл").сохранитьРезультат("file"то(сообщениеПользователю.сШаблоном("Система не отвечает"))+

установитьМетку()

Установка определенной метки в коде, чтобы потом в нее можно было перейти из любого места сценария.

Code Block

breakoutMode	wide

установитьМетку("раз")+лог

перейтиНаМетку()

Осуществить переход на установленную метку в сценарии.

Code Block

breakoutMode	wide

// перети на метку не более 3 раз, на 4 раз шаг перехода не сработает 
перейтиНаМетку("раз").неБольше(3)+  
// переход на метку без указания лимита переходов, используется значение по-умолчанию 30
перейтиНаМетку("раз")+

запросВБазыЗнаний(вопрос, переменная)

Проверка наличия у системы автоматического ответа на указанный запрос. Если в базах знаний есть ответ, который удовлетворяет требованиям по точности, переменной будет присвоено значение true, если ответа нет - false.

Code Block

breakoutMode	wide

запросВБазыЗнаний("Как купить слона", "botKnows")+
если("{botKnows} == true").то(
  сообщениеПользователю.сШаблоном("Ответ есть")
)+

назначитьТематику(ID базы знаний)

Шаг принудительного указания тематики диалога. Шаг замещает все автоматически определенные тематики и сохраняет значение тематики вне зависимости от того что пишет пользователь.

Для установки тематики требуется указать идентификатор базы знаний.

Code Block

назначитьТематику("1234")+
// диалог попадет на скилл группу операторов со специализацией на базе знаний с ID 1234
завершитьИПеревестиНаОператора

Если база знаний с указанным идентификатором не будет найдена шаг не заменит тематику.

назначитьОператора(логин оператора)

Шаг указания оператора для диалога. Требуется указать логин оператора.

Code Block

breakoutMode	wide

назначитьОператора("vasya@mail.ru")+
//
// Сценарий не обязательно должен завершаться переводом на оператора завершитьИПеревестиНаОператора,
// можно просто завершить - назначенный оператор будет найден когда диалог попадет на операторов 
завершить

При попадании диалога с установленным оператором в процедуру назначения оператора система в первую очередь попытается назначить диалог на оператора с указанным логином. Если такой оператор существует и удовлетворяет всем требованиям автоназначения - система назначит диалог на данного оператора. Если оператора с таким логином не существует или он не удовлетворяет требованиям автоназначения система проведет назначение на другого оператора по стандартным правилам.

Info
Для корректного назначения на оператора следует проверить соответствие тематики диалога специализации оператора. Проще всего установить диалогу нужную тематику через шаг назначитьТематику()

В последующем, данные оператор может перевести диалог на другого оператора или в другую группу - система больше не будет пытаться назначить диалог на него.

комментарий("сообщение")

Команда позволяет добавлять комментарий в диалог. Комментарий виден администраторам и операторам системы, пользователь не видит комментарии.

Code Block

breakoutMode	wide

комментарий("текст комментария")+

выполнитьJs(скрипт)

Выполнить произвольный скрипт на JavaScript. Шаг позволяет реализовать произвольную логику вычислений или разбор сложных объектов.

Info

Javascript VM соответствует ECMAScript 5.1

Используйте обычный синтаксис callback function поскольку не поддерживается синтаксис lambda функций ES6

JS скрипт имеет доступ ко всем переменным сценария. Результаты скрипта следует записать в JSON объект и передать его на выход, в DSL сценарии можно будет получить к ним доступ по названиям полей.

Code Block

language	js

выполнитьJs("""
  var uids = JSON.parse(results);
  var ln = uids.length;
  if (ln == 0) {var uuid = '';} else {var uuid = uids[0]["UUID"];}
  var exit = {'uuid':uuid, 'numberOfUids':ln};
  exit;
""") +
завершитьСШаблоном("Заявка создана, всего создано полей {numberOfUids}, первый id - {uuid}.")

Внутри JavaScript есть возможность получить данные об операторе для случая, когда запущен сценарий на интеграцию по кнопке. Название объекта - initByOperator.

Пример использования:

Code Block

language	js

выполнитьJs("""
var initByOperator = JSON.parse(initByOperator);
var initByOperatorLogin = initByOperator.login;
var exit = {'operatorLogin ': initByOperatorLogin, 'operatorFIO': initByOperator.fullName, 'operatorEmail': initByOperator.email};
exit;
""")+
комментарий("ФИО оператора: {operatorFIO}") +
комментарий("Логин оператора: {operatorLogin}") +
комментарий("Email оператора: {operatorEmail}") +

Весь список параметров, к которым можно получить доступ:

id: String, login: String, fullName: Option[String], isActive: Boolean, isNotify: Boolean, serviceId: String, actions: Seq[UserRoleType], email: Option[String], settings: UserSettings = UserSettings()

knowledgeBases: Seq[Long] = Seq.empty, autoAssignEnabled: Boolean = false

добавитьПолеВФормуОператора(*args)

Для конструирования формы, которая будет показана оператору в момент работы сценария интеграции, добавлена команда добавитьПолеВФормуОператора со следующими параметрами:

Code Block

breakoutMode	wide

форма: String, - имя формы - обязательный параметр
переменная: String, - имя переменнной, которая пойдет в сценарий и имя в html form - обязательный параметр
название: String - имя на форме,
тип: String - Тип HTML ввода - обязательный параметр, если не задано или неверное -> нередактируемый текст 
описание: String  - описание на форме,
значение: String - предопределенное значение,
обязательное: Boolean - обязательность - по-умолчанию - false,
варианты: String - варианы для выпадающих списков - пример - {\"v1\": \"l1\", \"v2\": \"l2\"}

Пример:

Code Block

breakoutMode	wide

добавитьПолеВФормуОператора(
  форма = "Заведение заявки в Jira",
  переменная = "t6",
  название = "Теги",
  тип = "Множественный выбор",
  описание = "Выберите теги, которыми пометить обращение",
  варианты = "{tags}",
  обязательное = true
)

Список возможных значений параметра "тип":

"Нередактируемый текст"
"Однострочный редактируемый текст"
"Многострочный редактируемый текст"
"Переключатель"

"Целое число"
"Выпадающий список"
"Множественный выбор"

показатьФормуОператору(имя = "форма")

После того, как все поля формы заданы, нужно использовать команду для показа формы. Сценарий отобразит форму и продолжит свою работу только после того как оператор нажмет кнопку Продолжить на форме или не закончится таймер сценария.

Code Block
показатьФормуОператору(имя = "Заведение заявки в Jira")

Шаги работы с группами

определитьИдентификаторГруппы(*args)

Шаг определения текущей группы диалога. В качестве аргумента шаг принимает название переменной куда будет установлен текстовый идентификатор текущей группы диалога.

Code Block
определитьИдентификаторГруппы("chatGroupId") + если("{chatGroupId} == 1234-abcd-5678").то( ... ) +

перевестиНаГруппу(*args).иЗавершить

Шаг перевода диалога на другую группу. Шаг совмещает смену группы и завершение текущего сценария в одном. В качестве аргумента шаг принимает идентификатор группы, в которую надо перевести диалог. Идентификатор каждой группы можно выяснить в разделе Настройки - Группы. Если в сервисе не будет обнаружено группы с таким идентификатором, то перевод на группу будет проигнорирован.

После смены группы диалог продолжит работу с текущего места:

если смена группы произошла в сценарии поступления диалога в систему, то после завершения сценария диалог запустит приветствие данной группы, а после переведет запрос в базы знаний;
если смена группы произошла в сценарии приветствия, то после зщавершения сценария диалог передаст запрос в базы знаний;
если смена группы произошла в сценарии документа из базы знаний, то следующий запрос пользователя будет передан уже в базы знаний указанной группы, а если пользователь ничего не запросит то диалог будет автоматически закрыт в указанной группе.

Code Block

breakoutMode	wide

задатьПользователюВопрос("Привет! Подскажи кому передать твой запрос?").сВариантамиОтвета("HR", "IT").сохранитьРезультат("UserSaid")+
если("{UserSaid} == HR").то(
	сообщениеПользователю.сШаблоном("Ок, перевожу запрос в HR отдел") +
	перевестиНаГруппу("1b514696-b033-41f4-88cd-91a5649b4f13").иЗавершить
) +
...

перевестиНаГруппу(args).иЗавершитьСНовымЗапросом(args)

Шаг перевода диалога на другую группу и передачи запроса в базы знаний этой группы вне зависимости от того где был использован данный шаг.

В качестве аргумента для перевестиНаГруппу указывается идентификатор группы, в которую необходимо перевести диалог. Идентификатор каждой группы можно выяснить в разделе Настройки - Группы. Если в сервисе не будет обнаружено группы с таким идентификатором, то перевод на группу будет проигнорирован.

В качестве аргумента для иЗавершитьСНовымЗапросом указывается текст запроса, который необходимо передать в базы знаний, или переменная, которая содержит этот текст.

Code Block

breakoutMode	wide

задатьПользователюВопрос("Привет! Подскажи что тебя интересует?").сохранитьРезультат("UserSaid")+
перевестиНаГруппу("1b514696-b033-41f4-88cd-91a5649b4f13").иЗавершитьСНовымЗапросом("{UserSaid}")

перевестиНаГруппу(*args).иЗавершитьИПеревестиНаОператора

Шаги завершения сценария

завершить

Операция завершения сценария.

Code Block

breakoutMode	wide

завершить

Code Block

breakoutMode	wide

вызвать.внешнийСервис("{url}", "POST").сПараметрами(("accessKey", "{accessKey}")).сТеломСообщения("{"email":"{myEmail}"}").сохранитьРезультатКакСтроку("res")+
если("{http_code} > 210").то(
  завершить
)+

завершитьСНовымЗапросом("вопрос")

Операция завершения текущего сценария и вызова другого документа по запросу в бота. После завершения этого сценария, но в рамках текущей сессии боту будет передан приведенный запрос. Запрос будет обработан по стандартной процедуре, так как если бы этот запрос написал пользователь. Если результатом поиска по данному запросу будет документ с ответом в виде сценария, то по завершении текущего сценария будет сразу запущен следующий сценарий.

Code Block

breakoutMode	wide

задатьПользователюВопрос("Что еще вы хотели узнать ?").сохранитьРезультат("what")+
завершитьСНовымЗапросом("{what}")

завершитьИПеревестиНаОператора

Операция завершения текущего сценария и перевода диалога в очередь оператору. Запрос будет обработан по стандартной процедуре, так как если бы этот запрос написал пользователь и он сразу попал в очередь оператору.

Code Block
сообщениеПользователю.сШаблоном("Переключаю диалог на оператора")+ завершитьИПеревестиНаОператора

завершитьИЗакрытьДиалог()

Операция завершения текущего сценария и закрытия всего диалога. Следующая реплика пользователя создаст новый диалог.

Code Block

// проверка валидности пароля
если("{checkPassword} == 0").то(
  комментарий("Пользователь ввел неверный пароль")+
  сообщениеПользователю.сШаблоном("Вам сюда нельзя. Пока.")+
  завершитьИЗакрытьДиалог()
)+
сообщениеПользователю.сШаблоном("Все хорошо, продолжаем")+
завершить

Примеры сценариев

Сценарий с вызовом внешнего сервиса, разбором ответа в JS.

Code Block

установитьПеременную("host_cities", "https://api.autofaq.ai/v1/query") +
установитьПеременную("service_id", "121000") +
установитьПеременную("service_token", "939b8") +
установитьПеременную("other_score", "0.5") +
задатьПользователюВопрос("Уточните ваш город, пожалуйста?").сохранитьРезультат("city")+
вызвать.внешнийСервис("{host_cities}", "POST").сЗаголовками(("Content-Type", "application/json"),("charset", "utf-8")).сТеломСообщения("{\"service_token\": \"{service_token}\",\"service_id\":{service_id},\"query\":\"{city}\"}").сохранитьРезультатКакСтроку("results")+
выполнитьJs("""
var result = JSON.parse(results); var score = 0.0; var answer = '';
if (result.results.length > 0) {
	answer = result.results[0]['answer']; score = result.results[0]['score'];
    answer = answer.replace(/\n/g,'<br>');
} 
var exit = {'answer':answer, 'score':score}; exit;
""") +
если("{http_code} > 210").то(завершитьСШаблоном("Что-то сломалось. Зайдите попозже."))+
если("{score} < {other_score}").то(завершитьСШаблоном("Вот в этом городе у нас ничего нет"))+
сообщениеПользователю.сШаблоном("В указанном городе можно приобрести по адресам: <br>{answer}")+
задатьПользователюВопрос("Все ок?").сВариантамиОтвета("Да", "А мне не выдают").сохранитьРезультат("what")+
если("{what} == Да").или("{what} == да").то(завершитьСШаблоном("ну и отлично. Всего хорошего!"))+
завершитьСНовымЗапросом("Перевести на оператора")

Сценарий для интеграции на событие "Нажатие кнопки оператором"

Code Block

комментарий("Запуск интеграции по кнопке.")+
установитьПеременнуюВДиалог("Поле 2", значение = "Field 2", название = "Поле 2", показыватьОператору = true, обязательное = true, редактируемое = false)+
установитьПеременную("priority", "{\"v1\": \"Blocker\", \"v2\": \"Critical\", \"v3\": \"Major\", \"v4\": \"Minor\"}") +
добавитьПолеВФормуОператора(
  форма = "Заведение заявки в Jira",
  переменная = "t1",
  название = "Что вам нужно сделать: ",
  тип = "Нередактируемый текст",
  значение = "Заполните форму"
) +
добавитьПолеВФормуОператора(
  форма = "Заведение заявки в Jira",
  переменная = "t2",
  название = "Название заявки",
  тип = "Однострочный редактируемый текст",
  описание = "Введите название заводимой заявки",
  значение = "Введите",
  обязательное = true
) +
добавитьПолеВФормуОператора(
  форма = "Заведение заявки в Jira",
  переменная = "t3",
  название = "Критичность",
  тип = "Выпадающий список",
  описание = "Выберите из списка критичность заявки",
  обязательное = true,
  значение = "v3", 
  варианты = "{priority}"
) +
добавитьПолеВФормуОператора(
  форма = "Заведение заявки в Jira",
  переменная = "t4",
  название = "Описание",
  тип = "Многострочный редактируемый текст",
  описание = "Опишите вашу проблему",
  обязательное = true
) +
добавитьПолеВФормуОператора(
  форма = "Заведение заявки в Jira",
  переменная = "t5",
  название = "Уведомить руководителя?",
  тип = "Переключатель",
  обязательное = false
) +
установитьПеременную("tags", "{\"v1\": \"Teacher\", \"v2\": \"Student\", \"v3\": \"Sales\", \"v4\": \"Tech\"}") +
добавитьПолеВФормуОператора(
  форма = "Заведение заявки в Jira",
  переменная = "t6",
  название = "Теги",
  тип = "Множественный выбор",
  описание = "Выберите теги, которыми пометить обращение",
  варианты = "{tags}",
  обязательное = true
) +
добавитьПолеВФормуОператора(
  форма = "Заведение заявки в Jira",
  переменная = "t7",
  тип = "Целое число",
  название = "Частота возникновения проблемы",
  описание = "% пользователей, у которых возникает проблема" 
) +
показатьФормуОператору(имя = "Заведение заявки в Jira") +
комментарий("Вот что у нас получилось: {t2}, {t3}, {t4}")+
комментарий("Конец сценария интеграции!")

Page Comparison

Versions Compared

Old Version 52

New Version 53

Key

Общее описание

Системные переменные

Пользовательские переменные

Списки

Порядок выполнения шагов сценария

Шаги переписки с пользователями

сообщениеПользователю.сШаблоном(

*args)

сообщениеПользователю.сФайлами(111).сШаблоном(

*args)

задатьПользователюВопрос

(*args).сохранитьРезультат(*args)

вызвать

.сВариантамиОтвета(варианты)

.проверитьФормат(формат, сообщение)

запроситьФайл(*args).сохранитьРезультат(переменная)

Шаги работы с внешними сервисами

вызвать.внешнийСервис(адрес, тип).сохранитьРезультат(*args)

.сПараметрами()

.сЗаголовками()

.сТеломСообщения()

.сСоставнымТеломСообщения()

.сохранитьРезультатКакСтроку()

установитьПеременную(переменная, значение)

установитьПеременнуюВДиалог(*аргументы)

установитьПеременнуюПользователю(переменная, значение)

если(условие)

запроситьФайл("сообщение")

установитьМетку()

перейтиНаМетку()

запросВБазыЗнаний(вопрос, переменная)

назначитьТематику(ID базы знаний)

назначитьОператора(логин оператора)

комментарий("сообщение")

выполнитьJs(скрипт)

добавитьПолеВФормуОператора(*args)

показатьФормуОператору(имя = "форма")

Шаги работы с группами

определитьИдентификаторГруппы(*args)

перевестиНаГруппу(*args).иЗавершить

перевестиНаГруппу(*args).иЗавершитьСНовымЗапросом(*args)

перевестиНаГруппу(*args).иЗавершитьИПеревестиНаОператора

Шаги завершения сценария

завершить

завершитьСНовымЗапросом("вопрос")

завершитьИПеревестиНаОператора

завершитьИЗакрытьДиалог()

Примеры сценариев

**(args).сохранитьРезультат(args)**

**запроситьФайл(*args).сохранитьРезультат(переменная)**

**вызвать.внешнийСервис(адрес, тип).сохранитьРезультат(*args)**

**установитьПеременнуюВДиалог(*аргументы)**

перевестиНаГруппу(args).иЗавершитьСНовымЗапросом(args)