Структура проекта бота
Файловая структура
Основные составляющие проекта чат-бота: исходный код с логикой диалога, автоматические тесты и конфигурационный файл. Эти составляющие принято разделять между собой: исходный код хранится в папке src
, тесты в папке test
. Конфигурационный файл должен носить название chatbot.yaml
и лежать в корневой папке проекта.
Таким образом, минимальный проект чат-бота состоит из:
- файла
chatbot.yaml
, который содержит дескриптор проекта и лежит в корневой папке проекта. - папки
src
, в которой находится файлmain.sc
с основным сценарием работы чат-бота. В этой папке также могут находиться файлы с дополнительными сценариями, словари в формате.csv
и скрипты в формате.js
. - папки
test
, в которой лежат тесты.xml
для сценария работы чат-бота.
Файлы проекта
Файл | Описание |
---|---|
chatbot.yaml | Конфигурационный файл чат-бота. Содержит имя главного файла сценария, информацию о подключаемых модулях, конфигурацию NLU-модуля, список тестов и другую конфигурационную информацию. |
.sc | Файлы сценариев. Это основные файлы, задающие логику диалога. |
.js | Файлы js-библиотек. Содержат JavaScript-код, который можно использовать в файлах сценариев. Могут содержать функции, логику обработки запросов, вызовы внешних систем и пр. |
.csv | Справочники именованных сущностей. Необходимы для обработки в паттернах большого количества каких-либо названий, например, названий городов, стран, имен и пр. |
.yaml | Справочники ответов и других параметров для использования в скриптах. |
.xml | Файлы с тестами. Автоматические тесты, которые выполняются при публикации чат-бота. |
descriptor.json | Настройки размещения основного конфигурационного файла chatbot.yaml . Используется для импорта/экспорта проекта. |
.jgraph/jgraph.visuals | Настройки отображения сценария в графическом редакторе J‑Graph. |