https://github.com/codeforequity-at/botium-connector-nlpjs
Botium Connector for NLP.js
https://github.com/codeforequity-at/botium-connector-nlpjs
Last synced: about 1 year ago
JSON representation
Botium Connector for NLP.js
- Host: GitHub
- URL: https://github.com/codeforequity-at/botium-connector-nlpjs
- Owner: codeforequity-at
- License: mit
- Created: 2019-12-01T18:15:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-03T08:33:24.000Z (over 3 years ago)
- Last Synced: 2025-03-24T06:17:30.530Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.botium.at
- Size: 24.4 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Botium Connector for NLP.js
[](https://nodei.co/npm/botium-connector-nlpjs/)
[](https://app.codeship.com/projects/376435)
[](https://badge.fury.io/js/botium-connector-nlpjs)
[]()
This is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your [NLP.js](https://github.com/axa-group/nlp.js) models.
__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 uses the [NLP Manager](https://github.com/axa-group/nlp.js/blob/master/docs/nlp-manager.md) to load an existing model file from disc.
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)
This connector processes info about NLP, so [Intent/Entity asserters](https://botium.atlassian.net/wiki/spaces/BOTIUM/pages/17334319/NLP+Asserter+Intents+Entities+Confidence) can be used (see samples).
## Requirements
* **Node.js and NPM**
* a **an NLP.js model**
* a **project directory** on your workstation to hold test cases and Botium configuration
## Install Botium and NLP.js Connector
When using __Botium CLI__:
```
> npm install -g botium-cli
> npm install -g botium-connector-nlpjs
> botium-cli init
> botium-cli run
```
When using __Botium Bindings__:
```
> npm install -g botium-bindings
> npm install -g botium-connector-nlpjs
> botium-bindings init mocha
> npm install && npm run mocha
```
When using __Botium Box__:
See [Botium Wiki](https://botium.atlassian.net/wiki/spaces/BOTIUM/pages/38502401/Howto+develop+your+own+Botium+connector#Using-custom-connector-with-Botium-Box) how to install a connector to Botium Box.
## How to start sample
There is a small demo in [samples/hello dir](./samples/hello) with Botium Bindings. A simple NLP.js model is trained and used in the tests:
```
> cd ./samples/hello
> npm install && npm run train && npm test
```
## Supported Capabilities
Set the capability __CONTAINERMODE__ to __npmjs__ to activate this connector.
### NLPJS_LANGUAGE
_Default: en_
Language code of your model and your test cases
### NLPJS_MODEL_CONTENT
Precompiled exported NLP.js model
### NLPJS_MODEL_FILE
Filename to load the NLP.js model from
### NLPJS_MODEL_QNAFILE
QNA File to import
### NLPJS_MODEL_QNACONTENT
QNA Content to import
### NLPJS_MODEL_QNASEPARATOR
_Default: \t_
QNA content separator