├── .gitignore ├── LICENSE ├── README.md ├── chatbot.iml ├── css ├── chatbot.css └── chatbot.min.css ├── demo ├── demo-ddg.html └── demo-webknox.html ├── img └── spoonacular-chatbot-animation.gif ├── js ├── chatbot.js └── chatbot.min.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | raw/ 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # chatbot 2 | A simple chat bot in JavaScript with links to smart conversational APIs such as [WebKnox](https://webknox.com/api) (all purpose question answering), [spoonacular](https://spoonacular.com/food-api) (food related conversations), and [DuckDuckGo Instant Answers](https://duckduckgo.com/api) (mostly entities like movies, people, and places). 3 | 4 | ## Demo 5 | 6 | Take a look at the JavaScript Chat Bot using the Duck Duck Go Engine: [DDG Demo](http://rawgit.com/ddsky/chatbot/master/demo/demo-ddg.html) 7 | 8 | This Bot is more advanced using the WebKnox Engine (API key needed): [WebKnox Demo](http://rawgit.com/ddsky/chatbot/master/demo/demo-webknox.html) 9 | 10 | Here a quick demonstration of the chatbot using the spoonacular conversation engine: 11 | ![spoonacular chatbot](img/spoonacular-chatbot-animation.gif) 12 | 13 | ## Set up HTML 14 | ```html 15 |
16 | 17 |
18 |
19 |
20 |
21 | ``` 22 | 23 | ## Sample Usage 24 | 25 | Initialize the bot. That is all you need to get a working chatbot. 26 | 27 | ```javascript 28 | // initialize the bot 29 | var config = { 30 | // what inputs should the bot listen to? this selector should point to at least one input field 31 | inputs: '#humanInput', 32 | // if you want to show the capabilities of the bot under the search input 33 | inputCapabilityListing: true, 34 | // optionally, you can specify which conversation engines the bot should use, e.g. webknox, spoonacular, or duckduckgo 35 | engines: [ChatBot.Engines.duckduckgo()], 36 | // you can specify what should happen to newly added messages 37 | addChatEntryCallback: function(entryDiv, text, origin) { 38 | entryDiv.slideDown(); 39 | } 40 | }; 41 | ChatBot.init(config); 42 | ``` 43 | 44 | Optionally, give your bot a name. 45 | ```javascript 46 | ChatBot.setBotName("bender"); 47 | ``` 48 | 49 | You can now also manually define some patterns that the bot should be able to react to. 50 | ```javascript 51 | // 1. parameter: the pattern to listen for 52 | // 2. parameter: either "response" to respond or "rewrite" to rewrite the request 53 | // 3. parameter: either the response or the rewrite value, or undefined if nothing should happen 54 | // 4. parameter: a callback function that gets the matches of the pattern 55 | // 5. parameter: a description of that pattern, this is used to tell the user what he can say. Use quotes '' to mark phrases and [] to mark placeholders 56 | ChatBot.addPattern( 57 | "(?:my name is|I'm|I am) (.*)", 58 | "response", 59 | "Hi $1, thanks for talking to me today", 60 | function(matches){ 61 | ChatBot.setHumanName(matches[1]); 62 | }, 63 | "Say 'My name is [name]' to be called by your name." 64 | ); 65 | 66 | ChatBot.addPattern("^hi$","response","Howdy my friend", undefined, "Say 'Hi' to be greeted."); 67 | 68 | ChatBot.addPattern( 69 | "compute ([0-9]+) plus ([0-9]+)", 70 | "response", 71 | undefined, 72 | function (matches) { 73 | ChatBot.addChatEntry("That would be "+(1*matches[1]+1*matches[2])+".","bot"); 74 | }, 75 | "Say 'compute [number] plus [number]' to make the bot your math monkey" 76 | ); 77 | ``` 78 | 79 | How about you let your bot show its capabilities with a sample conversation? 80 | ```javascript 81 | var sampleConversation = [ 82 | "Hi", 83 | "My name is Botty McBotface", 84 | "Bye" 85 | ]; 86 | 87 | // play the conversation, second parameter is the pause between the inputs in milliseconds 88 | ChatBot.playConversation(sampleConversation,4000) 89 | ``` 90 | 91 | You can also write your own answer engines, just implement the `react`, `getCapabilities`, and `getSuggestUrl` methods. Here's a template: 92 | ```javascript 93 | var myengine = function() { 94 | 95 | var capabilities = [ 96 | "If you say 'hip hip', the bot says hooray" 97 | ] 98 | 99 | return { 100 | react: function (query) { 101 | 102 | var content = ''; 103 | if (query == 'hip hip') { 104 | content = 'hooray'; 105 | } 106 | 107 | ChatBot.addChatEntry(content, "bot"); 108 | ChatBot.thinking(false); 109 | 110 | }, 111 | getCapabilities: function() { 112 | return capabilities; 113 | }, 114 | getSuggestUrl: function() { 115 | return 'https://yourserver/uniboxSuggests?query='; 116 | } 117 | } 118 | }(); 119 | ``` 120 | 121 | 122 | -------------------------------------------------------------------------------- /chatbot.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /css/chatbot.css: -------------------------------------------------------------------------------- 1 | .chatBotChatEntry { 2 | padding: 20px; 3 | background-color: #fff; 4 | border: none; 5 | margin-top: 5px; 6 | font-family: 'open_sanslight', sans-serif !important; 7 | font-size: 17px; 8 | font-weight: normal; 9 | } 10 | 11 | .chatBotChatEntry * { 12 | font-family: 'open_sanslight', sans-serif !important; 13 | font-size: 17px; 14 | font-weight: normal; 15 | } 16 | 17 | .chatBotChatEntry .origin { 18 | font-weight: bold; 19 | margin-right: 10px; 20 | } 21 | .chatBotChatEntry .imgBox { 22 | position: relative; 23 | width: 32%; 24 | display: inline-block; 25 | margin-top: 10px; 26 | margin-right: 10px; 27 | height: 218px; 28 | overflow: hidden; 29 | } 30 | .chatBotChatEntry .imgBox .actions .button { 31 | margin-top: 10px; 32 | font-size: 18px; 33 | padding: 5px; 34 | width: 50%; 35 | } 36 | .chatBotChatEntry .imgBox .actions { 37 | position: absolute; 38 | display: none; 39 | top: 31px; 40 | width: 100%; 41 | text-align: center; 42 | } 43 | .chatBotChatEntry .imgBox:hover .actions { 44 | display: block; 45 | } 46 | .chatBotChatEntry .imgBox .title { 47 | position: absolute; 48 | bottom: 0; 49 | left: 0; 50 | width: 100%; 51 | padding: 5px; 52 | color: #fff; 53 | background-color: #333; 54 | font-weight: normal; 55 | font-size: 16px; 56 | } 57 | 58 | .chatBotChatEntry .imgBox img { 59 | width: 100%; 60 | } 61 | 62 | .bot { 63 | /*border: 4px solid rgba(0, 132, 60, 0.2);*/ 64 | background-color: rgba(0, 132, 60, 0.2); 65 | } 66 | .human { 67 | /*border: 4px solid rgba(38, 159, 202, 0.2);*/ 68 | background-color: rgba(38, 159, 202, 0.2); 69 | } 70 | 71 | #chatBotCommandDescription { 72 | background-color: #333; 73 | color: #fff; 74 | padding: 20px; 75 | } 76 | .commandDescription span.phraseHighlight { 77 | color: chartreuse; 78 | } 79 | .commandDescription span.placeholderHighlight { 80 | color: deeppink; 81 | } 82 | .commandDescription { 83 | margin-top: 5px; 84 | } 85 | 86 | #chatBotConversationLoadingBar { 87 | background-color: darkcyan; 88 | height: 2px; 89 | width: 0; 90 | } 91 | 92 | .appear { 93 | animation-duration: 0.2s; 94 | animation-name: appear; 95 | animation-iteration-count: 1; 96 | animation-timing-function: ease-out; 97 | animation-fill-mode: forwards; 98 | } 99 | 100 | @keyframes appear { 101 | from { 102 | opacity: 0; 103 | } 104 | 105 | to { 106 | opacity: 1; 107 | } 108 | } -------------------------------------------------------------------------------- /css/chatbot.min.css: -------------------------------------------------------------------------------- 1 | .chatBotChatEntry{padding:20px;background-color:#fff;border:0;margin-top:5px;font-family:'open_sanslight',sans-serif !important;font-size:17px;font-weight:normal}.chatBotChatEntry *{font-family:'open_sanslight',sans-serif !important;font-size:17px;font-weight:normal}.chatBotChatEntry .origin{font-weight:bold;margin-right:10px}.chatBotChatEntry .imgBox{position:relative;width:32%;display:inline-block;margin-top:10px;margin-right:10px;height:218px;overflow:hidden}.chatBotChatEntry .imgBox .actions .button{margin-top:10px;font-size:18px;padding:5px;width:50%}.chatBotChatEntry .imgBox .actions{position:absolute;display:none;top:31px;width:100%;text-align:center}.chatBotChatEntry .imgBox:hover .actions{display:block}.chatBotChatEntry .imgBox .title{position:absolute;bottom:0;left:0;width:100%;padding:5px;color:#fff;background-color:#333;font-weight:normal;font-size:16px}.chatBotChatEntry .imgBox img{width:100%}.bot{background-color:rgba(0,132,60,0.2)}.human{background-color:rgba(38,159,202,0.2)}#chatBotCommandDescription{background-color:#333;color:#fff;padding:20px}.commandDescription span.phraseHighlight{color:chartreuse}.commandDescription span.placeholderHighlight{color:deeppink}.commandDescription{margin-top:5px}#chatBotConversationLoadingBar{background-color:darkcyan;height:2px;width:0}.appear{animation-duration:.2s;animation-name:appear;animation-iteration-count:1;animation-timing-function:ease-out;animation-fill-mode:forwards}@keyframes appear{from{opacity:0}to{opacity:1}} -------------------------------------------------------------------------------- /demo/demo-ddg.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Javascript Chat Bot Demo 7 | 53 | 54 | 55 | 56 | 57 | 58 | 59 |
60 |
61 | 62 | 63 |
Play sample conversation!
64 |
What can I say?
65 | 66 |
 
