...

На этой странице:

...

<a href="https://confluence.twin24.ai/pages/viewpage.action?pageId=137790002" target="_blank">Создание тестового виджета</a>.

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

Структура операций

Все операции бота в пределах одного блока операций представляют собой одно или несколько выражений на языке программирования ботов. Выражения отделяются друг от друга необязательным символом ";" либо символом перевода строки (началом новой строки). Каждое выражение имеет значение. Это значит, что выражения могут быть составными.

Комментарии

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

• Однострочные. Такие комментарии начинаются с символов // и заканчиваются окончанием строки.
• Многострочные. Начало многострочного комментария начинается с символов /* и заканчивается символами */.

// Это однострочный 

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

Структура операций

Все операции бота в пределах одного блока операций представляют собой одно или несколько выражений на языке прграммирования ботов. Выражения отделяются друг от друга необязательным символом ";", либо символом перевода строки (началом новой строки). Каждое выражение имеет значение. Это значит что выражения могут быть составными

Комментарии

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

• Однострочные. Такие комментарии начинаются с двух слэшей // и заканчиваются окончанием строки.
• Многострочные. Начало многострочного комментарии начинается с /* и заканчивается */

Пример комментариев:

// Это однострочный комментарий
$x = time()

/**
 * А это уже
 * многострочный
 * комментарий
 */
say("Time is " + $x)

Переменные

Для хранения данных в сценариях ботов применяются переменные. Переменная представляет собой именованный участок памяти бота. Она создаётся при первом её своем использовании в каком-либо блоке операцийоперация. При этом значением по умолчанию для всех переменных является nil.

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

Существуют Существует три вида переменных, различающихся своей областью видимости:

• Переменные, видимые в пределах одного модуля в одном потоке.
  Доступны для чтения и записи. Названия таких переменных наяинаются начинаются с символа $. Такие переменные удобно использовать для хранения значений промежуточных операций и вычислений.
• Переменные, видимые в пределах одного модуля в разных потоках.
  Доступны для чтения и записи. Названия переменных уровня модуля начинаются с символа #. Поскольку такие переменные видны во всех потоках бота их удобно использовать для взаимодействия между потоками. 
• Глобальные переменные или переменные окружения.
  Автоматически задаваемые переменные, которые видны во всех потоках всех модулей бота. Эти переменные доступны только для чтения и хранят информацию о глобальном контексте работы бота. Их имена начинаются  начинаются с символа @.

...

// Переменные $p и $r доступны только в потоке, в котором они определены
$p = 2 * 3.14 * $r

// Эта переменная доступна во всех потоках в пределах текущего модуля
// (модуля, в котором находится блок операций, в котором определена переменная).
#count = queue.size()

// @communicationType глобальная переменная только для чтения. Доступна отовсюдувезде.
$isChat = @communicationType == "TEXT"

Переменные переменных

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

В примере ниже мы определяем три переменные содержащие названия цветов. Затем мы определяем случайно число от 1 до 3 и далее формируем название одной из переменных с тем чтобы узнать значение случайного цвета.

// Создадим три переменные с именами x1, x2 и x3
$x1 = "red"
$x2 = "blue"
$x3 = "green"

// Случайное число от 1 до 3
$n = math.rand(1, 3)

// Получаем цвет динамически сформировав имя переменной с цветом и взяв её значение 
$color = $("x" + $n)

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

// $x содержит название переменной #y
$x = "y"

// #y содержит название глобальной переменной communicationType
#y = "communicationType"

// Вычисляется так @#$x -> @#("y") -> @#y -> @("communicationType") -> @communicationType
$communicationType = @#$x

Типы данных

Существует три примитивных типа данных один объектный тип и специальное значение nil:

Числа

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

Строки

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

...

В одинарных кавычках все символы тарктуются как есть за исключением последовательности \' которая означет символ одинарной кавычки.

// Следуюущая команда выведет в чат фразу из двух строк
// Привет
// "Медвед!"
say("Привет\n\"Медвед!\"")

// Выведет в чат фразу Привет\n'Медвед!'
say('Привет\n\'Медвед!\'')

Булевые (логические) значения

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

$x = true  // $x содержит ИСТИНА
$y = !$x   // $y содержит ЛОЖЬ

Объекты

В стандартной библиотеке языка программирования бота существует ряд функций (операций) значением которых являются так называемые объекты. Объект это особое значение у которого могут быть встроенные свойства и операции или методы. Набор этих свойств и методов определяется типом объекта. Для доступа к свойствам или методам объектов используется оператор точка "."

Например, следущий код получает первое сообщение клиента которое является объектом ClientMessage и далее берёт свойство message (текст сообщения) этого объекта:

