Skip to content

Update README.md #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 80 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,52 +1,100 @@
*This project has reached the end of its development as a simple chatgpt chatbot based on your custom knowledge. Feel free to browse the code, but please use other repos like
[PrivateGPT](https://github.com/imartinez/privateGPT).*
# 💬 ChatGPT Custom Knowledge Chatbot

<h1 align="center">💻 ChatGPT Custom Knowledge Chatbot</h1>
<p align="center">
<img src="https://img.shields.io/github/stars/robindekoster/ChatGPT-Custom-Knowledge-Chatbot?style=social" alt="Stars">
<img src="https://img.shields.io/github/forks/robindekoster/ChatGPT-Custom-Knowledge-Chatbot?style=social" alt="Forks">
</p>
> ⚠️ **Note:** This project is no longer being actively developed.
> Feel free to explore the code and learn from it!
> If you're looking for a more up-to-date project, check out [PrivateGPT](https://github.com/imartinez/privateGPT).

Welcome to the ChatGPT Custom Knowledge Chatbot! This project uses the OpenAI GPT-3.5 model to build a chatbot that can answer questions based on a custom knowledge base.
---

## 📌 What is This?

This project is a simple chatbot that uses OpenAI's GPT-3.5 to answer questions based on documents you provide — like PDFs, text files, or CSVs. It’s great for building a Q\&A bot that “knows” your custom content.

---

## 🚀 How to Use This

Follow these steps to get the chatbot running on your machine:

### 1. Clone the Project

## 🚀 Getting Started
First, download the code. Open your terminal and run:

To get started with this project, follow these steps:
```bash
git clone https://github.com/robindekoster/chatgpt-custom-knowledge-chatbot.git
```

1. **Clone this repository**: Click on the "Code" button and copy the URL. In your terminal, run `git clone https://github.com/robindekoster/chatgpt-custom-knowledge-chatbot.git`.
2. **Install the necessary packages**: Navigate to the project directory and run `pip install -r requirements.txt` to install all required dependencies.
3. **Set your OpenAI API key**: Run `export OPENAI_API_KEY=<your-api-key>` to set your OpenAI API key as an environment variable.
4. **Add your text documents**: Place the text, csv and pdf documents you want the chatbot to use in the `knowledge` directory.
5. **Run the project**: Start the chatbot by running `python main.py` in your terminal.
### 2. Install the Required Packages

## 🤖 Technologies Used
Move into the project folder and install everything it needs:

This project uses the following technologies:
```bash
cd chatgpt-custom-knowledge-chatbot
pip install -r requirements.txt
```

- [OpenAI API](https://openai.com/)
- [Llama Index](https://pypi.org/project/llama-index/)
- [LangChain](https://pypi.org/project/langchain/)
### 3. Set Your OpenAI API Key

## 🌟 How to Contribute
To use the chatbot, you need an OpenAI API key. You can get one at [platform.openai.com](https://platform.openai.com/).

We welcome and appreciate any contributions to improve and expand the project. To contribute, please:
Once you have it, set it in your terminal like this:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes.
4. Submit a pull request with a clear description of your changes.
```bash
export OPENAI_API_KEY=your-api-key-here
```

## 📝 License
> 💡 Tip: On Windows, use `set` instead of `export`.

This project is licensed under the MIT License. See the `LICENSE` file for details.
### 4. Add Your Documents

## 👨‍💻 Author
Place any `.txt`, `.csv`, or `.pdf` files you want the chatbot to use inside the `knowledge/` folder.

This project was created by Robin de Koster. You can find me on GitHub at [@robindekoster](https://github.com/robindekoster).
### 5. Start the Chatbot

Run the main Python script to start chatting:

```bash
python main.py
```

That’s it! The chatbot will now answer questions based on the files you added.

---

Give this project a ⭐ if you find it useful! Your support is greatly appreciated.
## 🧰 Tech Behind the Scenes

This chatbot is built with:

* 🧠 [OpenAI API](https://openai.com/)
* 🦙 [LlamaIndex](https://pypi.org/project/llama-index/) – for indexing your documents
* 🔗 [LangChain](https://pypi.org/project/langchain/) – for chaining together the chatbot logic

---

## 💡 Want to Contribute?

We welcome help from the community!

1. Fork this repo
2. Create a new branch (`git checkout -b feature-name`)
3. Make your changes
4. Submit a pull request with a clear explanation

---

## 📄 License

This project is open-source and licensed under the MIT License.
See the `LICENSE` file for full details.

---

## 👤 Author

Made by **Robin de Koster**.
Find me on GitHub: [@robindekoster](https://github.com/robindekoster)

---

Feel free to reach out with any questions or suggestions, and don't forget to share your own amazing projects using ChatGPT Custom Knowledge Chatbot!
⭐ If you found this helpful, please give it a star!
Got questions or ideas? Feel free to open an issue or start a discussion.