https://github.com/codeforequity-at/botium-connector-luis
Botium Connector for Microsoft LUIS
https://github.com/codeforequity-at/botium-connector-luis
Last synced: about 1 year ago
JSON representation
Botium Connector for Microsoft LUIS
- Host: GitHub
- URL: https://github.com/codeforequity-at/botium-connector-luis
- Owner: codeforequity-at
- License: mit
- Created: 2019-01-28T09:32:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-28T11:17:40.000Z (over 1 year ago)
- Last Synced: 2025-04-12T19:04:34.078Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.botium.at
- Size: 208 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Botium Connector for Microsoft LUIS
[](https://nodei.co/npm/botium-connector-luis/)
[](https://app.codeship.com/projects/325831)
[](https://badge.fury.io/js/botium-connector-luis)
[]()
This is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your Microsoft LUIS intent resolution logic.
**UPDATE 2020/06/15:** As Chatbots grow in importance, automated testing solutions will remain critical for ensuring that Chatbots actually do what their designers intend. We've been busy working on a product that allows testers to have visual insights and deeper understanding in their Chatbot's performance, offering several solutions to boost their interaction!
[Botium Coach will be introduced to the market as part of our online event on the 24th of June.](https://www.botium.ai/coach/)
[](http://www.youtube.com/watch?v=WsNaDfZ7WHk "Botium Coach is coming on 24th of June")
__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!__
## How it works
LUIS is just a stateless NLP. It does send answer, just returns intent, entities.
So you are not able to test the answers, as for a chatbot engine.
But you can check intent, and entities, and use other [asserter and logic hook](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting#asserters-and-logic-hooks).
You can assert composite entities too:
```
INTENT .
```
It can be used as any other Botium connector with all Botium Stack components:
* [Botium CLI](https://github.com/codeforequity-at/botium-cli/)
* [Botium Bindings](https://github.com/codeforequity-at/botium-bindings/)
* [Botium Box](https://www.botium.at)
## Prerequisites
* __Node.js and NPM__
* [LUIS account](https://www.luis.ai/home)
* LUIS project (Just to try this connector you can use public IoT project from Microsoft used for the [interactive demonstration](https://azure.microsoft.com/en-us/services/cognitive-services/language-understanding-intelligent-service/))
* Application ID
* Open your project, then go to Manage, Application Information, Application ID
* The Id for the public IoT project is df67dcdb-c37d-46af-88e1-8b97951ca1c2
* LUIS key
* [authoring key](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/luis-get-started-node-get-intent#get-luis-key) (up to 1000 queries to the prediction endpoint API per month for all your LUIS apps)
* [subscription keys](https://docs.microsoft.com/en-us/azure/cognitive-services/LUIS/luis-how-to-azure-subscription) (Azure account required, free tier possible)
* a __project directory__ on your workstation to hold test cases and Botium configuration
## Install Botium and Microsoft LUIS Connector
When using __Botium CLI__:
```
> npm install -g botium-cli
> npm install -g botium-connector-luis
> botium-cli init
> botium-cli run
```
When using __Botium Bindings__:
```
> npm install -g botium-bindings
> npm install -g botium-connector-luis
> botium-bindings init mocha
> npm install && npm run mocha
```
When using __Botium Box__:
_Already integrated into Botium Box, no setup required_
## Connecting Microsoft Luis to Botium
Create a botium.json with Application ID, and LUIS key:
```javascript
{
"botium": {
"Capabilities": {
"PROJECTNAME": "Botium Project LUIS",
"CONTAINERMODE": "luis",
"LUIS_APP_ID": "xxx",
"LUIS_ENDPOINT_KEY": "xxx"
}
}
}
```
Botium setup is ready, you can begin to write your [BotiumScript](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.
## How to start sample
There is a small demo in [samples/IoT dir](./samples/IoT) with Botium Bindings. This tests the public IoT project.
So to start it you have to add your authoring key to the _botium.json_ file. Afterwards:
> npm install
> npm test
## Additional Input Parameters
#begin
UPDATE_CUSTOM LUIS_PARAM|spellCheck|true
## Supported Capabilities
Set the capability __CONTAINERMODE__ to __luis__ to activate this connector.
### LUIS_API_VERSION
V2 or V3
### LUIS_PREDICTION_ENDPOINT_URL
_Default: https://westus.api.cognitive.microsoft.com_
### LUIS_PREDICTION_ENDPOINT_SLOT
_Default: staging_
Possible values:
* staging
* production
### LUIS_PREDICTION_STATIC_PARAMS
Static parameters to add as endpoint url query parameters
"LUIS_PREDICTION_STATIC_PARAMS": {
"spellCheck": "true",
"verbose": "true"
}
### LUIS_APP_ID
See Prerequisites
### LUIS_ENDPOINT_KEY
See Prerequisites
### LUIS_AUTHORING_KEY
Required for test set upload/download