https://github.com/vectormike/smart-research-assistant
A smart research assistant powered by RAG (Retrieval-Augmented Generation) for managing and querying research notes.
https://github.com/vectormike/smart-research-assistant
Last synced: 11 months ago
JSON representation
A smart research assistant powered by RAG (Retrieval-Augmented Generation) for managing and querying research notes.
- Host: GitHub
- URL: https://github.com/vectormike/smart-research-assistant
- Owner: Vectormike
- Created: 2025-06-16T10:50:37.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-17T16:20:24.000Z (12 months ago)
- Last Synced: 2025-06-17T17:33:11.753Z (12 months ago)
- Language: Python
- Size: 24.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RAG Research Notes
A Python project for managing and querying research notes using Retrieval-Augmented Generation (RAG).
## Project Structure
```
.
├── config/ # Configuration files
├── data/ # Data storage
├── embeddings/ # Vector embeddings
├── src/ # Source code
└── utils/ # Utility functions
```
## Setup
1. Create a virtual environment:
```bash
python -m venv venv
source venv/bin/activate
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Create a `.env` file in the root directory with your configuration:
```env
OPENAI_API_KEY=your_api_key_here
```
## Development
- Use `black` for code formatting
- Use `isort` for import sorting
- Use `flake8` for linting
- Use `pytest` for testing
## Environment Variables
- `OPENAI_API_KEY`: Your OpenAI API key
- Add other environment variables as needed
## License
MIT