mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-09 21:29:11 +00:00
Minor doc updates after merging emacs package with main repository
This commit is contained in:
@@ -2,7 +2,7 @@ Semantic Search
|
|||||||
===
|
===
|
||||||
> Provide natural language search on user personal content like notes, images using ML models
|
> 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](https://github.com/debanjum/emacs-semantic-search), API or Commandline
|
All data is processed locally. User can interface with semantic-search app via [Emacs](./interface/emacs/semantic-search.el), API or Commandline
|
||||||
|
|
||||||
Dependencies
|
Dependencies
|
||||||
----
|
----
|
||||||
@@ -38,9 +38,9 @@ Run
|
|||||||
|
|
||||||
Use
|
Use
|
||||||
---
|
---
|
||||||
- *Calls Semantic Search via Emacs*
|
- *Semantic Search via Emacs*
|
||||||
- `M-x semantic-search "<user-query>"`
|
- [Install](https://github.com/debanjum/semantic-search/tree/master/interface/emacs#installation) [semantic-search.el](./interface/emacs/semantic-search.el)
|
||||||
- `C-c C-s`
|
- Run `M-x semantic-search "<user-query>"` or Call `C-c C-s`
|
||||||
|
|
||||||
- *Call Semantic Search via API*
|
- *Call Semantic Search via API*
|
||||||
- `GET` [http://localhost:8000/search?q="What is the meaning of life"](http://localhost:8000/search?q=%22what%20is%20the%20meaning%20of%20life%22)
|
- `GET` [http://localhost:8000/search?q="What is the meaning of life"](http://localhost:8000/search?q=%22what%20is%20the%20meaning%20of%20life%22)
|
||||||
|
|||||||
@@ -4,8 +4,8 @@
|
|||||||
|
|
||||||
;; Author: Debanjum Singh Solanky <debanjum@gmail.com>
|
;; Author: Debanjum Singh Solanky <debanjum@gmail.com>
|
||||||
;; Version: 0.1
|
;; Version: 0.1
|
||||||
;; Keywords: search, org-mode, outlines, ledger
|
;; Keywords: search, org-mode, outlines
|
||||||
;; URL: http://github.com/debanjum/emacs-semantic-search
|
;; URL: http://github.com/debanjum/semantic-search/interface/emacs
|
||||||
|
|
||||||
;; This file is NOT part of GNU Emacs.
|
;; This file is NOT part of GNU Emacs.
|
||||||
|
|
||||||
@@ -26,8 +26,8 @@
|
|||||||
|
|
||||||
;;; Commentary:
|
;;; Commentary:
|
||||||
|
|
||||||
;; This package enables semantic search on org-mode, beancount files
|
;; This package provides semantic search on org-mode files
|
||||||
;; It is a wrapper package that interfaces with a transformer based ML model
|
;; It is a wrapper that interfaces with transformer based ML model
|
||||||
;; The models semantic search capabilities are exposed via an HTTP API
|
;; The models semantic search capabilities are exposed via an HTTP API
|
||||||
|
|
||||||
;;; Code:
|
;;; Code:
|
||||||
|
|||||||
Reference in New Issue
Block a user