// $first содержит значение объекта ClientMessage 
$first = queue.first()

// Получаем значение совойства message
$firstMessage = $first.message

Свойства и методы объектов, также как и значения переменных, могут быть вычисляемыми:

$n = rand(0, 1)                     // $n содержит или 0 или 1
$method = ["first", "last"].get($n) // $method содержит строку first или last (см. получение элемента списка по индексу)
$firstOrLast = queue.$method        // Получаем первое или последнее сообщение клиента

// Или даже так
$firstOrLast = queue.(["first", "last"].get($n))

Существует три типа встроенных объектов являющихся коллекциями произвольных элементов

Кортежи

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

$items = (1, 2, 2) // Кортеж из трёх элементов
$items = ('a',)    // Кортеж из одного эелемента. Запятая необходима чтобы отличать создание кортежа от просто круглых скобок.
$items = ()        // Кортеж не содержащий ни одного элемента (пустой кортеж)

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

...

2
nil

...

Списки

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

$items = [1, 2, 2] // Список из трёх элементов
$items = ['a']     // Список из одного эелемента
$items = []        // Список не содержащий ни одного элемента (пустой список)

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

...

2
nil

...

(1, 2, 3)

...

$x содержит пустой список []

...

Специальное значение nil

Когда какая-либо переменная не определена, но уже используется в выражении её значением становится nil. Это специльное значение означающее отсутствие какого-либо значения. Это значение также можно присвоить явно:

$x = 1 + 2 // $x содержит 3
$x = nil   // $x содержит nil

Операции

В языке выражений бота определенно несколько классов операций. Класс операции определяется её первым аргументом. Например, если первый аргумент операции "+" строка, то будет произведена конкатенация строк. Если же это число, то будет осуществляться сложение чисел.

Приоритеты операций

Чем приоритет выше, тем раньше выполнится операция. Стандартным способом увеличения приоритета являются круглые скобки.

...

Сложение, конкатенация, объединение

...

Арифметические операции

Арифметические операции предназначены для работы с числами. Если значение участвующее в арифметической операции не является числом, произойдёт попытка его преобразования в число (см. ниже).

...

+$a

...

-$a

...

$a + $b

...

$a - $b

...

$a * $b

...

$a / $b

...

$a \ $b

...

$a % $b

...

$a ** $b

...

Побитовые операции

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

...

Устанавливаются те биты, которые не установлены в $a, и наоборот

...

Устанавливаются только те биты, которые установлены либо только в $a, либо только в $b, но не в обоих одновременно

Таблица преобразования других типов данных в число:

...

Логические операции

Логические операции предназначены для работы с булевыми значениями. Если значение не является булевым, то произойдёт попытка его преобразования в булевое значение (см. ниже).

...

!$a

...

$a && $b

...

$a || $b

...

Имена переменных могут содержать только цифры, английские и русские буквы, а также символ подчёркивания. Т.е. вы не можете назвать переменную каким-то словом, содержащим пробел или символ отличный от символов русского и английского языков. Тем не менее, существует способ использовать любое название. Для этого необходимо заключить название переменной в круглые скобки.

$('日本') = 123         // Создали переменную c именем 日本
$x = $('日本')          // $x теперь равна 123
$(math.rand(1, 2)) = 0 // Динамически создаём переменную с именем 1 или 2 и присваиваем ей значение 0

Переменные переменных

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

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

// Создадим три переменные с именами x1, x2 и x3
$x1 = "red"
$x2 = "blue"
$x3 = "green"

// Случайное число от 1 до 3
$n = math.rand(1, 3)

// Получаем цвет динамически сформировав имя переменной с цветом и взяв её значение 
$color = $("x" :: $n)

Можно также использовать значения переменных разных типов.

// $x содержит название переменной #y
$x = "y"

// #y содержит название глобальной переменной communicationType
#y = "communicationType"

// Вычисляется так @#$x -> @#("y") -> @#y -> @("communicationType") -> @communicationType
$communicationType = @#$x

Типы данных

Существует три примитивных типа данных, один объектный тип и специальное значение nil.

Числа

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

Строки

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

В одинарных кавычках все символы трактуются как есть за исключением последовательности символов \', которая означает символ одинарной кавычки.

// Следующая команда выведет в чат фразу из двух строк
// Привет
// "Медвед!"
say("Привет\n\"Медвед!\"")

// Выведет в чат фразу Привет\n'Медвед!'
say('Привет\n\'Медвед!\'')

Булевы (логические) значения

Константы true и false трактуются как булевы, т.е. такие значения, у которых есть только два состояния – истина и ложь. Булевы значения удобно применять в выражениях условного блока.

