Git Product home page Git Product logo

quickyelp's Introduction

Developed by Julian Zulfikar, August 2023 - Discontinued March 2024 (Per Yelp's Request)

Purpose ๐Ÿš€

QuickYelp is a dynamic AI chatbot which scans through the information and reviews of a given Yelp business, then answers questions based on its training data. With this program, users are able to save a ton of time from having to manually read through the reviews themselves. Thus, our goal is to offer an easy and efficient way to retrieve a quick overview of a restaurant, as well as answer questions to the best of its ability.

How It Works ๐Ÿง 

QuickYelp is powered by three main APIs:

  1. Yelp Fusion API
  2. OpenAI API
  3. LangChain

We leverage Yelp Fusion to retrieve data related to the business in question. Following this, LangChain is utilized to feed documents to OpenAI's language model, GPT-4.

Once a user submits a query through LangChain's RetrievalQA chain, the query goes through two FAISS (Facebook AI Similarity Search) indexes:

  • Index containing the Yelp business information (name, phone, hours, etc)
  • Index containing the Yelp business reviews (ordered by Yelp Sort)

Both chatbot replies are received, then fed once more to OpenAI's GPT-4 language model. The replies are merged together to form a reply based on the provided information as well as the context found in user reviews, in order to return the most relevant reply possible.

Tech Stack ๐Ÿค–

  • Python
    • Flask
    • Redis
    • LXML
    • Asyncio
  • HTML/CSS
    • Tailwind CSS
  • JavaScript
    • React

Screenshots ๐ŸŽฅ

Demo Video: https://youtu.be/RuM0cEnhojY

Screenshots as of 8/24/23:

Files ๐Ÿ“

  • app.py: Flask implementation of the application
  • shell.py: Shell implementation, as well as the main back-end functionality
  • index.html: Home page; pop-up form
  • chat.html: Chat page, makes asynchronous calls to app.py

Conclusion ๐Ÿ‘‹

As of the beginning of March 2024, the project has come to a close as per Yelp's request.

I thank you all for making this project worthwhile. At the time of closing, QuickYelp served over 250+ chat sessions and 3,000+ queries.

Here's to bigger projects soon!

quickyelp's People

Contributors

julian-z avatar

Stargazers

Manjot Singh avatar  avatar Simon Cao avatar

Watchers

Kostas Georgiou avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.