chatgpt-custom-knowledge-chatbot

💻 ChatGPT Custom Knowledge Chatbot: An Introduction

The ChatGPT Custom Knowledge Chatbot is an intriguing project designed to harness the power of OpenAI's GPT-3.5 model. Its primary goal is to function as a chatbot capable of answering questions using a custom-defined knowledge base, making it extremely versatile for various kinds of information retrieval tasks.

🚀 Getting Started

Embarking on your journey with this chatbot is straightforward. Here’s how you can set it up in a few simple steps:

1. Clone the Repository: You begin by copying the repository. This is done by clicking the "Code" button on the project's GitHub page and copying the URL. You can then clone the repository by using the command git clone https://github.com/robindekoster/chatgpt-custom-knowledge-chatbot.git in your terminal.

2. Install Necessary Packages: Once you've cloned the repository, navigate into the directory and use the command pip install -r requirements.txt to install all the dependencies needed by the project.

3. Set Up API Access: The OpenAI GPT-3.5 model requires an API key to function. You need to run the command export OPENAI_API_KEY=<your-api-key> in your terminal to set this as an environment variable.

4. Upload Your Documents: For the chatbot to reference custom knowledge, you place your text, CSV, and PDF documents into the knowledge directory within the project.

5. Launch the Chatbot: With everything in place, you can initiate the chatbot by executing the command python main.py.

🤖 Technologies Used

The development of this project rests on several key technologies:

• OpenAI API: Central to the chatbot's operation, providing the AI capability.
• Llama Index: A crucial component for indexing and handling document information.
• LangChain: Facilitates the interaction and management of language-related processes within the chatbot.

🌟 How to Contribute

Contributions are more than welcome! Whether you wish to improve existing features or add new ones, here’s how you can contribute:

1. Fork the Repository: Duplicate the project repository to your own GitHub account.
2. Create a New Branch: Make a separate branch specifically for your proposed changes or fixes.
3. Implement Your Changes: Apply your improvements or bug fixes to the project.
4. Submit a Pull Request: After completing your changes, submit them for review and potential integration into the main project by creating a pull request.

📝 License

This project is released under the MIT License. This means it's open for public use, modification, and distribution within the terms of this license. Check the LICENSE file for complete details.

👨‍💻 Author

The brain behind this project is Robin de Koster, who you can engage with on GitHub through the profile @robindekoster.

If you find the ChatGPT Custom Knowledge Chatbot valuable in your work or projects, consider giving it a star on GitHub! Also, the community offers a warm invite to engage with inquiries or suggestions. Share your experiences and projects using this chatbot to inspire others!