Как создать свои теги действий

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

подсказка

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

В этой статье будет пошагово рассмотрен процесс разработки простого тега, который:

1. Принимает в качестве параметров два числа и формат ответа.
2. Отправляет ответ с суммой этих чисел в указанном формате.

Чтобы разработать тег:

1. Напишите сценарий для вашего тега.
2. Задайте настройки тега в отдельном JSON-файле.
3. Укажите путь к JSON-файлу в chatbot.yaml.
4. Используйте тег в сценарии.

Шаг 1. Напишите сценарий тега

1. Авторизуйтесь в JAICP и выберите нужный проект.
2. На панели управления слева перейдите в Редактор → Код.
3. Создайте в директории src поддиректорию для тегов действий, например blocks.
4. Создайте в директории blocks поддиректорию SumTwoNumbers, а в ней файл сценария block.sc.
5. Напишите сценарий для вашего тега и сохраните его.

theme: /Blocks

    state: SumTwoNumbers
        script:
            # 1
            $temp.numberOne = $request.data.args.numberOne;
            $temp.numberTwo = $request.data.args.numberTwo;
            $temp.answerFormat = $request.data.args.answerFormat;
            # 2
            $temp.result = parseFloat($temp.numberOne) + parseFloat($temp.numberTwo);
        # 3
        if: !isNaN($temp.result)
            # 4
            if: $temp.answerFormat === "number"
                a: {{$temp.result}}
            elseif: $temp.answerFormat === "full"
                a: {{$temp.numberOne}} + {{$temp.numberTwo}} = {{$temp.result}}
            # 5
            if: $request.data.args.okState
                go!: {{$request.data.args.okState}}
        # 6
        elseif: $request.data.args.errorState
            go!: {{$request.data.args.errorState}}
        else:
            a: Я не знаю, как посчитать {{$temp.numberOne}} + {{$temp.numberTwo}}.

Разберем код сценария:

1. Значения параметров тега можно извлечь в стейте, с которого начинается сценарий тега, через объект $request.data.args. Значения numberOne, numberTwo и answerFormat копируются из него в $temp, чтобы к ним было удобнее обращаться.

2. Все значения параметров имеют строковый тип. Поэтому перед математическими операциями нужно привести numberOne и numberTwo к числам — для этого используется встроенная функция parseFloat. Затем числа складываются, а их сумма сохраняется в $temp.result.

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

4. Если answerFormat имеет значение "number", то бот в ответе указывает только сумму, например: «7». Если answerFormat имеет значение "full", то бот в ответе указывает полное выражение, например: «3 + 4 = 7».

5. Лучше всего проектировать теги так, чтобы в них можно было указать, в какой стейт основного сценария бот должен вернуться после действия. Тег SumTwoNumbers поддерживает два дополнительных параметра: okState и errorState. Если бот успешно посчитал сумму и в тег передан параметр okState, сценарий переходит в этот стейт.

6. Если посчитать сумму не удалось и в тег передан errorState, сценарий переходит в этот стейт. Если не передан ни okState, ни errorState, бот сообщает об ошибке.

Шаг 2. Задайте настройки тега

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

1. Создайте в той же директории SumTwoNumbers файл block.json.
2. В файл запишите JSON-объект с полями ниже. Все поля обязательны, если не указано иное.

Настройки тега

Поле	Тип	Описание
tagName	Строка	Название тега действия.
startState	Строка	Стейт, с которого начнет выполняться сценарий тега.
scenarioFile	Строка	Путь к файлу сценария относительно директории src.

Настройки параметров

Поле	Тип	Описание
parameters	Массив объектов	Параметры, которые можно передавать в тег.
parameters[].name	Строка	Имя параметра.
parameters[].type	Строка	Тип параметра.
parameters[].required	Логический	Является ли параметр обязательным.

Типы параметров

Тип	Описание	Пример значения
string	Строка	Привет, мир!
html	Строка с HTML-разметкой	Привет, <b>мир</b>!
integer	Число	3.14
bool	Логический тип	false
stringArray	Массив строк	["Привет", "мир"]
nameValueList	Массив объектов с полями name и value	[{"name": "hello", "value": "world"}]
json	Объект	{"hello": "world"}
state	Путь к стейту	/Start

предупреждение

Независимо от того, какой тип объявлен для параметров, все значения попадают в $request.data.args как строки. Чтобы корректно работать с ними в сценарии тега действия, преобразуйте их тип:

• Параметры с типом bool приводятся к логическому значению через конструктор Boolean.
• Параметры с типом integer приводятся к числу через parseInt или parseFloat.
• Параметры с типами stringArray, nameValueList, json приводятся к объекту через JSON.parse.

Список допустимых значений параметра

В поле parameters[].userInterfaceField вы можете указать список допустимых значений для параметра. В этом случае:

• Если в сценарии указать значение не из списка, то возникнет ошибка публикации бота. В качестве значения для такого параметра нельзя указать переменную.
• В графическом редакторе J‑Graph для параметра можно будет выбрать значения только из этого списка.

Поле	Тип	Описание
parameters[].userInterfaceField	Объект	Настройки допустимых значений для параметра. Необязательное поле.
parameters[].userInterfaceField.type	Строка	Всегда указывайте значение "select".
parameters[].userInterfaceField.options[]	Массив объектов	Допустимые значения параметра.
parameters[].userInterfaceField.options[].value	Строка	Значение параметра. Всегда передавайте значение как строку.

Как преобразовать значение в строку

