Creating a JAICF project

JAICF is an open-source framework from Just AI that can be used to develop voice assistants and chatbots using the Kotlin-based DSL.

Please make yourself familiar with JAICF concepts and features before you start.

Creating a project

Go to Projects > click Create project next to JAICF. You can choose external hosting or JAICP cloud as the runtime environment. Fill in the form of fields according to the selected runtime environment.

External hosting as the runtime environment

Fill out the fields in the Name tab:

Enter the project name.
Select External as the runtime environment. Hosting options are described here.

Then click on the Location tab, here:

Clone a template from the JAICF repository.
Copy the API token and paste it into the bot code.
Select one of the ways to connect to the platform:
- long polling — the bot will automatically connect to the Just AI server to interact with the platform;
- webhook — the bot will accept messages from the platform at the specified link.

These parameters are enough for the project to be started. You can click Create here and test your bot in one of the channels.

If you need to configure NLU, open the Classifier and NLU settings tabs.

JAICP cloud as the runtime environment Early access

JAICP cloud bot hosting is an early access feature available on request.

Go to Projects > click Create project next to JAICF.

Fill out the fields in the Name tab:

Enter the project name.
Select JAICP cloud as your runtime environment. The project will be compiled and run in the JAICP cloud, and the source code can only be stored in the cloud or an external Git repository.
Select one of the options for the Project code field:
- System template — The project will be initialized with a system template. Select the template from the list. Please note that the contents of the master branch will be overwritten if an external repository is used for hosting.
- External template — The project will be initialized with an external template. Specify the address of the Git repository containing the template below. Please note that the contents of the master branch will be overwritten if an external repository is used for hosting.
- Connect existing project — An existing project will be connected. Specify the link to the Git repository in the Location tab.

Then open the Location tab. Here you need to specify the JAICF project hosting option.

New projects are stored locally by default. But you can also use an external repository, e.g. to connect an existing project.

Learn more about hosting a project

These parameters are enough for the project to be started. You can click Create here and test your bot in one of the channels.

If you need to configure NLU, open the Classifier and Advanced NLU settings tabs.

Classifier and NLU configuration

The CAILA NLU kernel will be used by default when the bot connects to the platform. In the Classifier tab, you can define the classifier algorithm, spellchecker settings and the timezone that affects entity parsing.

You can also specify new NLU settings in the NLU settings tab when you create and modify the project. Settings are passed in the text form within a JSON object.

Learn more about classifier parameters and extended NLU settings