# kairon **Repository Path**: colinsong2021/kairon ## Basic Information - **Project Name**: kairon - **Description**: kairon：基于RASA构建的工具套件，用于使用高级NLP训练和部署您的聊天机器人 - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-10-09 - **Last Updated**: 2021-10-09 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ![Python application](https://github.com/digiteinfotech/rasa-dx/workflows/Python%20application/badge.svg) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/036a621f7ae74cecb3db5f01441df65e)](https://app.codacy.com/gh/digiteinfotech/rasa-dx?utm_source=github.com&utm_medium=referral&utm_content=digiteinfotech/rasa-dx&utm_campaign=Badge_Grade_Dashboard) [![Coverage](https://coveralls.io/repos/github/digiteinfotech/kairon/badge.svg)](https://coveralls.io/github/digiteinfotech/kairon) [![Total alerts](https://img.shields.io/lgtm/alerts/g/digiteinfotech/rasa-dx.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/digiteinfotech/rasa-dx/alerts/) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/digiteinfotech/rasa-dx.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/digiteinfotech/rasa-dx/context:python) # Kairon Kairon is envisioned as a web based microservices driven suite that helps train Rasa contextual AI assistants at scale. It is designed to make the lives of those who work with ai-assistants easy, by giving them a no-coding web interface to adapt , train , test and maintain such assistants . **What is Kairon?** Kairon is currently a set of tools built on the RASA framework with a helpful UI interface . While RASA focuses on technology of chatbots itself. Kairon on the other hand focuses on technology that deal with pre-processing of data that are needed by this framework. These include question augmentation and generation of knowledge graphs that can be used to automatically generate intents, questions and responses. It also deals with the post processing and maintenance of these bots such metrics / follow-up messages etc. **What can it do?** Kairon is open-source. One of the biggest problems for users is adapting contextual AI assistants to specific domain is one of the bigger problems adopting chatbots within organizations. This means extensive work creating intents by going through documentation, testing accuracy of responses, etc. Kairon’s aim is to provide a no-coding self service framework that helps users achieve this. These are the features in the 0.1 version with many more features incoming! - Easy to use UI for adding – editing Intents, Questions and Responses - Question augmentation to auto generate questions and enrich training data - Model Training and Deployment from Interface. - Metrics for model performance. This website can be found at [Kairon](https://kairon.digite.com/) and is hosted by Digite Inc. **Who uses it ?** Kairon is built for two personas Teams and Individuals who want an easy no-coding interface to create, train, test and deploy chatbots. One can directly access these features from our hosted website. Teams who want to host the chatbot trainer in-house. They can build it using docker compose. Our teams current focus within NLP is Knowledge Graphs – Do let us know if you are interested. At this juncture it layers on top of [Rasa Open Source](https://rasa.com/) # Deployment Kairon only requires a recent version of [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/). Please do the below changes in **docker/docker-compose.yml** 1. set env variable **server** to public IP of the machine where trainer api docker container is running for example: http://localhost:81 2. **Optional**, if you want to have google analytics enabled then uncomment **trackingid** and set google analytics tracking id 3. set env variable **SECRET_KEY** to some random key. use below command for generating random secret key ```shell openssl rand -hex 32 ``` 4. run the command. ```shell cd kairon/docker docker-compose up -d ``` 5. Open http://localhost/ in browser. 6. To Test use username: **test@demo.in** and password: **Changeit@123** to try with demo user # Development ## Installation 1. Kairon requires [python3.6.9+ or 3.7](https://www.python.org/downloads/) and [mongo 4.0+](https://www.mongodb.com/download-center/community) 2. Then clone this repo ```shell git clone https://github.com/digiteinfotech/kairon.git cd kairon/ ``` 3. For creating Virtual environment, please follow the [link](https://uoa-eresearch.github.io/eresearch-cookbook/recipe/2014/11/26/python-virtual-env/) 4. For installing dependencies **Windows** ``` setup.bat ``` **No Matching distribution found tensorflow-text** - remove the dependency from requirements.txt file, as **window version is not available** [#44](https://github.com/tensorflow/text/issues/44) **Linux** ``` chmod 777 ./setup.sh sh ./setup.sh ``` 5. For starting augmentation services run ``` python -m uvicorn augmentation.paraphrase.server:app --host 0.0.0.0 ``` 6. For starting trainer-api services run ``` python -m uvicorn kairon.api.app.main:app --host 0.0.0.0 --port 8080 ``` ## System Configuration ### Email verification setup The email.yaml file can be used to configure the process for account confirmation through a verification link sent to the user's mail id. It consists of the following parameters: * **enable** - set value to True for enabling email verification, and False to disable. You can also use the environment variable **EMAIL_ENABLE** to change the values. * **url** - this url, along with a unique token is sent to the user's mail id for account verification as well as for password reset tasks. You can also use the environment variable **APP_URL** to change the values. * **email** - the mail id of the account which sends the confirmation mail. You can also use the environment variable **EMAIL_SENDER_EMAIL** to change the values. * **password** - the password of the account which sends the confirmation mail. You can also use the environment variable **EMAIL_SENDER_PASSWORD** to change the values. * **port** - the port that is used to send the mail [For ex. "587"]. You can also use the environment variable **EMAIL_SENDER_PORT** to change the values. * **service** - the mail service that is used to send the confirmation mail [For ex. "gmail"]. You can also use the environment variable **EMAIL_SENDER_SERVICE** to change the values. * **tls** - set value to True for enabling transport layer security, and False to disable. You can also use the environment variable **EMAIL_SENDER_TLS** to change the values. * **userid** - the user ID for the mail service if you're using a custom service for sending mails. You can also use the environment variable **EMAIL_SENDER_USERID** to change the values. * **confirmation_subject** - the subject of the mail to be sent for confirmation. You can also use the environment variable **EMAIL_TEMPLATES_CONFIRMATION_SUBJECT** to change the subject. * **confirmation_body** - the body of the mail to be sent for confirmation. You can also use the environment variable **EMAIL_TEMPLATES_CONFIRMATION_BODY** to change the body of the mail. * **confirmed_subject** - the subject of the mail to be sent after confirmation. You can also use the environment variable **EMAIL_TEMPLATES_CONFIRMED_SUBJECT** to change the subject. * **confirmed_body** - the body of the mail to be sent after confirmation. You can also use the environment variable **EMAIL_TEMPLATES_CONFIRMED_BODY** to change the body of the mail. * **password_reset_subject** - the subject of the mail to be sent for password reset. You can also use the environment variable **EMAIL_TEMPLATES_PASSWORD_RESET_SUBJECT** to change the subject. * **password_reset_body** - the body of the mail to be sent for password reset. You can also use the environment variable **EMAIL_TEMPLATES_PASSWORD_RESET_BODY** to change the body of the mail. * **password_changed_subject** - the subject of the mail to be sent after changing the password. You can also use the environment variable **EMAIL_TEMPLATES_PASSWORD_CHANGED_SUBJECT** to change the subject. * **password_changed_body** - the body of the mail to be sent after changing the password. You can also use the environment variable **EMAIL_TEMPLATES_PASSWORD_CHANGED_BODY** to change the body of the mail. # Documentation Documentation for all APIs for Kairon are still being fleshed out. A intermediary version of the documentation is available here. [Documentation](http://kairon-docs.digite.com/) # Contribute We ❤️ contributions of all size and sorts. If you find a typo, if you want to improve a section of the documentation or if you want to help with a bug or a feature, here are the steps: 1. Fork the repo and create a new branch, say rasa-dx-issue1 2. Fix/improve the codebase 3. write test cases and documentation for code' 4. run test cases. ``` python -m pytest ``` 5. reformat code using black ``` python -m black bot_trainer ``` 6. Commit the changes, with proper comments about the fix. 7. Make a pull request. It can simply be one of your commit messages. 8. Submit your pull request and wait for all checks passed. 9. Request reviews from one of the developers from our core team. 10. Get a 👍 and PR gets merged. ## Built With * [Rasa](https://rasa.com/docs/) - The bot framework used * [PiPy](https://pypi.org/) - Dependency Management * [Mongo](https://www.mongodb.com/) - DB * [MongoEngine](http://mongoengine.org/) - ORM * [FastApi](https://github.com/tiangolo/fastapi) - Rest Api * [Uvicorn](https://www.uvicorn.org/) - ASGI Server * [Spacy](https://spacy.io/) - NLP * [Pytest](https://docs.pytest.org/en/latest/) - Testing * [MongoMock](https://github.com/mongomock/mongomock) - Mocking DB * [Response](https://github.com/getsentry/responses) - Mocking HTTP requests * [Black](https://github.com/psf/black) - Code Reformatting * [NLP AUG](https://github.com/makcedward/nlpaug.git) - Augmentation ## Authors The repository is being maintained and supported by **Digite Inc.** * **Digite,Inc.** - [Digite](https://digite.com) * [Fahad Ali Shaikh](https://github.com/sfahad1414) * [Deepak Naik](https://github.com/deenaik) * [Nirmal Parwate](https://github.com/nirmal495) See also the list of [contributors](https://github.com/digiteinfotech/kairon/graphs/contributors) who participated in this project. ## License Licensed under the Apache License, Version 2.0. [Copy of the license](LICENSE.txt) A list of the Licenses of the dependencies of the project can be found at the [Link](https://www.digite.com/kairon/libraries/)