https://github.com/codeforequity-at/botium-connector-witai
Botium Connector for wit.ai
https://github.com/codeforequity-at/botium-connector-witai
Last synced: about 1 year ago
JSON representation
Botium Connector for wit.ai
- Host: GitHub
- URL: https://github.com/codeforequity-at/botium-connector-witai
- Owner: codeforequity-at
- License: mit
- Created: 2019-09-10T18:56:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-08T16:40:18.000Z (over 6 years ago)
- Last Synced: 2025-03-29T22:41:18.894Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.botium.at
- Size: 16.6 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Botium Connector for for wit.ai
[](https://nodei.co/npm/botium-connector-witai/)
[](https://app.codeship.com/projects/356365)
[](https://badge.fury.io/js/botium-connector-witai)
[]()
This is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your wit.ai projects.
__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
Botium connects to your wit.ai using its [Wit Node.js SDK](https://github.com/wit-ai/node-wit). It extracts the NLP information for using with Botium and it's NLP asserters.
You can assert composite entities too:
```
INTENT .
```
or just
```
INTENT
```
and
```
INTENT_CONFIDENCE
```
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)
## Requirements
* **Node.js and NPM**
* a **wit.ai** app
* a **project directory** on your workstation to hold test cases and Botium configuration
## Install Botium and wit.ai Connector
When using __Botium CLI__:
```
> npm install -g botium-cli
> npm install -g botium-connector-witai
> botium-cli init
> botium-cli run
```
When using __Botium Bindings__:
```
> npm install -g botium-bindings
> npm install -g botium-connector-witai
> botium-bindings init mocha
> npm install && npm run mocha
```
When using __Botium Box__:
_Already integrated into Botium Box, no setup required_
## Connecting wit.ai app to Botium
Process is very simple, you just need the wit.ai server access token. After creating your app, you can find your access token in the app's Settings tab.
Create a botium.json with this URL in your project directory:
```
{
"botium": {
"Capabilities": {
"PROJECTNAME": "",
"CONTAINERMODE": "witai",
"WITAI_TOKEN": "..."
}
}
}
```
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](./samples) with Botium Bindings.
Install the packages, and run the test:
```
> cd ./samples/
> npm install && npm test
```
## Supported Capabilities
Set the capability __CONTAINERMODE__ to __witai__ to activate this connector.
### WITAI_TOKEN
Get it from the app's Settings tab in the wit.ai console
### WITAI_CONTEXT
_Default: empty_
Context JSON object for wit.ai, see [here](https://wit.ai/docs/http/20170307#context_link) for details and format.
### WITAI_APIVERSION
_Default: empty_
The API version to use instead of the recommended one
## Open Issues and Restrictions
* For wit.ai the entity role is an alias for name. You can assert an entity just with alias:
```
INTENT
```
* If wit.ai does not recognizes any intent (utterance is not recognized, or utterance has no intent) then Botium will add a none intent:
```
INTENT none
```
* wit.ai supports more intents for a utterance, but Botium does not.