{"id":28855964,"url":"https://github.com/rasahq/retail-demo","last_synced_at":"2025-07-10T01:33:09.902Z","repository":{"id":42179959,"uuid":"319436992","full_name":"RasaHQ/retail-demo","owner":"RasaHQ","description":"Rasa's retail starter pack","archived":false,"fork":false,"pushed_at":"2022-12-26T16:27:09.000Z","size":90,"stargazers_count":41,"open_issues_count":8,"forks_count":46,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-20T00:09:43.533Z","etag":null,"topics":["bot","chatbot","chatbot-example","python","rasa","rasa-starter-pack","retail"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RasaHQ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-07T20:31:52.000Z","updated_at":"2025-04-25T23:03:44.000Z","dependencies_parsed_at":"2023-01-31T00:30:53.775Z","dependency_job_id":null,"html_url":"https://github.com/RasaHQ/retail-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RasaHQ/retail-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RasaHQ%2Fretail-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RasaHQ%2Fretail-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RasaHQ%2Fretail-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RasaHQ%2Fretail-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RasaHQ","download_url":"https://codeload.github.com/RasaHQ/retail-demo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RasaHQ%2Fretail-demo/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264512210,"owners_count":23620290,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","chatbot","chatbot-example","python","rasa","rasa-starter-pack","retail"],"created_at":"2025-06-20T00:09:43.448Z","updated_at":"2025-07-10T01:33:09.894Z","avatar_url":"https://github.com/RasaHQ.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Retail Example Bot\n\nThis 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\n\n## Install dependencies\n\nRun:\n```bash\npip install -r requirements.txt\n```\n\n## Run the bot\n\nUse `rasa train` to train a model.\n\nThen, to run, first set up your action server in one terminal window:\n```bash\nrasa run actions\n```\n\nIn another window, run the duckling server (for entity extraction):\n```bash\ndocker run -p 8000:8000 rasa/duckling\n```\n\nThen talk to your bot by running:\n```\nrasa shell --debug\n```\n\nNote that `--debug` mode will produce a lot of output meant to help you understand how the bot is working\nunder the hood. To simply talk to the bot, you can remove this flag.\n\n\n## Overview of the files\n\n`data/stories.yml` - contains stories\n\n`data/nlu.yml` - contains NLU training data\n\n\n`data/rules.yml` - contains the rules upon which the bot responds to queries\n\n`actions/actions.py` - contains custom action/api code\n\n`domain.yml` - the domain file, including bot response templates\n\n`config.yml` - training configurations for the NLU pipeline and policy ensemble\n\n`tests/test_stories.yml` - end-to-end test stories\n\n\n## Things you can ask the bot\n\n1. Check the status of an order\n2. Return an item\n3. Cancel an item\n4. Search a product inventory for shoes\n5. Subscribe to product updates\n\nThe bot can handle switching forms and cancelling a form, but not resuming a form after switching yet.\n\nThe 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.\n\nFor the purposes of illustration, the bot has orders for the following email addresses:\n\n- `example@rasa.com`\n- `me@rasa.com`\n- `me@gmail.com`\n\nAnd these are the shoes that should show as in stock (size, color):\n\n```\ninventory = [(7, 'blue'),\n             (8, 'blue'),\n             (9, 'blue'),\n             (10, 'blue'),\n             (11, 'blue'),\n             (12, 'blue'),\n             (7, 'black'),\n             (8, 'black'),\n             (9, 'black'),\n             (10, 'black')\n            ]\n```\n\n## Testing the bot\n\nYou can test the bot on test conversations by running  `rasa test`.\nThis 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`.\n\nNote that if duckling isn't running when you do this, you'll see some failures.\n\n## Rasa X Deployment\n\nTo [deploy this bot](https://rasa.com/docs/rasa/user-guide/how-to-deploy/), it is highly recommended to make use of the\n[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\nconfigurations, and build or pull an action server image.\n\n\n## Action Server Image\n\nYou 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\nthe [public image on Dockerhub](https://hub.docker.com/repository/docker/cdesmar/retail-demo) instead of building it yourself.\n\nIt 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.\n\n\n## :gift: License\nLicensed under the GNU General Public License v3. Copyright 2021 Rasa Technologies\nGmbH. [Copy of the license](https://github.com/RasaHQ/retail-demo/blob/main/LICENSE).\nLicensees may convey the work under this license. There is no warranty for the work.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frasahq%2Fretail-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frasahq%2Fretail-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frasahq%2Fretail-demo/lists"}