wit-node

wit-node: Easy interface for wit.ai natural language parsing

npm install wit-node
6 downloads in the last day
7 downloads in the last week
26 downloads in the last month

wit-node

Easy interface for interacting with the Wit.ai natural language parsing API.

This project will expand as the Wit.ai API expands, but as it stands there's a single endpoint. You can hit this endpoint easily with Wit.message([your message]), which uses Wit.ai to convert that phrase or sentence into an object with an intent and entities if any were specified.

You will need to create a Wit.ai account and begin training it.

Installation

npm install wit-node@">=0.0.2"

You'll need to set an environment variable named WIT_TOKEN or specify your token with Wit.token = [your token].

export WIT_TOKEN=[your token]

Usage

Wit uses Q for promises, so the interface is nice and clean and reliable.

var promise = Wit.message('Hi')
promise.then(function(result) {
  result.intent // will be Hello with the default Wit instance.
  result.confidence // will be relatively low initially.
})

Result properties/methods

raw
Raw response object (parsed JSON)
msgId
The unique message id provided back from Wit.
msgBody
The original message sent.
intent
The intent, as determined by Wit.
confidence
The confidence level that Wit determined.
entities
Object of entities, which contain the value, and the start/end position within msgBody.

Entity properties/methods

value
The value as determined by Wit (might not be the same as body).
start
The start position index from msgBody.
end
The end position index from msgBody.
body
The actual value as specified in msgBody.

License

Licensed under the MIT License

Copyright 2012 Mode Set

Make Code Not War

crest

npm loves you