AI Chatbot

Give a website link to AI and ask questions
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Built With
3. Getting Started
   • Prerequisites
   • Installation
4. Deployment
5. Contributing
6. License

About The Project

This project is built using Python and the LangChain framework. Users can input the URL of the desired website and ask questions to the AI.

The project leverages LangChain's Retrieval Augmented Generation (RAG) system to utilize external data sources. Through the processes of loading, transforming, and embedding, the data is stored in a vector store. Refined answers are then retrieved using the LangChain system.

In this project, the main language model employed is OpenAI's GPT-3.5 Turbo. The frontend chatbot interface is implemented using Streamlit, a pure Python UI library.

Follow the instructions in the "Installation" section below to create your own chatbot!

Built With

Getting Started

Prerequisites

• Get API Key at https://platform.openai.com/

Installation

1. Clone the repo

   git clone https://github.com/Jay-Sung-Lim/AI-ChatBot.git
   

2. Enter your API Key in .streamlit/.secrets.toml

   OPENAI_API_KEY = YOUR_API_KEY_HERE
   

3. Install Virtual Environment

   python -m venv env
   

4. Activate Virtual Environment

   source env/bin/activate
   

5. Install Python Packages

   pip install -r requirements.txt
   

6. Run Home.py with Streamlit

   streamlit run Home.py
   

Deployment

The website is deployed and hosted through Streamlit Cloud. You can access the live website at https://ai-chatbot-hackville2024.streamlit.app/.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the MIT License. See the License.txt file for details.