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.

Read about JAICF concepts and features before you start.

Creating a project

To create a project using JAICF:

1. Go to the JAICP main page and click + Create project.
2. Click the Create JAICF project link under the ways of creating a project for JAICP.
3. You can choose external hosting or JAICP cloud as the runtime environment.
4. Fill in the fields according to the selected runtime environment.

External hosting as the runtime environment

Read about hosting options

Fill in the fields:

• Project name — the project name, required field.
• NLU language — the language the bot will understand.

Click Next, then on the Host the project page do the following:

• 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. Click Create project. You will be redirected to the project page.

Now you can test your bot in one of the channels.

To configure NLU, click on the top navigation bar, then Project properties > 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.

Select one of the ways to create the project:

• From a system template.
• Connect to Git project.
• Clone project.
• Upload existing project.

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.

Learn more about storing a project

After you have created a project, you can test your bot in one of the channels.

To configure NLU, open the Classifier and Advanced NLU settings tabs.

Create a project from a system template

1. Fill in the fields:

   • Project name — the project name, required field.
   • NLU language — the language the bot will understand.

2. Select where to store the project:

   • GitHub.
   • Another service.
   • Local storage in JAICP (the Create and store project in JAICP link).

Connect to a Git project

Specify the project name and select where to store it:

• GitHub.
• Another service.

Clone a project

1. Clone a project from any external repository.

2. Fill in the fields:

   • Project name — the project name, required field.
   • Repository location — the URL of your repository.

3. Select where to store the project:

   • GitHub.
   • Another service.
   • Local storage in JAICP (the Create and store project in JAICP link).

Upload an existing project

You can upload the file with your project from your device.

1. Fill in the fields:

   • Project name — the project name, required field.
   • ZIP file — the field for uploading your archive.

2. Select where to store the project:

   • GitHub.
   • Another service.
   • Local storage in JAICP (the Create and store project in JAICP link).

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