This site is no longer updated.Go to new Conversational Cloud docs

Project creation and editing

Go to the Projects page and click Create project.

Project creation settings are separated into tabs:

  1. Name.
  2. Location.
  3. Classifier (described separately).
  4. NLU settings (described separately).

Name

Fill in the fields:

  • Name — the project name, required field.
  • Description — a short project description.
  • NLU language — the language the bot will understand.
  • Template — a pre-configured bot example.

The template will be loaded automatically and can be connected to a channel right away. Different templates have different content and structure: check the description below the template name.


Location

JAICP supports two ways of storing projects: in the local storage (the default option) or in an external repository.


Local storage

Projects kept in the local storage are stored directly in JAICP.

Local projects are created quickly and do not require any extra repository administration, but they impose a number of restrictions:

  • No proper version control and no way to roll back to previous versions.
  • Difficulties for several developers to work on the project at the same time.
  • Projects become harder to maintain as their codebase grows.

If you still prefer the local storage, click Create. After the project has been created, you can move on to creating a bot.


External repository

Alternatively, projects may be stored in Git repositories.

Other version control systems like Mercurial or SVN are not supported.

Using Git for project storage has a number of advantages:

  • The ability to roll back the project to any previous version.
  • Easy collaboration and simultaneous development due to branching.
  • Flexible control over content development teams.

Repositories may be hosted on any hosting service, such as Bitbucket, GitLab, or GitHub.

Open the Location tab and enable the External repository toggle. You can provide guest access to the external repository or use your personal account.

It is not recommended to use an external repository while creating a project from a template: in this case, all data in the repository will be overwritten by the template code.


Guest access On-premise

Guest access can only be enabled for the JAICP On-premise platform version.

Fill in the fields:

  • Link — the link to your repository.
  • Folder — the path to the directory containing the contents of your project.

The content directory is the one which contains the chatbot.yaml configuration file.

  • Branch — the content branch, master by default.

This setting primarily affects the branch whose contents will be displayed in the editor. However, any channel may still use any branch.

  • Access — choose Guest. You need to provide write and read access to the account specified in the platform configuration.
  • Secret key — the key protects external repositories with guest access. Generate a key or come up with your own.

Learn more about secret keys

Click Create. After the project has been created, you can move on to creating a bot.


Personal account

Fill in the fields:

  • Link — the repository URL.
  • Folder — the path to the directory containing the contents of your project.
  • Branch — the content branch, master by default.
  • Access — choose Personal account.
  • Login — the login to the hosting where the repository is located.
  • Password — the password from the hosting account.

Click Create.


Changing the project location

Once a project is created, you cannot directly change its location from the local storage to an external repository or vice versa.

Transfer to an external repository

In order to transfer a project from the local storage to a repository, the following steps are required:

  1. Export the project as an archive and unzip it.
  2. Initialize a new Git repository in the directory containing the chatbot.yaml descriptor.
  3. Commit the changes and push them to an external repository.
  4. Create a new project and provide the external repository details.

Transfer to the local storage

Transferring back to the local storage is simple:

  1. Export the project as an archive.
  2. Create a new project stored in the local storage.
  3. Import the old project’s contents to the new one.

Log deletion

The platform allows the deletion of dialog logs after a specified time.

Contact our technical support to activate the option of log deletion.


Project editing

You can edit the project settings after it has been created:

  1. On the side bar, click Projects to move to the page containing all of your projects.
  2. Click the    icon next to the project name and choose Edit.
  3. Apply all the necessary changes on the same tabs as during project creation and click Save.