67 | 68 |
69 |
70 |
71 |
72 |
73 | 74 | 75 | 108 | 109 | -------------------------------------------------------------------------------- /demo/demo-webknox.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Javascript Chat Bot Demo 9 | 55 | 56 | 57 | 58 | 59 | 60 | 61 |
62 |

For this demo you need a mashape API key for the WebKnox Question Answering API.

63 | 64 |
65 | 66 | 67 |
Play sample conversation!
68 |
What can I say?
69 | 70 |
 
71 | 72 |
73 |
74 |
75 |
76 |
77 | 78 | 79 | 123 | 124 | -------------------------------------------------------------------------------- /img/spoonacular-chatbot-animation.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ddsky/chatbot/104ef491b3a42d2a3b547e1ed2c07a7ef1dcc497/img/spoonacular-chatbot-animation.gif -------------------------------------------------------------------------------- /js/chatbot.js: -------------------------------------------------------------------------------- 1 | var ChatBot = function () { 2 | 3 | //// common vars 4 | // custom patterns and rewrites 5 | var patterns; 6 | 7 | // the bot's name 8 | var botName; 9 | 10 | // the human's name 11 | var humanName; 12 | 13 | // the html (text / image etc.) that is displayed when the bot is busy 14 | var thinkingHtml; 15 | 16 | // a selector to all inputs the human can type to 17 | var inputs; 18 | 19 | // whether to list the capabilities below the input field 20 | var inputCapabilityListing; 21 | 22 | // the example phrases that can be said (to be listed under the input field) 23 | var examplePhrases = []; 24 | 25 | // the engines to use for answering queries that are not caught by simple patterns 26 | var engines; 27 | 28 | // whether a sample conversation is running 29 | var sampleConversationRunning = false; 30 | 31 | // a callback for after a chat entry has been added 32 | var addChatEntryCallback; 33 | 34 | // list of normalize human text before check pattern 35 | var normalizer = []; 36 | 37 | // list all the predefined commands and the commands of each engine 38 | function updateCommandDescription() { 39 | var description = ''; 40 | 41 | // first explain manually defined commands and then all by all used engines 42 | var descriptions = []; 43 | 44 | var i, j; 45 | for (i = 0; i < patterns.length; i++) { 46 | if (patterns[i].description != undefined) { 47 | descriptions.push(patterns[i].description); 48 | } 49 | } 50 | for (i = 0; i < engines.length; i++) { 51 | var caps = engines[i].getCapabilities(); 52 | for (j = 0; j < caps.length; j++) { 53 | descriptions.push(caps[j]); 54 | } 55 | } 56 | 57 | examplePhrases = []; 58 | for (i = 0; i < descriptions.length; i++) { 59 | var pdesc = descriptions[i].replace(/(['"][^'"]+['"])/gi, '$1'); 60 | pdesc = pdesc.replace(/(\[[^\[\]]+\])/gi, '$1'); 61 | //console.log(pdesc); 62 | var matches = pdesc.match(/['"](.+?)['"]<\/span>/gi); 63 | //console.log(matches); 64 | if (matches != null) { 65 | //console.log(matches); 66 | for (j = 0; j < matches.length; j++) { 67 | var cleanMatch = matches[j].replace(/<\/?span[^>]*>/gi,''); 68 | examplePhrases.push(cleanMatch.replace(/['"]/gi,'')); 69 | } 70 | } 71 | description += '
' + pdesc + '
'; 72 | } 73 | 74 | var datalist = $('#chatBotCommands'); 75 | if (datalist.size() == 0) { 76 | datalist = $(''); 77 | $('body').append(datalist); 78 | } else { 79 | datalist.html(''); 80 | } 81 | 82 | for (i = 0; i < examplePhrases.length; i++) { 83 | datalist.append($('')); 84 | } 85 | 86 | //console.log(examplePhrases); 87 | 88 | $('#chatBotCommandDescription').html(description); 89 | } 90 | 91 | // type writer 92 | function playConversation(state, pauseLength) { 93 | 94 | setTimeout(function() { 95 | var newValue = ''; 96 | if ($(inputs).val() != '|') { 97 | newValue += $(inputs).val(); 98 | } 99 | newValue += state.currentInput.slice(state.start,state.start+1); 100 | $(inputs).val(newValue); 101 | state.start++; 102 | 103 | if (state.start < state.currentInput.length) { 104 | // keep typing 105 | playConversation(state, pauseLength); 106 | } else { 107 | 108 | // press enter and wait for some time and then write the next entry 109 | ChatBot.addChatEntry(state.currentInput, "human"); 110 | ChatBot.react(state.currentInput); 111 | $(inputs).val(state.currentInput); 112 | 113 | setTimeout(function() { 114 | state.conversationArrayIndex++; 115 | state.conversationArrayIndex = state.conversationArrayIndex % state.conversationArray.length; 116 | 117 | // did we cycle through the conversation array? if so, stop 118 | if (state.conversationArrayIndex == 0) { 119 | $('#chatBotConversationLoadingBar').remove(); 120 | sampleConversationRunning = false; 121 | return; 122 | } 123 | 124 | state.start = 0; 125 | $(inputs).val('|'); 126 | state.currentInput = state.conversationArray[state.conversationArrayIndex]; 127 | playConversation(state, pauseLength); 128 | }, pauseLength); 129 | 130 | var chclb = $('#chatBotConversationLoadingBar'); 131 | if (chclb.size() == 0) { 132 | chclb = $('
'); 133 | chclb.css('position','absolute'); 134 | $('body').append(chclb); 135 | } 136 | 137 | var left = $(inputs).offset().left; 138 | var top = $(inputs).offset().top + $(inputs).outerHeight() - 3; 139 | chclb.css('left',left+'px'); 140 | chclb.css('top',top+'px'); 141 | 142 | chclb.animate({ 143 | width: $(inputs).outerWidth()+'px', 144 | }, pauseLength, function() { 145 | chclb.css('width','0'); 146 | }); 147 | 148 | } 149 | }, Math.random()*120+10); 150 | } 151 | 152 | return { 153 | Engines: { 154 | // the webknox API: http://webknox.com/api 155 | webknox: function (apiKey) { 156 | 157 | // patterns that the engine can resolve 158 | var capabilities = [ 159 | "Ask for stock prices like 'stock price apple' or '[company] stock'.", 160 | "Ask for distances as in 'how far is Perth from Melbourne' or 'distance between [place1] and [place2]'.", 161 | "Want to know what the weather is like, just ask like 'weather in San Diego, California'.", 162 | "Let WebKnox tell you a joke, just say 'tell me a joke'.", 163 | "Convert units, e.g. '2.4 miles in kilometers' or '4 tablespoons to ml?'.", 164 | "Get synonyms for a word, e.g. 'synonyms for car'.", 165 | "Ask for quotes like 'quotes about [topic]' or 'quotes about love'.", 166 | "Ask for quotes from a person 'quotes by [person]' or 'quotes by aristotle'.", 167 | "Ask for recipes like 'spaghetti recipes' or 'chocolate donuts'.", 168 | "Ask for nutrient contents like 'vitamin a in 2 carrots' or 'calories is 1 cup of butter'.", 169 | "Convert ingredients like '2 cups of butter in grams'.", 170 | "If you want more results, just say 'more'.", 171 | "For more similar results say 'more like the first/second/third...'.", 172 | "Or just ask anything that comes to mind like 'Who was pope in 1499?' or 'Who directed braveheart?'.", 173 | ]; 174 | 175 | // the context id for the current conversation 176 | var contextId = Math.random() * 100000; 177 | 178 | return { 179 | react: function (query) { 180 | $.get('https://webknox-question-answering.p.mashape.com/questions/converse?mashape-key=' + apiKey + '&contextId=' + contextId + '&text=' + encodeURIComponent(query), function (data) { 181 | 182 | var content = data.answerText; 183 | 184 | if (data.media != undefined) { 185 | 186 | content += '
'; 187 | 188 | for (var i = 0; i < data.media.length; i++) { 189 | var ob = data.media[i]; 190 | content += '
' + 191 | '' + 192 | '
' + ob.title + '
' + 193 | '
' + 194 | '
Details
' + 195 | '
' + 196 | '
More like this
' + 197 | '
' + 198 | '
'; 199 | } 200 | 201 | } 202 | 203 | ChatBot.addChatEntry(content, "bot"); 204 | ChatBot.thinking(false); 205 | }); 206 | }, 207 | getCapabilities: function () { 208 | return capabilities; 209 | }, 210 | getSuggestUrl: function() { 211 | return 'https://webknox-question-answering.p.mashape.com/questions/converse/suggest?mashape-key=' + apiKey + '&query='; 212 | } 213 | } 214 | }, 215 | 216 | // the spoonacular API: http://spoonacular.com/food-api 217 | spoonacular: function (apiKey) { 218 | 219 | // patterns that the engine can resolve 220 | var capabilities = [ 221 | "Ask for recipes like 'chicken recipes' or 'spaghetti with shrimp'", 222 | "Ask for nutrient contents like 'vitamin a in 2 carrots' or 'calories is 1 cup of butter'", 223 | "Convert something with '2 cups of butter in grams'", 224 | "If you want more results, just say 'more'", 225 | "For more similar results say 'more like the first/second/third...'", 226 | "Let spoonacular tell you a joke, just say 'tell me a joke'.", 227 | "Want to learn some food trivia, just say 'food trivia'.", 228 | ]; 229 | 230 | // the context id for the current conversation 231 | var contextId = Math.random() * 100000; 232 | 233 | return { 234 | react: function (query) { 235 | $.get('https://spoonacular-recipe-food-nutrition-v1.p.mashape.com/food/converse?mashape-key=' + apiKey + '&contextId=' + contextId + '&text=' + encodeURIComponent(query), function (data) { 236 | 237 | var content = data.answerText; 238 | 239 | if (data.media != undefined) { 240 | 241 | content += '
'; 242 | 243 | for (var i = 0; i < data.media.length; i++) { 244 | var ob = data.media[i]; 245 | content += '
' + 246 | '' + 247 | '
' + ob.title + '
' + 248 | '
' + 249 | '
Details
' + 250 | '
' + 251 | '
More like this
' + 252 | '
' + 253 | '
'; 254 | } 255 | 256 | } 257 | 258 | ChatBot.addChatEntry(content, "bot"); 259 | ChatBot.thinking(false); 260 | }); 261 | }, 262 | getCapabilities: function () { 263 | return capabilities; 264 | }, 265 | getSuggestUrl: function() { 266 | return 'https://spoonacular-recipe-food-nutrition-v1.p.mashape.com/food/converse/suggest?mashape-key=' + apiKey + '&query='; 267 | } 268 | } 269 | }, 270 | 271 | duckduckgo: function () { 272 | 273 | // patterns that the engine can resolve 274 | var capabilities = [ 275 | "Ask what something is like 'What is DNA'?", 276 | "Ask where something is like 'Where is China'?", 277 | "Ask about a person like 'Who is Bill Gates'?", 278 | "Say a movie/person/location name like 'Braveheart' to get information about that entity", 279 | "Say a something like 'simpsons characters' to get information about that phrase", 280 | ]; 281 | 282 | return { 283 | react: function (query) { 284 | $.ajax({ 285 | type: 'GET', 286 | url: 'https://api.duckduckgo.com/?format=json&pretty=1&q=' + encodeURIComponent(query), 287 | dataType: 'jsonp' 288 | }).done(function (data) { 289 | 290 | var content = data.AbstractText; 291 | 292 | // no direct answer? tell about related topics then 293 | if (content == '' && data.RelatedTopics.length > 0) { 294 | 295 | content = '

I found multiple answers for you:

'; 296 | 297 | var media = []; 298 | for (var i = 0; i < data.RelatedTopics.length; i++) { 299 | var ob = data.RelatedTopics[i]; 300 | if (ob.Result == undefined) { 301 | continue; 302 | } 303 | if (ob.Icon.URL != '' && ob.Icon.URL.indexOf(".ico") < 0) { 304 | media.push(ob.Icon.URL); 305 | } 306 | 307 | content += '

' + ob.Result.replace("", " ") + '

'; 308 | } 309 | 310 | ///content += '' + 311 | 312 | for (i = 0; i < media.length; i++) { 313 | var m = media[i]; 314 | content += ''; 315 | } 316 | 317 | } else { 318 | 319 | if (data.Image != undefined && data.Image != '') { 320 | 321 | content += '
'; 322 | 323 | content += '
' + 324 | '' + 325 | '
' + data.Heading + '
' + 326 | '
'; 327 | 328 | } 329 | 330 | } 331 | 332 | ChatBot.addChatEntry(content, "bot"); 333 | ChatBot.thinking(false); 334 | }); 335 | }, 336 | getCapabilities: function () { 337 | return capabilities; 338 | }, 339 | getSuggestUrl: function() { 340 | return null; 341 | } 342 | } 343 | } 344 | }, 345 | init: function (options) { 346 | var settings = jQuery.extend({ 347 | // these are the defaults. 348 | botName: 'Bot', 349 | humanName: 'You', 350 | thinkingHtml: '', 351 | inputs: '', 352 | inputCapabilityListing: true, 353 | engines: [], 354 | patterns: [], 355 | normalizer: [], 356 | addChatEntryCallback: function(entryDiv, text, origin) { 357 | entryDiv.addClass('appear'); 358 | } 359 | }, options); 360 | 361 | botName = settings.botName; 362 | humanName = settings.humanName; 363 | thinkingHtml = settings.thinkingHtml; 364 | inputs = settings.inputs; 365 | inputCapabilityListing = settings.inputCapabilityListing; 366 | engines = settings.engines; 367 | patterns = settings.patterns; 368 | addChatEntryCallback = settings.addChatEntryCallback; 369 | normalizer = settings.normalizer; 370 | 371 | // update the command description 372 | updateCommandDescription(); 373 | 374 | // input capability listing? 375 | if (inputCapabilityListing) { 376 | $(inputs).attr("list", "chatBotCommands"); 377 | } 378 | 379 | // listen to inputs on the defined fields 380 | $(inputs).keyup(function (e) { 381 | if (e.keyCode == 13) { 382 | ChatBot.addChatEntry($(this).val(), "human"); 383 | ChatBot.react($(this).val()); 384 | } 385 | //console.log($(this).val()); 386 | }); 387 | 388 | }, 389 | setBotName: function (name) { 390 | botName = name; 391 | }, 392 | setHumanName: function (name) { 393 | humanName = name; 394 | $('.chatBotChatEntry.human .origin').html(name); 395 | }, 396 | addChatEntry: function addChatEntry(text, origin) { 397 | if (text == undefined) { 398 | return; 399 | } 400 | if (text == '') { 401 | text = 'Sorry, I have no idea.'; 402 | } 403 | var entryDiv = $('
'); 404 | entryDiv.html('' + (origin == 'bot' ? botName : humanName) + '' + text); 405 | $('#chatBotHistory').prepend(entryDiv); 406 | if (addChatEntryCallback != undefined) { 407 | addChatEntryCallback.call(this, entryDiv, text, origin); 408 | } 409 | }, 410 | thinking: function (on) { 411 | var ti = $('#chatBotThinkingIndicator'); 412 | if (on) { 413 | if (!sampleConversationRunning) { 414 | $(inputs).attr('disabled', 'disabled'); 415 | } 416 | ti.html(thinkingHtml); 417 | } else { 418 | if (!sampleConversationRunning) { 419 | $(inputs).removeAttr('disabled'); 420 | $(inputs).val(''); 421 | $(inputs).focus(); 422 | } 423 | ti.html(''); 424 | } 425 | }, 426 | react: function react(text) { 427 | this.thinking(true); 428 | 429 | // normalize the human text 430 | normalizer.map( method => { 431 | 432 | if( 433 | String.prototype[ method ] instanceof Function 434 | ) { 435 | // string immuable object 436 | text = text[ method ](); 437 | } else if( method instanceof Function ) { 438 | text = method( text ) || text; 439 | } 440 | 441 | } ) ; 442 | 443 | // check for custom patterns 444 | for (var i = 0; i < patterns.length; i++) { 445 | var pattern = patterns[i]; 446 | var r = new RegExp(pattern.regexp, "i"); 447 | var matches = text.match(r); 448 | //console.log(matches); 449 | if (matches) { 450 | switch (pattern.actionKey) { 451 | case 'rewrite': 452 | text = pattern.actionValue; 453 | for (var j = 1; j < matches.length; j++) { 454 | text = text.replace("$" + j, matches[j]); 455 | } 456 | //console.log("rewritten to " + text); 457 | if (pattern.callback != undefined) { 458 | pattern.callback.call(this, matches); 459 | } 460 | break; 461 | case 'response': 462 | // var response = text.replace(r, pattern.actionValue); 463 | var response = pattern.actionValue; 464 | if (response != undefined) { 465 | for (var j = 1; j < matches.length; j++) { 466 | response = response.replace("$" + j, matches[j]); 467 | } 468 | this.addChatEntry(response, "bot"); 469 | } 470 | ChatBot.thinking(false); 471 | if (pattern.callback != undefined) { 472 | pattern.callback.call(this, matches); 473 | } 474 | return; 475 | } 476 | break; 477 | } 478 | } 479 | 480 | for (var e = 0; e < engines.length; e++) { 481 | var engine = engines[e]; 482 | engine.react(text); 483 | } 484 | 485 | }, 486 | playConversation: function (conversation, pauseLength) { 487 | 488 | if (pauseLength == undefined) { 489 | pauseLength = 3000; 490 | } 491 | 492 | if (sampleConversationRunning) { 493 | return false; 494 | } 495 | 496 | $(inputs).val(''); 497 | 498 | sampleConversationRunning = true; 499 | 500 | var state = { 501 | start: 0, 502 | conversationArrayIndex: 0, 503 | conversationArray: conversation, 504 | currentInput: conversation[0] 505 | }; 506 | 507 | playConversation(state, pauseLength); 508 | 509 | return true; 510 | }, 511 | addPatternObject: function (obj) { 512 | patterns.push(obj); 513 | updateCommandDescription(); 514 | }, 515 | addPattern: function (regexp, actionKey, actionValue, callback, description) { 516 | var obj = { 517 | regexp: regexp, 518 | actionKey: actionKey, 519 | actionValue: actionValue, 520 | description: description, 521 | callback: callback 522 | }; 523 | this.addPatternObject(obj); 524 | } 525 | 526 | } 527 | }(); 528 | -------------------------------------------------------------------------------- /js/chatbot.min.js: -------------------------------------------------------------------------------- 1 | var ChatBot=function(){var e;var k;var j;var h;var g;var d;var l=[];var b;var c=false;var i;function n(){var v="";var t=[];var r,q;for(r=0;r$1');u=u.replace(/(\[[^\[\]]+\])/gi,'$1');var s=u.match(/['"](.+?)['"]<\/span>/gi);if(s!=null){for(q=0;q]*>/gi,"");l.push(w.replace(/['"]/gi,""))}}v+='
'+u+"
"}var p=$("#chatBotCommands");if(p.size()==0){p=$('');$("body").append(p)}else{p.html("")}for(r=0;r'))}$("#chatBotCommandDescription").html(v)}function a(p,o){setTimeout(function(){var t="";if($(g).val()!="|"){t+=$(g).val()}t+=p.currentInput.slice(p.start,p.start+1);$(g).val(t);p.start++;if(p.start');q.css("position","absolute");$("body").append(q)}var s=$(g).offset().left;var r=$(g).offset().top+$(g).outerHeight()-3;q.css("left",s+"px");q.css("top",r+"px");q.animate({width:$(g).outerWidth()+"px"},o,function(){q.css("width","0")})}},Math.random()*120+10)}return{Engines:{webknox:function(q){var o=["Ask for stock prices like 'stock price apple' or '[company] stock'.","Ask for distances as in 'how far is Perth from Melbourne' or 'distance between [place1] and [place2]'.","Want to know what the weather is like, just ask like 'weather in San Diego, California'.","Let WebKnox tell you a joke, just say 'tell me a joke'.","Convert units, e.g. '2.4 miles in kilometers' or '4 tablespoons to ml?'.","Get synonyms for a word, e.g. 'synonyms for car'.","Ask for quotes like 'quotes about [topic]' or 'quotes about love'.","Ask for quotes from a person 'quotes by [person]' or 'quotes by aristotle'.","Ask for recipes like 'spaghetti recipes' or 'chocolate donuts'.","Ask for nutrient contents like 'vitamin a in 2 carrots' or 'calories is 1 cup of butter'.","Convert ingredients like '2 cups of butter in grams'.","If you want more results, just say 'more'.","For more similar results say 'more like the first/second/third...'.","Or just ask anything that comes to mind like 'Who was pope in 1499?' or 'Who directed braveheart?'."];var p=Math.random()*100000;return{react:function(r){$.get("https://webknox-question-answering.p.mashape.com/questions/converse?mashape-key="+q+"&contextId="+p+"&text="+encodeURIComponent(r),function(v){var u=v.answerText;if(v.media!=undefined){u+="
";for(var t=0;t
'+s.title+'
Details

More like this
"}}ChatBot.addChatEntry(u,"bot");ChatBot.thinking(false)})},getCapabilities:function(){return o},getSuggestUrl:function(){return"https://webknox-question-answering.p.mashape.com/questions/converse/suggest?mashape-key="+q+"&query="}}},spoonacular:function(q){var o=["Ask for recipes like 'chicken recipes' or 'spaghetti with shrimp'","Ask for nutrient contents like 'vitamin a in 2 carrots' or 'calories is 1 cup of butter'","Convert something with '2 cups of butter in grams'","If you want more results, just say 'more'","For more similar results say 'more like the first/second/third...'","Let spoonacular tell you a joke, just say 'tell me a joke'.","Want to learn some food trivia, just say 'food trivia'."];var p=Math.random()*100000;return{react:function(r){$.get("https://spoonacular-recipe-food-nutrition-v1.p.mashape.com/food/converse?mashape-key="+q+"&contextId="+p+"&text="+encodeURIComponent(r),function(v){var u=v.answerText;if(v.media!=undefined){u+="
";for(var t=0;t
'+s.title+'
Details

More like this
"}}ChatBot.addChatEntry(u,"bot");ChatBot.thinking(false)})},getCapabilities:function(){return o},getSuggestUrl:function(){return"https://spoonacular-recipe-food-nutrition-v1.p.mashape.com/food/converse/suggest?mashape-key="+q+"&query="}}},duckduckgo:function(){var o=["Ask what something is like 'What is DNA'?","Ask where something is like 'Where is China'?","Ask about a person like 'Who is Bill Gates'?","Say a movie/person/location name like 'Braveheart' to get information about that entity","Say a something like 'simpsons characters' to get information about that phrase"];return{react:function(p){$.ajax({type:"GET",url:"https://api.duckduckgo.com/?format=json&pretty=1&q="+encodeURIComponent(p),dataType:"jsonp"}).done(function(u){var t=u.AbstractText;if(t==""&&u.RelatedTopics.length>0){t="

I found multiple answers for you:

";var v=[];for(var s=0;s"+r.Result.replace(""," ")+"

"}for(s=0;s'}}else{if(u.Image!=undefined&&u.Image!=""){t+="
";t+='
'+u.Heading+"
"}}ChatBot.addChatEntry(t,"bot");ChatBot.thinking(false)})},getCapabilities:function(){return o},getSuggestUrl:function(){return null}}}},init:function(o){var p=jQuery.extend({botName:"Bot",humanName:"You",thinkingHtml:'',inputs:"",inputCapabilityListing:true,engines:[],patterns:[],addChatEntryCallback:function(r,s,q){r.addClass("appear")}},o);k=p.botName;j=p.humanName;h=p.thinkingHtml;g=p.inputs;d=p.inputCapabilityListing;b=p.engines;e=p.patterns;i=p.addChatEntryCallback;n();if(d){$(g).attr("list","chatBotCommands")}$(g).keyup(function(q){if(q.keyCode==13){ChatBot.addChatEntry($(this).val(),"human");ChatBot.react($(this).val())}})},setBotName:function(o){k=o},setHumanName:function(o){j=o;$(".chatBotChatEntry.human .origin").html(o)},addChatEntry:function m(q,o){if(q==undefined){return}if(q==""){q="Sorry, I have no idea."}var p=$('
');p.html(''+(o=="bot"?k:j)+""+q);$("#chatBotHistory").prepend(p);if(i!=undefined){i.call(this,p,q,o)}},thinking:function(o){var p=$("#chatBotThinkingIndicator");if(o){if(!c){$(g).attr("disabled","disabled")}p.html(h)}else{if(!c){$(g).removeAttr("disabled");$(g).val("");$(g).focus()}p.html("")}},react:function f(x){this.thinking(true);for(var s=0;s