OpenDialog Core Package

OpenDialog is a platform that helps you design, develop, deploy and administer chatbots - or as we like to call them, conversational applications.

OpenDialog Core is the heart of this platform. It provides a framework for developing and integrating the different components that are required to build a conversational application.

OpenDialog is, on the one hand, very opinionated about how to model a conversational application, but, on the other hand, provides a lot of flexibility with respect to intent identification (or NLU more generally) . You can read more about it here.

If you are interested in seeing how OpenDialog works please head over to the OpenDialog app repository and follow the instructions there to install.

This repository is for those that are more interested in the inner workings of OpenDialog, and in particular those that would like to be involved with the core development of OpenDialog. Finally, this is also the right place if you want to integrate OpenDialog functionality into your own PHP application without a GUI.

Installing

To install using Composer run the following command:

composer require opendialogai/core

Local Config

To publish config files for local set up and customisation, run

php artisan vendor:publish --tag="config"

This will copy over all required config files into config/opendialog/

Publishing migration files

Migration files need to be published before they can be applied to an OpenDialog app's database. To publish the migrations, run: php artisan vendor:publish --tag="od-core-migrations" This relies on the MULTI_TENANT env having been set to true in the app's .env file if being run as a multi-tenant system to ensure the migrations end up in the right place

Running Code Sniffer

To run code sniffer, run the following command ./vendor/bin/phpcs --standard=od-cs-ruleset.xml src/ --ignore=*/migrations/*,*/tests/*

This will ignore all files inside of migration directories as they will never have a namespace

Git Hooks

To set up the included git pre-commit hook, first make sure the pre-commit script is executable by running

chmod +x .githooks/pre-commit

Then configure your local git to use this directory for git hooks by running:

git config core.hooksPath .githooks/

Now every commit you make will trigger php codesniffer to run. If there is a problem with the formatting of the code, the script will echo the output of php codesniffer. If there are no issues, the commit will go into git.

Local development and tests

We provide a Docker-based environment for local development and running tests. Head over there for more information.

Logging API requests

By default, all incoming and outgoing API calls will be logged to the request and response mysql tables. To prevent this happening, set the LOG_API_REQUESTS env variable to false.

Introspection logging

To turn on introspection processing set the INTROSPECTION_PROCESSOR_ENABLED env variable to true. This will add extra information to all log messages including the class and line that generated the message.