ganadiniakshay / apiairecognizer

NPM module to use api.ai instead of luis.ai for Microsoft Bot Framework

Dialogflow(API.ai) Recoginzer for Microsoft Bot Framework

Installation

npm install api-ai-recognizer

Usage

var builder = require('botbuilder');  
var connector = new builder.ConsoleConnector().listen();  

var bot = new builder.UniversalBot(connector);  

var apiairecognizer = require('api-ai-recognizer');  
var recognizer      = new apiairecognizer(<api.ai client access token>);  

var intents = new builder.IntentDialog({  
    recognizers: [recognizer];  
});  

bot.dialog('/',intents);  

intents.matches('intent.name',function(session,args){  
    session.send("your response");  
});

Using Entities

Entities can be found in the args.entities object and can be retrieved using code like below:

var city = builder.EntityRecognizer.findEntity(args.entities, 'city');  

The schema for each entity retrieved with the about method is as below:

 {
    "entity"    : "entity value",  
    "type"      : "entity name",   
    "startIndex": "start index of entity",   
    "endIndex"  : "end index of entity",  
    "score"     : 1   
 }

Using Fulfillment

Dialogflow(api.ai) provides fulfillment which can be useful if you are using domains for your chat agent

Fulfillments are available as entitities with the entity name as fulfillment and can be used like below:

var fulfillment = builder.EntityRecognizer.findEntity(args.entities, 'fulfillment');  
if (fulfillment) {  
  var speech = fulfillment.entity;
  session.send(speech);  
}

Using Prompts

You can use prompts provided by Dialogflow(api.ai) for required entities very easily. Just check the actionIncomplete entity from
the entities list and if its true use the fulfillment to send out the prompt.

var incomplete = builder.EntityRecognizer.findEntity(args.entities, 'actionIncomplete');
if (incomplete){
    var fulfillment = builder.EntityRecognizer.findEntity(args.entities, 'fulfillment');  
    if (fulfillment) {  
      var speech = fulfillment.entity;
      session.send(speech);  
    }
}

Added functionaliy

onEnabled() function has been added.

Contributing

All feature requests, bug reprorts and pull requests are welcome!

License

MIT

apiairecognizer's Issues

Is there a way to activate custom events using this API?

Is there a way to activate custom events in API.ai using this API?

"Using Prompts" example missing

On Using Prompts section, do you say:

You can use prompts provided by api.ai for required entities very easily. Just check the actionIncomplete entity from the entities list and if its true use the fulfillment to send out the prompt.

do you have a example?

Thank You

just wanted to give you a headsup, i searched for api.ai on botbuilder repo and came across your open issue. I quickly came to your GitHub profile and saw the api.ai module for botframework 👍 Testing now

sessionId exceeding 36 characters

Line 12 - 16 index.js --- there is no length check on sessionId. Sometimes channel_id+user_id > 36 characters, which causes api.ai to error out. One such scenario is when your client is Cortana. Requests from Cortana are failing for sessionId > 36 characters.

What is the right way to handle default intents?

Hi there,
According to docs, if we need to match an intent and respond acc to that then, we can do something like this

intents.matches('intent.name',function(session,args){  
    session.send("your response");  
});

But i just want to declare something like a default intent match so it can just push the default response coming from DialogFlow. So can anyone tell me the right procedure to do it? If no intent matches then bot should use that default one. Thanks in advance.

Api.ai actions missing

"Action" is very important feature to work with.
Please add it to the api.ai recognizer version.
For me, if you could pass the all json result from api.ai it could be just fine.
Thanks, you did great job there.

session id static

var request = this.app.textRequest(context.message.text.toLowerCase(),{sessionId: 'kjfgwsjhedfcb281908'})

this needs to dynamic instead of a static hard coded value

Smalltalk intents don't work

Due to changes on api.ai side the old method of handling api.ai doesn't work

Doesn't pass account_linking messages