Study Buddy is a document-based AI chatbot built using Streamlit and OpenAI's API. The application enables users to upload documents, transform them into embeddings, and interact with the content through an AI-powered chat interface.
- Document Upload: Users can upload files which are processed into embeddings for AI interaction.
- Chat with Your Documents: Use AI to query and learn from the uploaded documents.
- Citations and References: The assistant provides responses with citations for clarity and accuracy.
- Streamlit Interface: A user-friendly web interface for uploading files and chatting.
- Python 3.8 or higher
- A valid OpenAI API key
- Required Python packages (see
requirements.txt)
-
Clone this repository:
git clone https://github.com/your-username/study-buddy.git cd study-buddy -
Install dependencies:
pip install -r requirements.txt
-
Create a
.envfile in the project root and add your OpenAI API key:OPENAI_API_KEY=your_openai_api_key
-
Start the Streamlit server:
streamlit run app.py
-
Open your browser and navigate to
http://localhost:8501to access the app.
- Upload Files: Use the sidebar to upload one or more documents.
- Transform to Embeddings: Click the "Upload File" button to process the files.
- Start Chatting: After uploading, click the "Start Chatting" button to initiate a session.
- Interact: Use the chat input to ask questions about the uploaded documents. The assistant will respond with relevant citations.
- Modify
app.pyto adjust settings such as the AI model (gpt-4o-mini) or chat instructions. - Extend functionalities like additional file types or UI enhancements.
- Placeholder citations: The citations for files are hardcoded as placeholders and should be connected to actual document retrieval.
- Support for additional file types.
- Enhanced citation management.
- Improved UI/UX design.
Contributions are welcome! Please fork the repository and submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
Happy Learning!