chatbot.yaml is the main configuration file of a chat bot. It contains the name of the script main file, information about linked modules, configuration of the NLU module, list of tests and other configuration data.
name: botNameThis parameter is used to generate the name of a zip file when you run the build or buildDeploy command and the botId when you run deploy or buildDeploy.
entryPoint: main.scmain.sc or entryPoint.sc is the main file of the chat bot script from which the script starts to load. The file must be located in the src folder.
Other scripts and JS files can be loaded at the start of the script via the require tag.
tests:\n include:\n - \"**/*.xml\"\n exclude:\n - broken.xmlYou can use script XML tests to verify chat bot logic by emulating client requests and verifying bot responses.
\nAny tests located in the test folder run automatically when you deploy your bot. You can override this behavior in the tests section.
The tests section can contain two subsections, include and exclude, each of them being the list of ant templates with file names.
include — only the tests from the files that match the templates listed in this section will be executed.exclude — all the files matching the templates listed in this section will be excluded from execution.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/**You can run JS unit tests on the platform to automatically verify whether your JS code is correct.
\nJS unit tests can only be executed locally. You can use the ZB-CLI maintenance utility for that.
The Jasmine framework is used to run the tests. All the files from the test folder with the test.js extension are run by default. You can refine your unit test inclusion rules in the chatbot.yaml file and specify extensions for files containing tests.
The jsTests section can contain two subsections, include and exclude, each of them being the list of ant templates with file names.
include — only the tests from the files that match the templates listed in this section will be executed.exclude — all the files matching the templates listed in this section will be excluded from execution.You can override the extension for your test files in the extensions subsection.
language: ruUse the language parameter to specify your default bot language by filling the $request.language field (if it was not specified in the request).
The $request.language language will then be used to display localized error messages, and it can also be used in scripts.
messages:\n onError:\n defaultMessage: Something has gone wrong\n locales:\n ru: Something has gone wrong\n en: Failed on request processingYou can override your chat bot error message text in the message section. The text of the message is specified in the defaultMessage field.
If an error occurs and this field is not specified, the bot will not respond.
\nLocalized message is selected depending on the client language given with the $request.language parameter. If the parameter is not given, the defaultMessage message is displayed.
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\nYou can define the list of dependencies of your project in the dependencies section.
| Field | \nPossible values | \nDescriptions | \n
|---|---|---|
name | \n<name> | \nName of the module to be used when you include files with the require statement. | \n
type | \ngit, module | \nDependency type. Here: git is an external git repository; module specifies the folder if the repository contains multiple modules. | \n
url | \nhttp:// git:// file:// | \nurl address of the repository. For git dependencies only. | \n
version | \nheads/master | \nDependency version; can specify the branch of the tag. For git dependencies only. | \n
?>Dependencies are downloaded to the module folder when you deploy via the web interface.
injector:\n name: value\n var1: value2Use the injector section to define configuration parameters of your chat bot. Parameters defined here will be available in chat bot scripts via the $injector variable.
Specify parameters for the platform’s nlp functions in order to enable an STS classifier. You can find detailed description of parameters and configuration file examples in this article.
\nSpecify the following parameters in the chatbot.yaml file if you want to use the CAILA NLU service:
language: ru\nbotEngine: v2\n\nsts:\n noMatchThreshold: 0.2\ncaila:\n noMatchThreshold: 0.2Learn more about the CAILA NLU service
\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: Oops, something has gone wrong.\n locales:\n ru: Oops, something has gone wrong.