Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RasaHQ/retail-demo
Rasa's retail starter pack
https://github.com/RasaHQ/retail-demo
bot chatbot chatbot-example python rasa rasa-starter-pack retail
Last synced: 3 months ago
JSON representation
Rasa's retail starter pack
- Host: GitHub
- URL: https://github.com/RasaHQ/retail-demo
- Owner: RasaHQ
- License: gpl-3.0
- Created: 2020-12-07T20:31:52.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-26T16:27:09.000Z (almost 2 years ago)
- Last Synced: 2024-07-30T07:36:54.131Z (4 months ago)
- Topics: bot, chatbot, chatbot-example, python, rasa, rasa-starter-pack, retail
- Language: Python
- Homepage:
- Size: 87.9 KB
- Stars: 38
- Watchers: 5
- Forks: 44
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Retail Example Bot
This is a sample retail bot to help provide starter content, examples of how to implement particular features, and sample use cases. Built using Rasa 2.3.1
## Install dependencies
Run:
```bash
pip install -r requirements.txt
```
## Run the bot
Use `rasa train` to train a model.
Then, to run, first set up your action server in one terminal window:
```bash
rasa run actions
```
In another window, run the duckling server (for entity extraction):
```bash
docker run -p 8000:8000 rasa/duckling
```
Then talk to your bot by running:
```
rasa shell --debug
```
Note that `--debug` mode will produce a lot of output meant to help you understand how the bot is working
under the hood. To simply talk to the bot, you can remove this flag.
## Overview of the files
`data/stories.yml` - contains stories
`data/nlu.yml` - contains NLU training data
`data/rules.yml` - contains the rules upon which the bot responds to queries
`actions/actions.py` - contains custom action/api code
`domain.yml` - the domain file, including bot response templates
`config.yml` - training configurations for the NLU pipeline and policy ensemble
`tests/test_stories.yml` - end-to-end test stories
## Things you can ask the bot
1. Check the status of an order
2. Return an item
3. Cancel an item
4. Search a product inventory for shoes
5. Subscribe to product updates
The bot can handle switching forms and cancelling a form, but not resuming a form after switching yet.
The main flows have the bot retrieving or changing information in a SQLite database (the file `example.db`). You can use `initialize.db` to change the data that exists in this file.
For the purposes of illustration, the bot has orders for the following email addresses:
- `[email protected]`
- `[email protected]`
- `[email protected]`
And these are the shoes that should show as in stock (size, color):
```
inventory = [(7, 'blue'),
(8, 'blue'),
(9, 'blue'),
(10, 'blue'),
(11, 'blue'),
(12, 'blue'),
(7, 'black'),
(8, 'black'),
(9, 'black'),
(10, 'black')
]
```
## Testing the bot
You can test the bot on test conversations by running `rasa test`.
This will run [end-to-end testing](https://rasa.com/docs/rasa/user-guide/testing-your-assistant/#end-to-end-testing) on the conversations in `tests/test_stories.yml`.
Note that if duckling isn't running when you do this, you'll see some failures.
## Rasa X Deployment
To [deploy this bot](https://rasa.com/docs/rasa/user-guide/how-to-deploy/), it is highly recommended to make use of the
[one line deploy script](https://rasa.com/docs/rasa-x/installation-and-setup/one-line-deploy-script/) for Rasa X. As part of the deployment, you'll need to set up [git integration](https://rasa.com/docs/rasa-x/installation-and-setup/integrated-version-control/#connect-your-rasa-x-server-to-a-git-repository) to pull in your data and
configurations, and build or pull an action server image.
## Action Server Image
You will need to have docker installed in order to build the action server image. If you haven't made any changes to the action code, you can also use
the [public image on Dockerhub](https://hub.docker.com/repository/docker/cdesmar/retail-demo) instead of building it yourself.
It is recommended to use an [automated CI/CD process](https://rasa.com/docs/rasa/user-guide/setting-up-ci-cd) to keep your action server up to date in a production environment.
## :gift: License
Licensed under the GNU General Public License v3. Copyright 2021 Rasa Technologies
GmbH. [Copy of the license](https://github.com/RasaHQ/retail-demo/blob/main/LICENSE).
Licensees may convey the work under this license. There is no warranty for the work.