botbuilder-wit

botbuilder-wit

Node.js module that provides Wit.ai NLP integration for the Microsoft Bot Builder SDK, with built-in support for caching with Redis and Memcached.

Installation

npm install --save botbuilder-wit

General Usage

This package does not work with Wit.ai's Story feature. It was designed to be used in conjunction with the IntentDialog class.

const { IntentDialog } = require('botbuilder');
const WitRecognizer = require('botbuilder-wit');
const recognizer = new WitRecognizer('Wit.ai_access_token');
const intents = new IntentDialog({recognizers: [recognizer]});

intents.matches('intent.name', (session, args) => {...});
intents.onDefault(session => {...});

bot.dialog('/', intents)

Enable Response Caching

The response object from Wit.ai can easily be cached with Redis or Memcached.

// Create a Redis client...
const redis = require('redis');
const redisClient = redis.createClient(options);

// Or Memcached client
const Memcached = require('memcached');
const memcached = new Memcached('hostname:11211');

// Configure the recognizer to use the client
// Set an optional key expire duration in seconds, defaults to 3 hours
const recognizer = new WitRecognizer('Wit.ai_access_token', { cache: redisClient, expire: 3600 });

Using Entities

You can use the utility class EntityRecognizer to parse & resolve common entities.

// Inside your dialog handler that receives the session and arguments object
const { EntityRecognizer } = require('botbuilder');
const location = EntityRecognizer.findEntity(args.entities, 'location')

Using the Wit.ai client

You can still use the Wit.ai client directly by accessing the witClient property of the instantiated WitRecognizer.

const recognizer = new WitRecognizer('Wit.ai_access_token');
const witClient = recognizer.witClient;

Recompiling the TypeScript source

If you want to recompile the source, you will need to make sure the node-wit dependency has a type definitions file in its root directory. Even though there is a TypeScript definitions package for node-wit you can install with npm install --save-dev @types/node-wit, the compiler will complain when using it. So instead, you can use the minimalistic version in the resources directory that will do the job.

License

MIT