mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-02 13:18:18 +00:00
d9f60c00bf72eaec7c4470d5b863bf013a8b77cc
That is, if the file paths in the input set don't end with .org
Semantic Search
Provide natural language search on user personal content like notes, images using ML models
All data is processed locally. User can interface with semantic-search app via Emacs, API or Commandline
Dependencies
- Python3
- Miniconda
Install
git clone https://github.com/debanjum/semantic-search && cd semantic-search
conda env create -f environment.yml
conda activate semantic-search
Setup
Generate compressed JSONL from specified org-mode files
python3 processor/org-mode/org-to-jsonl.py \
--org-files "~/Notes/Schedule.org" "~/Notes/Incoming.org" \
--jsonl-file ".notes.jsonl" \
--verbose
Run
Load ML model, generate embeddings and expose API interface to run user queries on above org-mode files
python3 main.py \
--jsonl-file .notes.jsonl.gz \
--embeddings-file .notes_embeddings.pt \
--verbose
Use
-
Semantic Search via Emacs
- Install semantic-search.el
- Run
M-x semantic-search "<user-query>"or CallC-c C-s
-
Call Semantic Search via API
-
Call Semantic Search via Python Script Directly
python3 search_types/asymmetric.py \ --jsonl-file .notes.jsonl.gz \ --embeddings-file .notes_embeddings.pt \ --results-count 5 \ --verbose \ --interactive
Acknowledgments
- MiniLM Model for Asymmetric Text Search. See SBert Documentation
- OpenAI CLIP Model for Image Search. See SBert Documentation
- Charles Cave for OrgNode Parser
Languages
Python
51%
TypeScript
36.1%
CSS
4.1%
HTML
3.2%
Emacs Lisp
2.4%
Other
3.1%