chatbot.yaml — главный конфигурационный файл чатбота. Содержит имя главного файла сценария, информацию о подключаемых модулях, конфигурацию NLU-модуля, список тестов и другую конфигурационную информацию.
name: botNameНа основе этого параметра формируется имя zip-файла при выполнении команды build или buildDeploy и формируется botId при выполнении команды deploy и buildDeploy.
entryPoint: main.scmain.sc или entryPoint.sc — главный файл сценария чатбота, с которого начинается загрузка сценария. Файл должен находиться в папке src.
В начале сценария можно подгрузить другие сценарии или js-файлы. Для этого используйте тег require.
tests:\n include:\n - \"**/*.xml\"\n exclude:\n - broken.xmlXML-тесты сценариев позволяют проверить логику чатбота, эмулируя запросы клиента и проверяя ответы от бота.
\nТесты выполняются автоматически при деплое бота, если присутствуют в папке проекта test. Это поведение можно переопределить в секции tests.
Секция tests может содержать две подсекции include и exclude, каждая представляет собой список ant-шаблонов с именами файлов.
include — будут выполнены тесты только из тех файлов, которые попадают под шаблоны, перечисленные в этой подсекции.exclude — из выполнения будут исключены все файлы, которые попадают под шаблоны, перечисленные в этой подсекции.jsTests:\n extensions:\n - spec.js\n - test.js\n include:\n - \"**/*.test.js\"\n - \"dir/*.spec.js\"\n exclude:\n - broken.test.js\n - modules/common/**Платформа представляет возможность выполнять JS unit-тесты для автоматической проверки корректности JS-кода.
\nJS unit-тесты запускаются только локально. Для этого используется утилита по работе с платформой ZB-CLI.
Для выполнения тестов используется фреймворк Jasmine. По умолчанию выполняются все файлы из папки test, имеющие расширение test.js. В chatbot.yaml можно уточнить правила включения unit-тестов, а так же задать расширения для файлов с тестами.
Секция jsTests может содержать подсекции include и exclude, каждая представляет собой список ant-шаблонов с именами файлов.
include — будут выполнены тесты только из тех файлов, которые попадают под шаблоны, перечисленные в этой подсекции.exclude — из выполнения будут исключены все файлы, которые попадают под шаблоны, перечисленные в этой подсекции.В подсекции extensions можно переопределить расширение для файлов с тестами.
language: ruПараметр language используется для установки языка бота по умолчанию, то есть заполняется поле $request.language, если оно не было задано в запросе.
В дальнейшем $request.language используется для выдачи локализованных сообщений об ошибках, а также может быть использован в сценариях.
messages:\n onError:\n defaultMessage: Что-то пошло не так\n locales:\n ru: Что-то пошло не так\n en: Failed on request processingСекция message позволяет переопределить текст сообщения об ошибках чатбота. Текст сообщения указывается в поле defaultMessage.
В случае ошибки, если поле не заполнено, бот не отвечает.
\nЛокализованное сообщение выбирается в соответствии с языком клиента, который передается в параметре $request.language. Если параметр не передан, выводится сообщение из defaultMessage.
dependencies:\n - name: common\n type: git\n url: https://<repository>\n version: heads/master\n - name: another_common\n type: git\n url: https://<repository>\n version: heads/master\nСекция dependencies позволяет определить список зависимостей проекта.
| Поле | \nВозможные значения | \nОписания | \n
|---|---|---|
name | \n<name> | \nИмя модуля, которое будет использоваться при подключении файлов в директиве require. | \n
type | \ngit, module | \nТип зависимости. Здесь: git — внешний git-репозиторий; module — указывает папку в случае, если в одном репозитории содержатся несколько модулей. | \n
url | \nhttp:// git:// file:// | \nurl-адрес репозитория. Только для git-зависимостей. | \n
version | \nheads/master | \nВерсия зависимости, может указывать на branch или tag. Только для git-зависимостей. | \n
?>Зависимости скачиваются в папку module при деплое через веб-интерфейс.
injector:\n name: value\n var1: value2Секция injector позволяет определить конфигурационные параметры чатбота. Определенные здесь параметры будут доступны в скриптах чатбота через переменную $injector.
Для подключения STS классификатора задайте параметры для nlp-функций платформы. Подробное описание параметров и примеры конфигурационного файла в статье.
\nДля работы с NLU-сервисом CAILA укажите в chatbot.yaml параметры:
language: ru\nbotEngine: v2\n\nsts:\n noMatchThreshold: 0.2\ncaila:\n noMatchThreshold: 0.2Подробнее о работе с NLU-сервисом CAILA
\n\nname: echo-template\n\nentryPoint:\n - main.sc\n\ntests:\n include:\n - test.xmlname: zb-cailapub\n\nentryPoint:\n - main.sc\n\nbotEngine: v2\nlanguage: ru\n\nsts:\n noMatchThreshold: 0.2\n\ncaila:\n noMatchThreshold: 0.2name: content\n\nentryPoint:\n - main.sc\n\ndependencies:\n - name: common\n type: git\n url: https://bitbucket.org/common\n version: heads/master\n \ntests:\n include:\n - test.xml\n - purchase_return.xml\n - order.xml\n - commercial.xml\n - unsubscription.xml\n\n\nnlp:\n lengthLimit:\n symbols: 1200\n vocabFile: common-vocabulary.json\n spellcheck:\n enabled: true\n minWordLengthForEditDistance: 3\n maxWordEditDistance: 0\n\nmessages:\n onError:\n defaultMessage: Ой, кажется, что-то пошло не так.\n locales:\n ru: Ой, кажется, что-то пошло не так.