0.1.0 • Published 2 years ago

botium-connector-nlpjs v0.1.0

Weekly downloads
7
License
MIT
Repository
github
Last release
2 years ago

Botium Connector for NLP.js

NPM

Codeship Status for codeforequity-at/botium-connector-nlpjs npm version license

This is a Botium connector for testing your NLP.js models.

Did you read the Botium in a Nutshell 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 to load an existing model file from disc.

It can be used as any other Botium connector with all Botium Stack components:

This connector processes info about NLP, so Intent/Entity asserters 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 how to install a connector to Botium Box.

How to start sample

There is a small demo in samples/hello dir 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