inkchatgpt / README.md
vinhnx90's picture
Update README
36e3301
|
raw
history blame
1.69 kB
app icon

πŸ“š InkChatGPT Streamlit App

InkChatGPT is a Streamlit application that allows users to upload PDF documents and engage in a conversational Q&A with a language model (LLM) based on the content of those documents.

Features

  • Upload any PDF documents and start asking key information about it
  • Conversational Q&A with LLM (powered by OpenAI's GPT-3.5-turbo model)
  • Use HuggingFace embeddings to generate embeddings for the document chunks with all-MiniLM-L6-v2 model.
  • Clear conversation history
  • Responsive UI with loading indicators and chat interface

Prerequisites

  • Python 3.7 or later
  • OpenAI API key (set as an environment variable: OPENAI_API_KEY)

Installation

  1. Clone the repository:
git clone https://github.com/vinhnx/InkChatGPT.git
cd InkChatGPT
  1. Create a virtual environment and activate it:
python -m venv env
source env/bin/activate
  1. Install the required dependencies:
pip install -r requirements.txt

Usage

  1. Set the OPENAI_API_KEY environment variable with your OpenAI API key: export OPENAI_API_KEY=YOUR_API_KEY

  2. Run the Streamlit app:

streamlit run app.py
  1. Upload PDF documents and start chatting with the LLM!

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or bug fixes.

License

This project is licensed under the MIT License.