Getting started

Installation

Chatsky can be easily installed on your system using the pip package manager:

pip install chatsky

This framework is compatible with Python 3.8 and newer versions.

The above command will set the minimum dependencies to start working with Chatsky. The installation process allows the user to choose from different packages based on their dependencies, which are:

pip install chatsky[json]  # dependencies for using JSON
pip install chatsky[pickle] # dependencies for using Pickle
pip install chatsky[redis]  # dependencies for using Redis
pip install chatsky[mongodb]  # dependencies for using MongoDB
pip install chatsky[mysql]  # dependencies for using MySQL
pip install chatsky[postgresql]  # dependencies for using PostgreSQL
pip install chatsky[sqlite]  # dependencies for using SQLite
pip install chatsky[ydb]  # dependencies for using Yandex Database
pip install chatsky[telegram]  # dependencies for using Telegram
pip install chatsky[benchmark]  # dependencies for benchmarking

For example, if you are going to use one of the database backends, you can specify the corresponding requirements yourself.

Additionally, you also have the option to download the source code directly from the GitHub repository using the commands:

git clone https://github.com/deeppavlov/chatsky.git
cd chatsky

Once you are in the directory, you can run the command poetry install --all-extras to set up all the requirements for the library.

Quick start with a project template

If you don’t want to bother with setting up project files, you can use the Chatsky Project Template repository, which offers a ready-to-use simple bot that can be modified to your needs.

Key concepts

Chatsky is a powerful tool for creating conversational services. It allows developers to easily write and manage dialog systems by defining a special dialog graph that describes the behavior of the service. Chatsky offers a specialized language (DSL) for quickly writing dialog graphs, making it easy for developers to create chatbots for a wide range of applications, such as social networks, call centers, websites, personal assistants, etc.

Chatsky has several important concepts:

Script: First of all, to create a dialog agent it is necessary to create a dialog Script. A dialog script is a dictionary, where keys correspond to different flows. A script can contain multiple scripts, which are flows too, what is needed in order to divide a dialog into sub-dialogs and process them separately.

Flow: As mentioned above, the dialog is divided into flows. Each flow represent a sub-dialog corresponding to the discussion of a particular topic. Each flow is also a dictionary, where the keys are the nodes.

Node: A node is the smallest unit of a dialog flow, and it contains the bot’s response to a user’s input as well as a condition that determines the transition to another node, whether it’s within the current or another flow.

Keywords: Chatsky uses several special keywords. These keywords are the keys in the dictionaries inside the script. The most important for using the framework are RESPONSE and TRANSITIONS keywords. The first one corresponds to the response that the bot will send to the user from the current node. The second corresponds to the transition conditions from the current node to other nodes.