$x = true  // $x содержит ИСТИНА
$y = !$x   // $y содержит ЛОЖЬ

Объекты

В стандартной библиотеке языка программирования бота существует ряд функций (операций), значением которых являются так называемые объекты. Объект – это особое значение, у которого могут быть встроенные свойства и операции или методы. Набор этих свойств и методов определяется типом объекта. Для доступа к свойствам или методам объектов используется оператор точка ".".

Например, с помощью следующего кода можно получить первое сообщение клиента, которое является объектом ClientMessage и далее получить свойство message (текст сообщения) этого объекта.

// $first содержит значение объекта ClientMessage 
$first = queue.first()

// Получаем значение свойства message
$firstMessage = $first.message

Свойства и методы объектов (также как и значения переменных) могут быть вычисляемыми.

$n = rand(0, 1)                     // $n содержит или 0 или 1
$method = ["first", "last"].get($n) // $method содержит строку first или last (см. получение элемента списка по индексу)
$firstOrLast = queue.$method        // Получаем первое или последнее сообщение клиента

// Или даже так
$firstOrLast = queue.(["first", "last"].get($n))

Существует три типа встроенных объектов являющихся коллекциями произвольных элементов.

Кортежи

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

$items = (1, 2, 2) // Кортеж из трёх элементов.
$items = ('a',)    // Кортеж из одного элемента. Запятая необходима, чтобы отличать создание кортежа от просто круглых скобок.
$items = ()        // Кортеж не содержащий ни одного элемента (пустой кортеж).

Для работы с кортежами доступны следующие методы.

count()

(1, 2, 3).count()

first()

(1, 2, 3).first()

last()

(1, 2, 3).last()

has(index)

(1, 2, 3).has(0)
(1, 2, 3).has(3)

get(index)

(1, 2, 3).get(1)
(1, 2, 3).get(3)

(1, 2, 3).contains(3)
(1, 2, 3).contains(0)

(1, 2, 3).index(3)
(1, 2, 3).index(0)

equals(other)

('a', 'b').equals(('a', 'b'))
('a', 'b').equals(('b', 'a'))

hash()

('a', true).hash()

Списки

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

$items = [1, 2, 2] // Список из трёх элементов
$items = ['a']     // Список из одного элемента
$items = []        // Список не содержащий ни одного элемента (пустой список)

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

count()

[1, 2, 3].count()

first()

[1, 2, 3].first()

last()

[1, 2, 3].last()

has(index)

[1, 2, 3].has(0)
[1, 2, 3].has(3)

get(index)

[1, 2, 3].get(1)
[1, 2, 3].get(3)

[1, 2, 3].contains(1)
[1, 2, 3].contains(0)

[1, 2, 3].index(1)
[1, 2, 3].index(0)

toTuple()

[1, 2, 3].toTuple()

clear()

$x = [1, 2, 3]
$x.clear()

reverse()

[1, 2, 3].reverse()

append(item)

[1, 2, 3].append(4)

prepend(item)

[1, 2, 3].prepend(0)

shift()

$x = [1, 2, 3]
$y = $x.shift()

pop()

$x = [1, 2, 3]
$y = $x.pop()

set(index, item)

$x = [1, 2, 3]
$y = $x.set(1, 0)
$z = $x.set(5, 'a')

remove(index)

$x = [1, 2, 3]
$y = $x.remove(1)

equals(other)

['a', 'b'].equals(['a', 'b'])
['a', 'b'].equals(['b', 'a'])

hash()

['a', true].hash()

Ассоциативные массивы (словари)

Ассоциативный массив или словарь (map) – это изменяемая, упорядоченная коллекция произвольных пар ключ/значение. Создаётся словарь с помощью фигурных скобок.

$items = {'a': 1, 'b': 2, 'c': 3} // Словарь из трёх элементов
$items = {'a': true}                // Cловарь из одного элемента
$items = {}                       // Словарь, не содержащий ни одного значения (пустой словарь)

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

count()

{1: 'a', 2: 'b', 3: 'c'}.count()

clear()

$x = {true: false, 'b': true}
$x.clear()

reverse()

{'a': 1, 'b': 2, 'c': 3}.reverse()

values()

{'a': 1, 'b': 2, 'c': 3}.values()

keys()

{'a': 1, 'b': 2, 'c': 3}.keys()

firstKey()

{'a': 1, 'b': 2, 'c': 3}.firstKey()

lastKey()

{'a': 1, 'b': 2, 'c': 3}.lastKey()

first()

{'a': 1, 'b': 2, 'c': 3}.first()

last()

{'a': 1, 'b': 2, 'c': 3}.last()

contains(item)

