klbr/khoj
1
0
Fork 0
mirror of https://github.com/khoaliber/khoj.git synced 2026-03-02 21:19:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Readme. Add section for using Khoj via Web interface

Browse Source
This commit is contained in:
Debanjum Singh Solanky
2022-07-22 04:02:03 +04:00
parent 65fea7681a
commit 3728583e08
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.org
View File

@@ -1,9 +1,9 @@
[[https://github.com/debanjum/khoj/actions/workflows/test.yml/badge.svg]] [[https://github.com/debanjum/khoj/actions/workflows/build.yml/badge.svg]]
* Khoj
/Allow natural language search on user content like notes, images, transactions using transformer ML models/
/Natural language search for your notes, transactions and images using transformer ML models/
User can interface with Khoj via [[./src/interface/web/index.html][Web]], [[./src/interface/emacs/khoj.el][Emacs]] or the API. All search is done locally[[https://github.com/debanjum/khoj#miscellaneous][*]]
Interface with Khoj via [[./src/interface/web/index.html][Web]], [[./src/interface/emacs/khoj.el][Emacs]] or the [[http://localhost:8000/docs][API]]. All search is done locally[[https://github.com/debanjum/khoj#miscellaneous][*]]
** Demo
https://user-images.githubusercontent.com/6413477/168417719-8a8bc4e5-8404-42b2-89a7-4493e3d2582c.mp4
@@ -27,16 +27,20 @@
/Note: The first run will take time. Let it run, it's mostly not hung, just generating embeddings/
** Use
- *Khoj via API*
- See [[http://localhost:8000/docs][Khoj API Docs]]
- [[http://localhost:8000/search?q=%22what%20is%20the%20meaning%20of%20life%22][Query]]
- [[http://localhost:8000/regenerate?t=ledger][Regenerate Embeddings]]
- [[https://localhost:8000/ui][Configure Application]]
- *Khoj via Web*
- Go to [[http://localhost:8000/]] or open [[./src/interface/web/index.html][index.html]] in your browser
- *Khoj via Emacs*
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#installation][Install]] [[./src/interface/emacs/khoj.el][khoj.el]]
- Run ~M-x khoj <user-query>~
- *Khoj via API*
- See [[http://localhost:8000/docs][Khoj FastAPI Docs]]
- [[http://localhost:8000/search?q=%22what%20is%20the%20meaning%20of%20life%22][Query]]
- [[http://localhost:8000/regenerate?t=ledger][Regenerate Embeddings]]
- [[https://localhost:8000/ui][Configure Application]]
** Run Unit tests
#+begin_src shell
@@ -101,6 +105,7 @@
** Acknowledgments
- [[https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1][Multi-QA MiniLM Model]] for Asymmetric Text Search. See [[https://www.sbert.net/examples/applications/retrieve_rerank/README.html][SBert Documentation]]
- [[https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2][All MiniLM Model]] for Symmetric Text Search
- [[https://github.com/openai/CLIP][OpenAI CLIP Model]] for Image Search. See [[https://www.sbert.net/examples/applications/image-search/README.html][SBert Documentation]]
- Charles Cave for [[http://members.optusnet.com.au/~charles57/GTD/orgnode.html][OrgNode Parser]]
- Sven Marnach for [[https://github.com/smarnach/pyexiftool/blob/master/exiftool.py][PyExifTool]]