├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2016 Tomáš Bedřich 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # NLP restaurant finder 2 | 3 | This project is a semestral work for an [Internet Applications Development course](https://sites.google.com/a/via.felk.cvut.cz/via/) on a [CTU in Prague](https://www.cvut.cz/en). 4 | 5 | 6 | ## Goal 7 | 8 | The main aim is to create a simple conversational chat bot, which will be able to reply to questions regarding the nearby restaurants, their daily menu, and details. For example: 9 | 10 | > **What is the nearest restaurant?** 11 | > U Topolů 12 | > 13 | > **And what is on their daily menu?** 14 | > Silný vývar z hovězích kostí se zeleninou a vaječným svítkem and Selečí bůček pečený na kmíně, čerstvý listový špenát zahuštěný vejci, bramborový knedlík, for 119 Kč 15 | > 16 | > **Where is it?** 17 | > Jugoslávských partyzanů 32 18 | > 19 | > **Call there.** 20 | > +420608630310 21 | 22 | The application has to be able to: 23 | 24 | - search for restaurants, filter them by a cuisine type and order by distance, price or rating 25 | - get the daily menu of a restaurant 26 | - get the restaurant location, phone number, and website 27 | 28 | 29 | ## Architecture 30 | 31 | The application backend will use a Python, namely a [Flask framework](http://flask.pocoo.org/). The backend will handle a communication with two other APIs needed to solve the goal: 32 | 33 | - [Wit.ai](https://wit.ai) for NLP 34 | - [Zomato](https://developers.zomato.com/api) for retrieving a restaurant info 35 | 36 | The backend will provide its own API, which will be used mainly by the application frontend but can also be used by other developers. 37 | 38 | The frontend will be a Javascript web application. The advantage of using Javascript is, that there are many cool browser APIs available for it, (for example, [geolocation](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation) or [microphone](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia)), without a need to install anything. These can be used in the future to further improve the application. 39 | --------------------------------------------------------------------------------