{'a': 1, 'b': 2, 'c': 3}.contains(2)
{'a': 1, 'b': 2, 'c': 3}.contains(4)

has(key)

{'a': 1, 'b': 2, 'c': 3}.has('a')
{'a': 1, 'b': 2, 'c': 3}.has('d')

get(key)

{'a': 1, 'b': 2, 'c': 3}.get('b')
{'a': 1, 'b': 2, 'c': 3}.get('d')

$x = {1: true, 2: nil}
$x.set(2, false)

equals(other)

{'a': 'b'}.equals(['a': 'b'])
{'a': 'b'}.equals(['b': 'a'])

hash()

{'a': true}.hash()

Специальное значение nil

Когда какая-либо переменная не определена, но уже используется в выражении, её значением становится nil. Это специальное значение, означающее отсутствие какого-либо значения. Это значение также можно присвоить явно.

$x = 1 + 2 // $x содержит 3
$x = nil   // $x содержит nil

Операции

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

Приоритеты операций

Чем приоритет выше, тем раньше выполнится операция. Стандартным способом увеличения приоритета являются круглые скобки.

Арифметические операции

Арифметические операции предназначены для работы с числами. Если значение, участвующее в арифметической операции, не является числом, то произойдёт попытка его преобразования в число (см. ниже).

+$a

-$a

$a + $b

$a - $b

$a * $b

$a / $b

$a \ $b

$a % $b

$a ** $b

Побитовые операции

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

~$a

$a & $b

$a | $b

$a ^ $b

Таблица преобразования других типов данных в число.

Логические операции

Логические операции предназначены для работы с булевыми значениями. Если значение не является булевым, то произойдёт попытка его преобразования в булево значение (см. ниже).

!$a

$a && $b

$a || $b

Таблица преобразования других типов данных в булево значение.

Операции со строками

Есть только одна операция для работы со строками. Это сложение или конкатенация строк.

"a" :: "b"

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

Операции сравнения

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

$a == $b

$a != $b

$a > $b

$a >= $b

$a < $b

$a <= $b

Операции с коллекциями

Для встроенных типов объектов tuple, list и map доступна одна операция объединения.

(1, 2) + (3, 4)

['a', 'b'] + ['c']

{'a': 0, 'b': 2} + {'a': 1, 'c': 3}

Операции присваивания

Операции присваивания позволяют назначать переменным какое-либо значение.

$a = 123

$a += 1

$a -= 1

$a *= 2

$a /= 2

$a \= 2

$a %= 5

$a **= 3

$a &= 1

$a |= 3

$a ^= 4

Кроме присваивания значения одной переменной есть возможность присвоить значение сразу нескольким переменным.

($x, $y, $z) = (1, 2, 3)

$x = 1
$y = 2
$z = 3

(1, 2, 3)

[$x, $y] = ($y, $x)

$x = $y
$y = $x

[$y, $x]

{'a': $x, 'b': $y} = {'b': true, 'a': false}

$x = false
$y = true

{'a': false, 'b': true}

($x, $y, $z) += [1, 2, 3]

$x = $x + 1
$y = $y + 2
$z = $z + 3

($x + 1, $y + 1, $z + 1)

{3: $x, 7: $y} *= (2, 3)

$x = $x * 2
$y = $y * 3

{3: $x * 2, 7: $y * 3}

Функции

Основными строительными элементами выражений в блоке операций являются вызовы функций. Функция – это некоторая часть функциональности бота. Например, с помощью функций можно оперировать датой и временем, вычислять более сложные арифметические операции, преобразовывать строку текста в намерения, используя сервис NLU, работать с очередью сообщений клиента и т.д.

Чтобы вызвать функцию, нужно указать её имя, затем в круглых скобках перечислить через запятую её параметры. Имена большинства функций состоят из двух частей, разделяемых точкой: названия модуля и названия функции. 

$number = math.rand(5, 10) // Получаем случайное число от 5 до 10. math – название модуля, rand – название функции

Также как и в случае методов объектов имена функций могут динамически вычисляться в процессе выполнения сценария бота.

$funcIdx = math.rand(0, 1)                          // Получаем случайное число 0 или 1, которое будет индексом названия функции в кортеже.
$number = math.(('min', 'max').get($funcIdx))(3, 7) // Получаем название функции min или max и далее вызываем её. Таким образом, мы вычисляем случайным образом либо минимальное, либо максимальное значение.

Таблица преобразования других типов данных в булевое значение:

...

Операции со строками

Есть только одна операция для работы со строками. Это сложение или конкатенация строк:

...

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

...

Операции сравнения

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

...

true если $a тождественно равно $b

...

Операции с коллекциями

Для встроенных типов объектов tuple, list и map доступна одна операция объединения:

...