Skip to content

d-liya/mun-chat-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation


Mun Chat Bot

Question answering system using document embedding

Table of Contents
  1. About The Project
  2. Getting Started

About The Project

This is a web application that students can use to ask any question related to university.

Built With

  • Typescript
  • React.js
  • Python
  • Flask
  • OpenAI
  • Transfromers

(back to top)

Key Features

  • Can answer any question about the university. (NOTE: the dataset included in the project is only for testing purposes)
  • Web based user interface to interact with the application.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Install node to run the client application
  • Install python to run the server application

Installation

  1. Replace the <YOUR_API_KEY> in the gpt3.py file in the server folder with your own key
  2. Clone the repo
  3. Install NPM packages to run the client applcation (Follow next.js docuemntation for more information https://nextjs.org/docs/getting-started)
  4. Install python packages to run the server application (Follow flask documentation for more information https://flask.palletsprojects.com/en/2.0.x/installation/)
  5. Visit localhost:3000 (Might change the port if it's already in use.)

(back to top)

About

Question answering system using document embedding

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published