https://github.com/parthsareen/obsidian-rag

Talk to your Obsidian notes!
https://github.com/parthsareen/obsidian-rag

langchain llama obsidian obsidian-md ollama python

Last synced: 7 days ago
JSON representation

Talk to your Obsidian notes!

• Host: GitHub
• URL: https://github.com/parthsareen/obsidian-rag
• Owner: ParthSareen
• License: mit
• Created: 2023-12-11T05:01:11.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-28T20:40:37.000Z (about 2 months ago)
• Last Synced: 2024-12-06T13:54:49.811Z (17 days ago)
• Topics: langchain, llama, obsidian, obsidian-md, ollama, python
• Language: Python
• Homepage:
• Size: 300 KB
• Stars: 102
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# obsidian-rag

# NOT MAINTAINED!

_For the maintained version of the app, see [RAG-in-a-box](https://github.com/ParthSareen/RAG-in-a-box) it does even more than just Obsidian notes!_

Obsidian-Rag is a local first project that leverages Langchain to perform RAG on markdown files. It is particularly designed to work with the Obsidian note-taking app since I know we're all nerds (Waterloo strong 💪).

## Features

- Load markdown files from a given directory.

- Vectorize the loaded files for further processing.

- Perform similarity search on vectorized data.

- Utilize the Langchain library's functionalities such as `ChatOllama`, `ObsidianLoader`, `OllamaEmbeddings`, and `Chroma`.

## Dependencies

Must have installed `requirements.txt` and an `Ollama` instance with `Mistral` must be running

### Usage

The main script of the project is obsidian_rag.py. It accepts command-line arguments for the file path and a boolean flag to decide whether to vectorize the file or not.

`python obsidian_rag.py --filepath YOUR_FILE_PATH --vectorize`

This will open up a gradio interface which is still WIP and should be made into a chat interface.





## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=parthsareen/obsidian-rag&type=Date)](https://star-history.com/#parthsareen/obsidian-rag&Date)