{"id":15524351,"url":"https://github.com/codeforequity-at/botium-connector-rasa","last_synced_at":"2025-04-23T07:30:22.426Z","repository":{"id":34887505,"uuid":"185676873","full_name":"codeforequity-at/botium-connector-rasa","owner":"codeforequity-at","description":"Botium Connector for Rasa","archived":false,"fork":false,"pushed_at":"2022-02-15T13:59:34.000Z","size":218,"stargazers_count":4,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-24T03:48:06.496Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.botium.ai","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codeforequity-at.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":"2019-05-08T20:43:52.000Z","updated_at":"2022-02-10T07:54:54.000Z","dependencies_parsed_at":"2022-08-08T02:15:35.436Z","dependency_job_id":null,"html_url":"https://github.com/codeforequity-at/botium-connector-rasa","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-rasa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-rasa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-rasa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-rasa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-rasa/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250390768,"owners_count":21422777,"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":[],"created_at":"2024-10-02T10:51:03.562Z","updated_at":"2025-04-23T07:30:22.404Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Rasa\n\n[![NPM](https://nodei.co/npm/botium-connector-rasa.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-rasa/)\n\n[![Codeship Status for codeforequity-at/botium-connector-rasa](https://app.codeship.com/projects/85c1e8b0-5ac7-0137-3809-76862924ef8c/status?branch=master)](https://app.codeship.com/projects/342527)\n[![npm version](https://badge.fury.io/js/botium-connector-rasa.svg)](https://badge.fury.io/js/botium-connector-rasa)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()\n\nThis is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your Rasa chatbot.\n\n__Did you read the [Botium in a Nutshell](https://medium.com/@floriantreml/botium-in-a-nutshell-part-1-overview-f8d0ceaf8fb4) articles? Be warned, without prior knowledge of Botium you won't be able to properly use this library!__\n\n## How it works\nBotium connects to your Rasa chatbot either to [Rasa Core](https://rasa.com/docs/rasa/user-guide/connectors/your-own-website/) or to [Rasa NLU](https://rasa.com/docs/rasa/api/http-api/) directly.\n\nWhen connecting to Rasa Core, Botium can test the conversational flow. When connecting to Rasa NLU, Botium can test the NLU functions only with the [Botium NLP Asserters](https://botium-docs.readthedocs.io/en/latest/05_botiumscript/index.html#nlp-asserter-intents-entities-confidence)\n\nIt can be used as any other Botium connector with all Botium Stack components:\n* [Botium CLI](https://github.com/codeforequity-at/botium-cli/)\n* [Botium Bindings](https://github.com/codeforequity-at/botium-bindings/)\n* [Botium Box](https://www.botium.ai)\n\n## Requirements\n* **Node.js and NPM**\n* a **Rasa bot**\n* a **project directory** on your workstation to hold test cases and Botium configuration\n\n## Install Botium and Rasa Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-rasa\n\u003e botium-cli init\n\u003e botium-cli run\n```\n\nWhen using __Botium Bindings__:\n\n```\n\u003e npm install -g botium-bindings\n\u003e npm install -g botium-connector-rasa\n\u003e botium-bindings init mocha\n\u003e npm install \u0026\u0026 npm run mocha\n```\n\nWhen using __Botium Box__:\n\n_Already integrated into Botium Box, no setup required_\n\n## Connecting Rasa chatbot to Botium\n\n### Setting up Rasa\n\nWhen using _REST\\_INPUT_ (Rasa Core), you have to add the [RestInput channel](https://rasa.com/docs/rasa/user-guide/connectors/your-own-website/) to your Rasa configuration.\n\nWhen using _NLU\\_INPUT_ (Rasa Core), you have to add the _--enable-api_ [command line switch](https://rasa.com/docs/rasa/user-guide/command-line-interface/) when starting your Rasa server.\n\n### Setting up Botium\n\nCreate a botium.json with the the URL of your Rasa installation in your project directory:\n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"rasa\",\n      \"RASA_MODE\": \"REST_INPUT\",\n      \"RASA_ENDPOINT_URL\": \"https://box.botium.at/rasa-demo/\"\n    }\n  }\n}\n```\n\nTo check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:\n\n```\n\u003e botium-cli emulator\n```\n\nBotium setup is ready, you can begin to write your test cases with [BotiumScript](https://botium-docs.readthedocs.io/en/latest/05_botiumscript/index.html).\n\n## Using the botium-connector-rasa-cli\n\nThis connector provides a CLI interface for importing convos and utterances from your Rasa model and convert it to BotiumScript.\n\nYou can either run the CLI with botium-cli (it is integrated there), or directly from this connector (see samples/nlu/package.json for an example):\n\n    \u003e botium-connector-rasa-cli import --nlufile path-to-my-nlu.md\n\n_Please note that a botium-core installation is required_\n\nFor getting help on the available CLI options and switches, run:\n\n    \u003e botium-connector-rasa-cli --help\n\n## How to start sample\n\nThere are two samples available in the [samples](./samples) folder. Both of them are based on [Sara - the Rasa Demo Bot](https://github.com/RasaHQ/rasa-demo). Adapt the botium.json in these directories with your own Rasa Demo installation.\n\nYou can start the samples with these commands:\n\n```\n\u003e cd ./samples/core\n\u003e npm install \u0026\u0026 npm test\n```\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __rasa__ to activate this connector.\n\n### RASA_ENDPOINT_URL\nRasa endpoint URL.\n\n### RASA_MODE\n_Default: DIALOG\\_AND\\_NLUT_\n\n**REST_INPUT for using Rasa Core**\nThe Rasa endpoint URL is extended with /webhooks/rest/webhook for posting the Botium requests.\n\n**NLU_INPUT for using Rasa NLU**\nThe Rasa endpoint URL is extended with /model/parse for posting the Botium requests.\n\n**DIALOG_AND_NLU**\nCombining Rasa dialogue and NLU engine endpoints\n\n### RASA_REST_ENDPOINT_PATH\nRest endpoint path. By default, it is `webhooks/rest/webhook`\n\n### RASA_NLU_ENDPOINT_PATH\nNLU endpoint path. By default, it is `model/parse`\n\n### RASA_ENDPOINT_PING_URL\n_Default: endpoint URL/version_\n\nURL to ping for checking availability of Rasa. By default, the _version_-endpoint is contacted.\n\n### RASA_ENDPOINT_TOKEN\nIf your Rasa endpoint is protected with token authentication, you have to specify the token to use here.\n\n### RASA_ENDPOINT_JWT\nIf your Rasa endpoint is protected with JWT Auth, you have to specify the JWT Token here.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-rasa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-rasa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-rasa/lists"}