Skip to content

Commit

Permalink
update README with new version
Browse files Browse the repository at this point in the history
  • Loading branch information
l5t committed May 17, 2016
1 parent 0c08ad1 commit 6c1b4eb
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,47 @@ See `examples` folder for more examples.

## API

### Version change

On 2016, May 11th, the /message API was updated to reflect the new Bot Engine model: intent are now entities.
We updated the SDK to the latest [version parameter](https://github.com/wit-ai/node-wit/blob/master/lib/wit.js#L11)

```json
{
"msg_id" : "e86468e5-b9e8-4645-95ce-b41a66fda88d",
"_text" : "hello",
"entities" : {
"intent" : [ {
"confidence" : 0.9753469589149633,
"value" : "greetings"
} ]
}
}
```

Version prior to 20160511 will return the old format

```json
{
"msg_id" : "722fc79b-725c-4ca1-8029-b7f57ff88f54",
"_text" : "hello",
"outcomes" : [ {
"_text" : "hello",
"confidence" : null,
"intent" : "default_intent",
"entities" : {
"intent" : [ {
"confidence" : 0.9753469589149633,
"value" : "greetings"
} ]
}
} ],
"WARNING" : "DEPRECATED"
}
```



### Overview

The Wit module provides a Wit class with the following methods:
Expand Down

0 comments on commit 6c1b4eb

Please sign in to comment.