├── LICENSE ├── README.md └── webhook implementations ├── golang └── server.go ├── nodejs ├── index.js └── package.json └── python └── server.py /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 | # Workshop on building Conversational Agents using Dialogflow 2 | Dialogflow Workshop Material. This can be used to create a Conversational Agent for a simple Linear Conversation using Dialogflow. 3 | 4 | # Presentation 5 | [Building Conversational Chatbot Interfaces with API.AI](https://goo.gl/goxv9h) 6 | 7 | # Hands-on Guide 8 | [Blog post to the guide](https://rominirani.com/hands-on-with-api-ai-google-assistant-writing-your-first-conversation-agent-a6a7dcdaba27) 9 | 10 | # Webhook Integration Sample ServerCode 11 | 12 | - [Golang Server](https://github.com/rominirani/api-ai-workshop/tree/master/webhook%20implementations/golang) 13 | - [Python Server](https://github.com/rominirani/api-ai-workshop/tree/master/webhook%20implementations/python) 14 | - [Node.js Server](https://github.com/rominirani/api-ai-workshop/tree/master/webhook%20implementations/nodejs) 15 | 16 | # Designing Google Home Bot Interactions with BotSociety.io 17 | 18 | - [Blog Post](https://medium.com/@iromin/designing-google-home-interactions-with-botsociety-io-a3330b47a2d0) 19 | - [Video Link](https://www.youtube.com/watch?v=7LzzJtqE9Kw) 20 | -------------------------------------------------------------------------------- /webhook implementations/golang/server.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "log" 7 | "net/http" 8 | "time" 9 | 10 | "github.com/gorilla/mux" 11 | ) 12 | 13 | //APIAIRequest : Incoming request format from APIAI 14 | type APIAIRequest struct { 15 | ID string `json:"id"` 16 | Timestamp time.Time `json:"timestamp"` 17 | Result struct { 18 | Parameters map[string]string `json:"parameters"` 19 | Contexts []interface{} `json:"contexts"` 20 | Metadata struct { 21 | IntentID string `json:"intentId"` 22 | WebhookUsed string `json:"webhookUsed"` 23 | WebhookForSlotFillingUsed string `json:"webhookForSlotFillingUsed"` 24 | IntentName string `json:"intentName"` 25 | } `json:"metadata"` 26 | Score float32 `json:"score"` 27 | } `json:"result"` 28 | Status struct { 29 | Code int `json:"code"` 30 | ErrorType string `json:"errorType"` 31 | } `json:"status"` 32 | SessionID string `json:"sessionId"` 33 | OriginalRequest interface{} `json:"originalRequest"` 34 | } 35 | 36 | //APIAIMessage : Response Message Structure 37 | type APIAIMessage struct { 38 | Speech string `json:"speech"` 39 | DisplayText string `json:"displayText"` 40 | Source string `json:"source"` 41 | } 42 | 43 | //HelloEndpoint - HTTP Request Handler for /hello 44 | func HelloEndpoint(w http.ResponseWriter, req *http.Request) { 45 | fmt.Fprintln(w, "Hello from APIAI Webhook Integration.") 46 | } 47 | 48 | //VersionEndpoint - HTTP Request Handler for /version 49 | func VersionEndpoint(w http.ResponseWriter, req *http.Request) { 50 | fmt.Fprintln(w, "APIAI Webhook Integration. Version 1.0") 51 | } 52 | 53 | //WebhookEndpoint - HTTP Request Handler for /webhook 54 | func WebhookEndpoint(w http.ResponseWriter, req *http.Request) { 55 | 56 | if req.Method == "POST" { 57 | decoder := json.NewDecoder(req.Body) 58 | 59 | var t APIAIRequest 60 | err := decoder.Decode(&t) 61 | if err != nil { 62 | fmt.Println(err) 63 | http.Error(w, "Error in decoding the Request data", http.StatusInternalServerError) 64 | } 65 | 66 | rating := t.Result.Parameters["rating"] 67 | comments := t.Result.Parameters["comments"] 68 | resortlocation := t.Result.Parameters["resort-location"] 69 | fmt.Println("Received the following request parameters", rating, comments, resortlocation) 70 | msg := APIAIMessage{Source: "Hotel Feedback System", Speech: "Thank you for the feedback", DisplayText: "Thank you for the feedback"} 71 | w.Header().Set("Content-Type", "application/json") 72 | json.NewEncoder(w).Encode(msg) 73 | } else { 74 | http.Error(w, "Invalid Request Method", http.StatusMethodNotAllowed) 75 | } 76 | } 77 | 78 | func main() { 79 | router := mux.NewRouter() 80 | router.HandleFunc("/", HelloEndpoint).Methods("GET") 81 | router.HandleFunc("/version", VersionEndpoint).Methods("GET") 82 | router.HandleFunc("/webhook", WebhookEndpoint).Methods("POST") 83 | log.Fatal(http.ListenAndServe(":5000", router)) 84 | } 85 | -------------------------------------------------------------------------------- /webhook implementations/nodejs/index.js: -------------------------------------------------------------------------------- 1 | const express = require('express'); 2 | const bodyParser = require('body-parser'); 3 | const app = express(); 4 | app.use(bodyParser.json()); 5 | app.use(bodyParser.urlencoded({ extended: true })); 6 | 7 | app.get('/version', (req, res) => { 8 | res.status(200).send("APIAI Webhook Integration. Version 1.0"); 9 | }); 10 | 11 | app.get('/', (req, res) => { 12 | res.status(200).send("Hello from APIAI Webhook Integration."); 13 | }); 14 | 15 | /* Handling all messenges */ 16 | app.post('/webhook', (req, res) => { 17 | console.log(req.body); 18 | console.log(req.body.result.parameters["rating"]); 19 | console.log(req.body.result.parameters["comments"]); 20 | console.log(req.body.result.parameters["resort-location"]); 21 | //Persist this in some database 22 | //Send out an email that new feedback has come in 23 | res.status(200).json({ 24 | speech: "Thank you for the feedback", 25 | displayText: "Thank you for the feedback", 26 | source: 'Hotel Feedback System'}); 27 | }); 28 | 29 | const server = app.listen(process.env.PORT || 5000, () => { 30 | console.log('Express server listening on port %d in %s mode', server.address().port, app.settings.env); 31 | }); -------------------------------------------------------------------------------- /webhook implementations/nodejs/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "apiai", 3 | "version": "1.0.0", 4 | "description": "API AI Node Webhook App", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "author": "Romin Irani", 10 | "license": "ISC", 11 | "dependencies": { 12 | "body-parser": "^1.16.1", 13 | "express": "^4.14.1" 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /webhook implementations/python/server.py: -------------------------------------------------------------------------------- 1 | from flask import Flask, request, jsonify 2 | app = Flask(__name__) 3 | 4 | @app.route("/") 5 | def hello(): 6 | return "Hello from APIAI Webhook Integration." 7 | 8 | @app.route("/version") 9 | def version(): 10 | return "APIAI Webhook Integration. Version 1.0" 11 | 12 | @app.route("/webhook", methods=['POST']) 13 | def webhook(): 14 | content = request.json 15 | //Extract out the parameters 16 | //Persist the record 17 | //Send email notification 18 | return jsonify({"speech":"Thank You for the feedback","displayText":"Thank You for the feedback","source":"Hotel Feedback System"}) 19 | 20 | if __name__ == "__main__": 21 | app.run() --------------------------------------------------------------------------------