chatgpt-custom-knowledge-chatbot - GitLite

KO | EN

gitlite — search

#javascript #ai #golang #machine-learning #deep-learning #linux #nodejs #windows #cli #kubernetes #awesome-list #pytorch #security #open-source

chatgpt-custom-knowledge-chatbot

(★ 138)

This open source chatbot project lets you create a chatbot that uses your own data to answer questions, thanks to the power of the OpenAI GPT-3.5 model.

File Explorer

Download Latest Version (.zip)

- chat_completion.py
- simple_vector_index.py
- nato_wikipedia_export.txt
.gitignore
LICENSE
main.py
README.md
requirements.txt

# Installation Guide

1. Get the code

git clone https://github.com/robindekoster/chatgpt-custom-knowledge-chatbot

Downloads the entire project code from GitHub to your computer.

cd chatgpt-custom-knowledge-chatbot

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python main.py

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

*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).*

<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>

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.

## 🚀 Getting Started

To get started with this project, follow these steps:

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.

## 🤖 Technologies Used

This project uses the following technologies:

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

## 🌟 How to Contribute

We welcome and appreciate any contributions to improve and expand the project. To contribute, please:

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.

## 📝 License

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

## 👨‍💻 Author

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

---

Give this project a ⭐ if you find it useful! Your support is greatly appreciated.

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!