UNPKG

chatbot-constructor

Version:

A chatbot constructor/builder that can help you develop chatbots in no time either using javascript and nodejs or without programming using excel sheet or JSON format. And it can also easily integrate with AI services like LUIS, Watson, Lex, Octane.AI, Wi

220 lines (169 loc) 7.12 kB
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ______ ______ ______ __ __ __ ______ /\ == \ /\ __ \ /\__ _\ /\ \/ / /\ \ /\__ _\ \ \ __< \ \ \/\ \ \/_/\ \/ \ \ _"-. \ \ \ \/_/\ \/ \ \_____\ \ \_____\ \ \_\ \ \_\ \_\ \ \_\ \ \_\ \/_____/ \/_____/ \/_/ \/_/\/_/ \/_/ \/_/ This is a sample Console bot built with Botkit. This bot demonstrates many of the core features of Botkit: * Receive messages based on "spoken" patterns * Reply to messages * Use the conversation system to ask questions * Use the built in storage system to store and retrieve information for a user. # RUN THE BOT: Run your bot from the command line: node console_bot.js # USE THE BOT: Say: "Hello" The bot will reply "Hello!" Say: "who are you?" The bot will tell you its name, where it is running, and for how long. Say: "Call me <nickname>" Tell the bot your nickname. Now you are friends. Say: "who am I?" The bot will tell you your nickname, if it knows one for you. Say: "shutdown" The bot will ask if you are sure, and then shut itself down. Make sure to invite your bot into other channels using /invite @<my bot>! # EXTEND THE BOT: Botkit has many features for building cool and useful bots! Read all about it here: -> http://howdy.ai/botkit ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/ var Botkit = require('./lib/Botkit.js'); var os = require('os'); var controller = Botkit.consolebot({ debug: false, }); var bot = controller.spawn(); controller.hears(['hello', 'hi'], 'message_received', function(bot, message) { controller.storage.users.get(message.user, function(err, user) { if (user && user.name) { bot.reply(message, 'Hello ' + user.name + '!!'); } else { bot.reply(message, 'Hello.'); } }); }); controller.hears(['call me (.*)', 'my name is (.*)'], 'message_received', function(bot, message) { var name = message.match[1]; controller.storage.users.get(message.user, function(err, user) { if (!user) { user = { id: message.user, }; } user.name = name; controller.storage.users.save(user, function(err, id) { bot.reply(message, 'Got it. I will call you ' + user.name + ' from now on.'); }); }); }); controller.hears(['what is my name', 'who am i'], 'message_received', function(bot, message) { controller.storage.users.get(message.user, function(err, user) { if (user && user.name) { bot.reply(message, 'Your name is ' + user.name); } else { bot.startConversation(message, function(err, convo) { if (!err) { convo.say('I do not know your name yet!'); convo.ask('What should I call you?', function(response, convo) { convo.ask('You want me to call you `' + response.text + '`?', [ { pattern: 'yes', callback: function(response, convo) { // since no further messages are queued after this, // the conversation will end naturally with status == 'completed' convo.next(); } }, { pattern: 'no', callback: function(response, convo) { // stop the conversation. this will cause it to end with status == 'stopped' convo.stop(); } }, { default: true, callback: function(response, convo) { convo.repeat(); convo.next(); } } ]); convo.next(); }, {'key': 'nickname'}); // store the results in a field called nickname convo.on('end', function(convo) { if (convo.status == 'completed') { bot.reply(message, 'OK! I will update my dossier...'); controller.storage.users.get(message.user, function(err, user) { if (!user) { user = { id: message.user, }; } user.name = convo.extractResponse('nickname'); controller.storage.users.save(user, function(err, id) { bot.reply(message, 'Got it. I will call you ' + user.name + ' from now on.'); }); }); } else { // this happens if the conversation ended prematurely for some reason bot.reply(message, 'OK, nevermind!'); } }); } }); } }); }); controller.hears(['shutdown'], 'message_received', function(bot, message) { bot.startConversation(message, function(err, convo) { convo.ask('Are you sure you want me to shutdown?', [ { pattern: bot.utterances.yes, callback: function(response, convo) { convo.say('Bye!'); convo.next(); setTimeout(function() { process.exit(); }, 3000); } }, { pattern: bot.utterances.no, default: true, callback: function(response, convo) { convo.say('*Phew!*'); convo.next(); } } ]); }); }); controller.hears(['uptime', 'identify yourself', 'who are you', 'what is your name'], 'direct_message,direct_mention,mention', function(bot, message) { var hostname = os.hostname(); var uptime = formatUptime(process.uptime()); bot.reply(message, ':robot_face: I am a bot named <@' + bot.identity.name + '>. I have been running for ' + uptime + ' on ' + hostname + '.'); }); function formatUptime(uptime) { var unit = 'second'; if (uptime > 60) { uptime = uptime / 60; unit = 'minute'; } if (uptime > 60) { uptime = uptime / 60; unit = 'hour'; } if (uptime != 1) { unit = unit + 's'; } uptime = uptime + ' ' + unit; return uptime; }