1. Заключите значение в двойные кавычки (").
2. Если значение содержит двойные кавычки, экранируйте их с помощью символа \.

Примеры:

Исходное значение	Строка
10	"10"
["example1", "example2"]	"[\"example1\", \"example2\"]"

Настройки отображения в J‑Graph

В графическом редакторе J‑Graph тегам действий соответствуют блоки действий. Поля ниже позволяют настроить их отображение в J‑Graph. Все эти поля необязательны.

В качестве значения все поля принимают объект с ключами ru и eng. Значение ru используется при отображении интерфейса JAICP на русском языке, eng — на английском.

Поле	Описание
caption	Название действия. Если не указать значение, то в качестве названия будет использоваться имя тега действия (поле tagName).
description	Описание действия. Отображается как информационный блок в меню редактирования действия.
hint	Подсказка к действию. Отображается как всплывающая подсказка при наведении на действие в списке реакций.
parameters[].localization	Название параметра. Если не указать значение, то в качестве названия будет использоваться имя параметра в коде (поле name).
parameters[].description	Описание параметра. Отображается как всплывающая подсказка при наведении на название параметра.
parameters[].userInterfaceField.options[].localization	Название значения параметра в списке допустимых значений. Если не указать название, то будет использоваться значение параметра (value).

Пример настроек

Пример JSON-файла для сценария по сложению двух чисел, разработанного на шаге 1:

{
    "tagName": "SumTwoNumbers",
    "startState": "/Blocks/SumTwoNumbers",
    "scenarioFile": "blocks/SumTwoNumbers/block.sc",
    "caption": {
        "ru": "Сложить два числа",
        "eng": "Sum two numbers"
    },
    "description": {
        "ru": "Используйте этот блок, чтобы сложить два числа и отправить ответ со значением суммы.",
        "eng": "Use this block to calculate the sum of two numbers and send a reply with the result."
    },
    "hint": {
        "ru": "Сложить два числа и отправить ответ со значением суммы",
        "eng": "Calculate the sum of two numbers and send a reply with the result"
    },
    "parameters": [
        {
            "name": "numberOne",
            "type": "integer",
            "required": true,
            "localization": {
                "ru": "Первое число",
                "eng": "First number"
            }
        },
        {
            "name": "numberTwo",
            "type": "integer",
            "required": true,
            "localization": {
                "ru": "Второе число",
                "eng": "Second number"
            }
        },
        {
            "name": "answerFormat",
            "type": "string",
            "required": true,
            "localization": {
                "ru": "Формат ответа",
                "eng": "Answer format"
            },
            "userInterfaceField": {
                "type": "select",
                "options": [
                    {
                        "value": "number",
                        "localization": {
                            "eng": "Number only",
                            "ru": "Только число"
                        }
                    },
                    {
                        "value": "full",
                        "localization": {
                            "eng": "Full expression",
                            "ru": "Полное выражение"
                        }
                    }
                ]
            }
        },
        {
            "name": "okState",
            "type": "state",
            "required": false,
            "localization": {
                "ru": "Следующий шаг в случае успеха",
                "eng": "Next state on success"
            },
            "description": {
                "ru": "Бот перейдет в этот шаг, если сумма будет успешно вычислена.",
                "eng": "The bot will go to this state if it successfully calculates the sum."
            }
        },
        {
            "name": "errorState",
            "type": "state",
            "required": false,
            "localization": {
                "ru": "Следующий шаг в случае ошибки",
                "eng": "Next state on error"
            },
            "description": {
                "ru": "Бот перейдет в этот шаг, если не сможет вычислить сумму.",
                "eng": "The bot will go to this state if it fails to calculate the sum."
            }
        }
    ]
}

Шаг 3. Укажите путь к JSON-файлу в chatbot.yaml

1. В конфигурационном файле chatbot.yaml создайте секцию customTags, если ее еще нет.
2. Укажите в ней путь к JSON-файлу относительно корневой директории проекта.

customTags:
  - src/blocks/SumTwoNumbers/block.json

предупреждение

Если вы хотите использовать тег как действие в J‑Graph, обязательно сохраните изменения, сделанные в редакторе кода. Для этого нажмите .

Шаг 4. Используйте тег в сценарии

Через редактор кода

1. Перейдите в нужный файл сценария бота, например main.sc.

2. Создайте новый стейт для вашего тега действия и укажите его параметры, например:

   state: SumTwoNumbers
       q!: * [чему равно] @duckling.number::numberOne (плюс/$regex<\+>) @duckling.number::numberTwo *
       SumTwoNumbers:
           numberOne = {{$parseTree._numberOne}}
           numberTwo = {{$parseTree._numberTwo}}
           answerFormat = number
           okState = /AnythingElse
   
   state: AnythingElse
       a: Посчитать для вас что-нибудь еще?
   • Стейт срабатывает на запросы наподобие два плюс три. Через сущность @duckling.number из запроса извлекаются два числа, которые передаются в тег.
   • SumTwoNumbers — название тега действия. Оно соответствует значению параметра tagName в JSON-файле с настройками.
   • numberOne, numberTwo, answerFormat и okState — параметры тега действия, которые были определены в JSON-файле. Значения этих параметров можно менять при каждом использовании тега.

Через графический редактор J‑Graph

1. На панели управления слева перейдите в Редактор → J‑Graph.
2. Создайте на холсте новый шаг.
3. В меню редактирования шага выберите Все реакции.
4. В списке реакций выберите новое действие Сложить два числа.
5. Заполните параметры действия и сохраните блок.