Skip to content

Latest commit

 

History

History
67 lines (54 loc) · 2.8 KB

README.md

File metadata and controls

67 lines (54 loc) · 2.8 KB
Raw

APU Knowledge Base Chatbot

Introduction

This is a chatbot that will provide information about the campus facilities and services in Asia Pacific University of Technology & Innovation (APU).

You may Download Zip file from this repository, or clone it to your local through Git CLI with the commands below:

git clone https://github.com/TeoJJss/iai-chatbot.git

Python v3.11.6 is used for development.

Getting Started

Prerequisite

You should install the dependencies before launching the bot, with the following commands:

python -m venv venv
venv\Scripts\activate
pip install -r requirements.txt

The source codes can host the chatbot on Discord and Streamlit, depending on preferences.

Option 1: Hosting with Discord

To launch the bot, ensure that you have configured the Discord bot's token and channel ID in config.py. If there is a config_sensitive.py, please configure in this file instead.
Read this for guide on obtaining channel ID in Discord.
Run the following command to launch the bot in Discord:

python main.py

You should be able to see the bot with "Online" status in Discord, if the bot's token is correctly specified in config.py or config_sensitive.py. After that, it can respond to messages in the allowed channels.

Option 2: Hosting with Streamlit

This chatbot supports Streamlit too. You may launch the bot in Streamlit through the following commands:

streamlit run main_st.py

You will be redirected to a localhost website, where Streamlit is hosted on.

Option 3: Try with Cloud Version

This chatbot is hosted in Streamlit Cloud, you may access it with https://iai-chatbot-15.streamlit.app/
Due to the limitation on system resources provided by Streamlit Cloud, the chatbot might have lower performance compared to running it locally.

Sample questions to the chatbot

Below is the list of sample queries you may ask to the Chatbot. Nevertheless, you may ask questions which are not listed.

  1. LRT/APU/APIIT to LRT/APU/APIIT bus
  2. Where is parking/library/campus/cashier
  3. Where to wait bus at LRT/APU/APIIT
  4. Travel pass cost
  5. Parking rate zone A/B/G
  6. Holiday schedule
  7. How to top up APCard
  8. Operating hour of admin/library
  9. APU citation style
  10. Payment with Maybank/JomPay/CIMB/Cheque
  11. How to check result

Credits

- Teo Jun Jia
- Siew Sheng Yao
- Sin Boon Leon
- Chong Kah Jun
- Yong Lee Wai
- Ting Zi Qing