-#### [Search](./search.md)
- - **Local**: Your personal data stays local. All search and indexing is done on your machine.
+#### [Search](search.md)
+ - **Natural**: Use natural language queries to quickly find relevant notes and documents.
- **Incremental**: Incremental search for a fast, search-as-you-type experience
-#### [Chat](./chat.md)
+#### [Chat](chat.md)
- **Faster answers**: Find answers faster, smoother than search. No need to manually scan through your notes to find answers.
- **Iterative discovery**: Iteratively explore and (re-)discover your notes
- **Assisted creativity**: Smoothly weave across answers retrieval and content generation
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
index 9e0b88492..348b785a0 100644
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -1,12 +1,13 @@
- Get Started
- [Overview](README.md)
- - [Install](setup.md)
+ - [Self-Host](setup.md)
- [Demos](demos.md)
- Use
- [Features](features.md)
- [Chat](chat.md)
- [Search](search.md)
- - Interfaces
+ - Clients
+ - [Desktop](desktop.md)
- [Obsidian](obsidian.md)
- [Emacs](emacs.md)
- [Web](web.md)
diff --git a/docs/advanced.md b/docs/advanced.md
index a567783ff..95dacf306 100644
--- a/docs/advanced.md
+++ b/docs/advanced.md
@@ -1,63 +1,11 @@
## Advanced Usage
-### Search across Different Languages
+
+### Search across Different Languages (Self-Hosting)
To search for notes in multiple, different languages, you can use a [multi-lingual model](https://www.sbert.net/docs/pretrained_models.html#multi-lingual-models).Content
@@ -118,7 +118,7 @@
It should be `http://tailscale-ip-of-server:42110` or `http://name-of-server:42110` if you've setup [MagicDNS](https://tailscale.com/kb/1081/magicdns/) -4. Click the [Add to Homescreen](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Add_to_home_screen) button -5. Enjoy exploring your notes, documents and images from your phone! - - - -### Use OpenAI Models for Search -#### Setup -1. Set `encoder-type`, `encoder` and `model-directory` under `asymmetric` and/or `symmetric` `search-type` in your `khoj.yml` (at `~/.khoj/khoj.yml`): - ```diff - asymmetric: - - encoder: "sentence-transformers/multi-qa-MiniLM-L6-cos-v1" - + encoder: text-embedding-ada-002 - + encoder-type: khoj.utils.models.OpenAI - cross-encoder: "cross-encoder/ms-marco-MiniLM-L-6-v2" - - encoder-type: sentence_transformers.SentenceTransformer - - model_directory: "~/.khoj/search/asymmetric/" - + model-directory: null - ``` -2. [Setup your OpenAI API key in Khoj](/#/chat?id=setup) -3. Restart Khoj server to generate embeddings. It will take longer than with the offline search models. - -#### Warnings - This configuration *uses an online model* - - It will **send all notes to OpenAI** to generate embeddings - - **All queries will be sent to OpenAI** when you search with Khoj - - You will be **charged by OpenAI** based on the total tokens processed - - It *requires an active internet connection* to search and index - -### Bootstrap Khoj Search for Offline Usage later - -You can bootstrap Khoj pre-emptively to run on machines that do not have internet access. An example use-case would be to run Khoj on an air-gapped machine. -Note: *Only search can currently run in fully offline mode, not chat.* - -- With Internet - 1. Manually download the [asymmetric text](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1), [symmetric text](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) and [image search](https://huggingface.co/sentence-transformers/clip-ViT-B-32) models from HuggingFace - 2. Pip install khoj (and dependencies) in an associated virtualenv. E.g `python -m venv .venv && source .venv/bin/activate && pip install khoj-assistant` -- Without Internet - 1. Copy each of the search models into their respective folders, `asymmetric`, `symmetric` and `image` under the `~/.khoj/search/` directory on the air-gapped machine - 2. Copy the khoj virtual environment directory onto the air-gapped machine, activate the environment and start and khoj as normal. E.g `source .venv/bin/activate && khoj` +1. Manually update the search config in server's admin settings page. Go to [the search config](http://localhost:42110/server/admin/database/searchmodelconfig/). Either create a new one, if none exists, or update the existing one. Set the bi_encoder to `sentence-transformers/multi-qa-MiniLM-L6-cos-v1` and the cross_encoder to `cross-encoder/ms-marco-MiniLM-L-6-v2`. +2. Regenerate your content index from all the relevant clients. This step is very important, as you'll need to re-encode all your content with the new model. ### Query Filters diff --git a/docs/assets/khoj_chat_on_desktop.png b/docs/assets/khoj_chat_on_desktop.png new file mode 100644 index 000000000..e8c10718a Binary files /dev/null and b/docs/assets/khoj_chat_on_desktop.png differ diff --git a/docs/assets/khoj_search_on_desktop.png b/docs/assets/khoj_search_on_desktop.png new file mode 100644 index 000000000..1dc3231d6 Binary files /dev/null and b/docs/assets/khoj_search_on_desktop.png differ diff --git a/docs/chat.md b/docs/chat.md index 2efd7b1be..4ea64c3f8 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -1,13 +1,13 @@ -### Khoj Chat -#### Overview +## Khoj Chat +### Overview - Creates a personal assistant for you to inquire and engage with your notes - You can choose to use Online or Offline Chat depending on your requirements - Supports multi-turn conversations with the relevant notes for context - Shows reference notes used to generate a response -### Setup +### Setup (Self-Hosting) #### Offline Chat -Offline chat stays completely private and works without internet. But it is slower, lower quality and more compute intensive. +Offline chat stays completely private and works without internet using open-source models. > **System Requirements**: > - Minimum 8 GB RAM. Recommend **16Gb VRAM** @@ -15,9 +15,10 @@ Offline chat stays completely private and works without internet. But it is slow > - A CPU supporting [AVX or AVX2 instructions](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) is required > - A Mac M1+ or [Vulcan supported GPU](https://vulkan.gpuinfo.org/) should significantly speed up chat response times -- Open your [Khoj settings](http://localhost:42110/config/) and click *Enable* on the Offline Chat card +1. Open your [Khoj offline settings](http://localhost:42110/server/admin/database/offlinechatprocessorconversationconfig/) and click *Enable* on the Offline Chat configuration. +2. Open your [Chat model options](http://localhost:42110/server/admin/database/chatmodeloptions/) and add a new option for the offline chat model you want to use. Make sure to use `Offline` as its type. We currently only support offline models that use the [Llama chat prompt](https://replicate.com/blog/how-to-prompt-llama#wrap-user-input-with-inst-inst-tags) format. We recommend using `mistral-7b-instruct-v0.1.Q4_0.gguf`. - +!> **Note**: Offline chat is not supported for a multi-user scenario. The host machine will encounter segmentation faults if multiple users try to use offline chat at the same time. #### Online Chat Online chat requires internet to use ChatGPT but is faster, higher quality and less compute intensive. @@ -25,14 +26,12 @@ Online chat requires internet to use ChatGPT but is faster, higher quality and l !> **Warning**: This will enable Khoj to send your chat queries and query relevant notes to OpenAI for processing 1. Get your [OpenAI API Key](https://platform.openai.com/account/api-keys) -2. Open your [Khoj Online Chat settings](http://localhost:42110/config/processor/conversation), add your OpenAI API key, and click *Save*. Then go to your [Khoj settings](http://localhost:42110/config) and click `Configure`. This will refresh Khoj with your OpenAI API key. - - - +2. Open your [Khoj Online Chat settings](http://localhost:42110/server/admin/database/openaiprocessorconversationconfig/). Add a new setting with your OpenAI API key, and click *Save*. Only one configuration will be used, so make sure that's the only one you have. +3. Open your [Chat model options](http://localhost:42110/server/admin/database/chatmodeloptions/) and add a new option for the OpenAI chat model you want to use. Make sure to use `OpenAI` as its type. ### Use 1. Open Khoj Chat - - **On Web**: Open [/chat](http://localhost:42110/chat) in your web browser + - **On Web**: Open [/chat](https://app.khoj.dev/chat) in your web browser - **On Obsidian**: Search for *Khoj: Chat* in the [Command Palette](https://help.obsidian.md/Plugins/Command+palette) - **On Emacs**: Run `M-x khoj
Desktop
+
+> An AI copilot for your Second Brain
+
+## Features
+- **Chat**
+ - **Faster answers**: Find answers quickly, from your private notes or the public internet
+ - **Assisted creativity**: Smoothly weave across retrieving answers and generating content
+ - **Iterative discovery**: Iteratively explore and re-discover your notes
+- **Search**
+ - **Natural**: Advanced natural language understanding using Transformer based ML Models
+ - **Incremental**: Incremental search for a fast, search-as-you-type experience
+
+## Setup
+
+1. Install the [Khoj Desktop app](https://khoj.dev/downloads) for your OS
+2. Generate an API key on the [Khoj Web App](https://app.khoj.dev/config#clients)
+3. Set your Khoj API Key on the *Settings* page of the Khoj Desktop app
+4. [Optional] Add any files, folders you'd like Khoj to be aware of on the *Settings* page and Click *Save*
+
+## Interface
+
+
diff --git a/docs/desktop_installation.md b/docs/desktop_installation.md
index d79a282f1..42a893832 100644
--- a/docs/desktop_installation.md
+++ b/docs/desktop_installation.md
@@ -28,5 +28,5 @@ For the Linux installation, you have to have `glibc` version 2.35 or higher. You
If you decide you want to uninstall the application, you can uninstall it like any other application on your system. For example, on MacOS, you can drag the application to the trash. On Windows, you can uninstall it from the `Add or Remove Programs` menu. On Linux, you can uninstall it with `sudo apt remove khoj`.
In addition to that, you might want to `rm -rf` the following directories:
-- `~/.khoj`
-- `~/.cache/gpt4all`
+ - `~/.khoj`
+ - `~/.cache/gpt4all`
diff --git a/docs/development.md b/docs/development.md
index dd1aad46a..0d715dc46 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -25,13 +25,7 @@ pip install -e .'[dev]'
khoj -vv
```
2. Configure Khoj
- - **Via the Settings UI**: Add files, directories to index the [Khoj settings](http://localhost:42110/config) UI once Khoj has started up. Once you've saved all your settings, click `Configure`.
- - **Manually**:
- - Copy the `config/khoj_sample.yml` to `~/.khoj/khoj.yml`
- - Set `input-files` or `input-filter` in each relevant `content-type` section of `~/.khoj/khoj.yml`
- - Set `input-directories` field in `image` `content-type` section
- - Delete `content-type` and `processor` sub-section(s) irrelevant for your use-case
- - Restart khoj
+ - **Via the Desktop application**: Add files, directories to index using the settings page of your desktop application. Click "Save" to immediately trigger indexing.
Note: Wait after configuration for khoj to Load ML model, generate embeddings and expose API to query notes, images, documents etc specified in config YAML
diff --git a/docs/emacs.md b/docs/emacs.md
index 6492ecc45..d8e7e6825 100644
--- a/docs/emacs.md
+++ b/docs/emacs.md
@@ -1,6 +1,6 @@
-Emacs
+ Emacs
-> An AI personal assistance for your digital brain
+> An AI copilot for your Second Brain in Emacs
@@ -10,14 +10,13 @@
## Features
+- **Chat**
+ - **Faster answers**: Find answers quickly, from your private notes or the public internet
+ - **Assisted creativity**: Smoothly weave across retrieving answers and generating content
+ - **Iterative discovery**: Iteratively explore and re-discover your notes
- **Search**
- **Natural**: Advanced natural language understanding using Transformer based ML Models
- - **Local**: Your personal data stays local. All search, indexing is done on your machine*
- **Incremental**: Incremental search for a fast, search-as-you-type experience
-- **Chat**
- - **Faster answers**: Find answers faster than search
- - **Iterative discovery**: Iteratively explore and (re-)discover your notes
- - **Assisted creativity**: Smoothly weave across answer retrieval and content generation
## Interface
#### Search
@@ -27,79 +26,76 @@
## Setup
-- *Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine*
+1. Generate an API key on the [Khoj Web App](https://app.khoj.dev/config#clients)
+2. Add below snippet to your Emacs config file, usually at `~/.emacs.d/init.el`
+
+
+
-- *khoj.el attempts to automatically install, start and configure the khoj server.*
- If this fails, follow [these instructions](/setup) to manually setup the khoj server.
+#### **Direct Install**
+*Khoj will index your org-agenda files, by default*
-### Direct Install
```elisp
+;; Install Khoj.el
M-x package-install khoj
+
+; Set your Khoj API key
+(setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY")
```
-### Minimal Install
-Add below snippet to your Emacs config file.
-Indexes your org-agenda files, by default.
+#### **Minimal Install**
+*Khoj will index your org-agenda files, by default*
```elisp
- ;; Install Khoj Package from MELPA Stable
- (use-package khoj
- :ensure t
- :pin melpa-stable
- :bind ("C-c s" . 'khoj))
+;; Install Khoj client from MELPA Stable
+(use-package khoj
+ :ensure t
+ :pin melpa-stable
+ :bind ("C-c s" . 'khoj)
+ :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"))
```
-- Note: Install `khoj.el` from MELPA (instead of MELPA Stable) if you installed the pre-release version of khoj
- - That is, use `:pin melpa` to install khoj.el in above snippet if khoj server was installed with `--pre` flag, i.e `pip install --pre khoj-assistant`
- - Else use `:pin melpa-stable` to install khoj.el in above snippet if khoj was installed with `pip install khoj-assistant`
- - This ensures both khoj.el and khoj app are from the same version (git tagged or latest)
-
-### Standard Install
- Add below snippet to your Emacs config file.
- Indexes the specified org files, directories. Sets up OpenAI API key for Khoj Chat
+#### **Standard Install**
+*Configures the specified org files, directories to be indexed by Khoj*
```elisp
-;; Install Khoj Package from MELPA Stable
+;; Install Khoj client from MELPA Stable
(use-package khoj
:ensure t
:pin melpa-stable
:bind ("C-c s" . 'khoj)
- :config (setq khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
- khoj-org-files '("~/docs/todo.org" "~/docs/work.org")
- khoj-openai-api-key "YOUR_OPENAI_API_KEY")) ; required to enable chat
+ :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"
+ khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
+ khoj-org-files '("~/docs/todo.org" "~/docs/work.org")))
```
-### With [Straight.el](https://github.com/raxod502/straight.el)
-Add below snippet to your Emacs config file.
-Indexes the specified org files, directories. Sets up OpenAI API key for Khoj Chat
+#### **Straight.el**
+*Configures the specified org files, directories to be indexed by Khoj*
```elisp
- ;; Install Khoj Package using Straight.el
- (use-package khoj
- :after org
- :straight (khoj :type git :host github :repo "khoj-ai/khoj" :files (:defaults "src/interface/emacs/khoj.el"))
- :bind ("C-c s" . 'khoj)
- :config (setq khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
- khoj-org-files '("~/docs/todo.org" "~/docs/work.org")
- khoj-openai-api-key "YOUR_OPENAI_API_KEY" ; required to enable chat)
- ```
+;; Install Khoj client using Straight.el
+(use-package khoj
+ :after org
+ :straight (khoj :type git :host github :repo "khoj-ai/khoj" :files (:defaults "src/interface/emacs/khoj.el"))
+ :bind ("C-c s" . 'khoj)
+ :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"
+ khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
+ khoj-org-files '("~/docs/todo.org" "~/docs/work.org")))
+```
+
## Use
### Search
+See [Khoj Search](search.md) for details
1. Hit `C-c s s` (or `M-x khoj RET s`) to open khoj search
-
-2. Enter your query in natural language
-
- e.g "What is the meaning of life?", "My life goals for 2023"
+2. Enter your query in natural language+ E.g *"What is the meaning of life?"*, *"My life goals for 2023"* ### Chat +See [Khoj Chat](chat.md) for details 1. Hit `C-c s c` (or `M-x khoj RET c`) to open khoj chat - -2. Ask questions in a natural, conversational style - - E.g "When did I file my taxes last year?" - - See [Khoj Chat](/#/chat) for more details +2. Ask questions in a natural, conversational style
+ E.g *"When did I file my taxes last year?"* ### Find Similar Entries This feature finds entries similar to the one you are currently on. @@ -108,7 +104,6 @@ This feature finds entries similar to the one you are currently on. ### Advanced Usage - Add [query filters](https://github.com/khoj-ai/khoj/#query-filters) during search to narrow down results further - e.g `What is the meaning of life? -"god" +"none" dt>"last week"` - Use `C-c C-o 2` to open the current result at cursor in its source org file @@ -121,31 +116,21 @@ This feature finds entries similar to the one you are currently on.  Hit `C-c s` (or `M-x khoj`) to open the khoj menu above. Then: - Hit `t` until you preferred content type is selected in the khoj menu - `Content Type` specifies the content to perform `Search`, `Update` or `Find Similar` actions on - Hit `n` twice and then enter number of results you want to see - `Results Count` is used by the `Search` and `Find Similar` actions - Hit `-f u` to `force` update the khoj content index - The `Force Update` switch is only used by the `Update` action ## Upgrade -### Upgrade Khoj Backend -```bash -pip install --upgrade khoj-assistant -``` -### Upgrade Khoj.el Use your Emacs package manager to upgrade `khoj.el` + + +#### **With MELPA** +1. Run `M-x package-refresh-content` +2. Run `M-x package-reinstall khoj` + +#### **With Straight.el** +- Run `M-x straight-pull-package khoj` -- For `khoj.el` from MELPA - - Method 1 - - Run `M-x package-list-packages` to list all packages - - Press `U` on `khoj` to mark it for upgrade - - Press `x` to execute the marked actions - - Method 2 - - Run `M-x package-refresh-content` - - Run `M-x package-reinstall khoj` - -- For `khoj.el` from Straight - - Run `M-x straight-pull-package khoj` + diff --git a/docs/features.md b/docs/features.md index 3bd8939fc..f59e06579 100644 --- a/docs/features.md +++ b/docs/features.md @@ -1,10 +1,10 @@ ## Features -#### [Search](./search.md) +#### [Search](search.md) - **Local**: Your personal data stays local. All search and indexing is done on your machine. - **Incremental**: Incremental search for a fast, search-as-you-type experience -#### [Chat](./chat.md) +#### [Chat](chat.md) - **Faster answers**: Find answers faster, smoother than search. No need to manually scan through your notes to find answers. - **Iterative discovery**: Iteratively explore and (re-)discover your notes - **Assisted creativity**: Smoothly weave across answers retrieval and content generation diff --git a/docs/github_integration.md b/docs/github_integration.md index 413dd41ef..b7c8a4fed 100644 --- a/docs/github_integration.md +++ b/docs/github_integration.md @@ -1,14 +1,14 @@ -# Setup the Github integration +# 🧑🏾💻 Setup the Github integration The Github integration allows you to index as many repositories as you want. It's currently default configured to index Issues, Commits, and all Markdown/Org files in each repository. For large repositories, this takes a fairly long time, but it works well for smaller projects. # Configure your settings -1. Go to [http://localhost:42110/config](http://localhost:42110/config) and enter in settings for the data sources you want to index. You'll have to specify the file paths. +1. Go to [https://app.khoj.dev/config](https://app.khoj.dev/config) and enter in settings for the data sources you want to index. You'll have to specify the file paths. ## Use the Github plugin 1. Generate a [classic PAT (personal access token)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) from [Github](https://github.com/settings/tokens) with `repo` and `admin:org` scopes at least. -2. Navigate to [http://localhost:42110/config/content-source/github](http://localhost:42110/config/content-source/github) to configure your Github settings. Enter in your PAT, along with details for each repository you want to index. +2. Navigate to [https://app.khoj.dev/config/content-source/github](https://app.khoj.dev/config/content-source/github) to configure your Github settings. Enter in your PAT, along with details for each repository you want to index. 3. Click `Save`. Go back to the settings page and click `Configure`. -4. Go to [http://localhost:42110/](http://localhost:42110/) and start searching! +4. Go to [https://app.khoj.dev/](https://app.khoj.dev/) and start searching! diff --git a/docs/index.html b/docs/index.html index 33ba07355..763d65dd0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -17,11 +17,13 @@ repo: 'https://github.com/khoj-ai/khoj', loadSidebar: true, themeColor: '#c2a600', + auto2top: true, // coverpage: true, } + diff --git a/docs/notion_integration.md b/docs/notion_integration.md index d3b645cad..6a309d411 100644 --- a/docs/notion_integration.md +++ b/docs/notion_integration.md @@ -8,7 +8,7 @@ We haven't setup a fancy integration with OAuth yet, so this integration still r  3. Share all the workspaces that you want to integrate with the Khoj integration you just made in the previous step  -4. In the first step, you generated an API key. Use the newly generated API Key in your Khoj settings, by default at http://localhost:42110/config/content-source/notion. Click `Save`. -5. Click `Configure` in http://localhost:42110/config to index your Notion workspace(s). +4. In the first step, you generated an API key. Use the newly generated API Key in your Khoj settings, by default at https://app.khoj.dev/config/content-source/notion. Click `Save`. +5. Click `Configure` in https://app.khoj.dev/config to index your Notion workspace(s). That's it! You should be ready to start searching and chatting. Make sure you've configured your OpenAI API Key for chat. diff --git a/docs/obsidian.md b/docs/obsidian.md index 10e65ba10..478c4c60d 100644 --- a/docs/obsidian.md +++ b/docs/obsidian.md @@ -1,16 +1,15 @@ -
Obsidian
+ Obsidian
-> An AI personal assistant for your Digital Brain in Obsidian
+> An AI copilot for your Second Brain in Obsidian
## Features
+- **Chat**
+ - **Faster answers**: Find answers quickly, from your private notes or the public internet
+ - **Assisted creativity**: Smoothly weave across retrieving answers and generating content
+ - **Iterative discovery**: Iteratively explore and re-discover your notes
- **Search**
- **Natural**: Advanced natural language understanding using Transformer based ML Models
- - **Local**: Your personal data stays local. All search and indexing is done on your machine. *Unlike chat which requires access to GPT.*
- **Incremental**: Incremental search for a fast, search-as-you-type experience
-- **Chat**
- - **Faster answers**: Find answers faster and with less effort than search
- - **Iterative discovery**: Iteratively explore and (re-)discover your notes
- - **Assisted creativity**: Smoothly weave across answers retrieval and content generation
## Interface
@@ -18,102 +17,37 @@
## Setup
-- *Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine*
-- *Ensure you follow the ordering of the setup steps. Install the plugin after starting the khoj backend. This allows the plugin to configure the khoj backend*
-
-### 1. Setup Backend
-Open terminal/cmd and run below command to install and start the khoj backend
-- On Linux/MacOS
- ```shell
- python -m pip install khoj-assistant && khoj
- ```
-- On Windows
- ```shell
- py -m pip install khoj-assistant && khoj
- ```
-
-### 2. Setup Plugin
1. Open [Khoj](https://obsidian.md/plugins?id=khoj) from the *Community plugins* tab in Obsidian settings panel
2. Click *Install*, then *Enable* on the Khoj plugin page in Obsidian
- 3. [Optional] To enable Khoj Chat, set your [OpenAI API key](https://platform.openai.com/account/api-keys) in the Khoj plugin settings
+ 3. Generate an API key on the [Khoj Web App](https://app.khoj.dev/config#clients)
+ 4. Set your Khoj API Key in the Khoj plugin settings in Obsidian
-See [official Obsidian plugin docs](https://help.obsidian.md/Extending+Obsidian/Community+plugins) for details
+See the official [Obsidian Plugin Docs](https://help.obsidian.md/Extending+Obsidian/Community+plugins) for more details on installing Obsidian plugins.
## Use
### Chat
Run *Khoj: Chat* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette) and ask questions in a natural, conversational style.-E.g "When did I file my taxes last year?" - -Notes: -- *Using Khoj Chat will result in query relevant notes being shared with OpenAI for ChatGPT to respond.* -- *To use Khoj Chat, ensure you've set your [OpenAI API key](https://platform.openai.com/account/api-keys) in the Khoj plugin settings.* +E.g *"When did I file my taxes last year?"* See [Khoj Chat](/chat) for more details +### Find Similar Notes +To see other notes similar to the current one, run *Khoj: Find Similar Notes* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette) + ### Search Click the *Khoj search* icon 🔎 on the [Ribbon](https://help.obsidian.md/User+interface/Workspace/Ribbon) or run *Khoj: Search* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette) -*Note: Ensure the khoj server is running in the background before searching. Execute `khoj` in your terminal if it is not already running* +See [Khoj Search](/search) for more details. Use [query filters](/advanced#query-filters) to limit entries to search [search_demo](https://user-images.githubusercontent.com/6413477/218801155-cd67e8b4-a770-404a-8179-d6b61caa0f93.mp4 ':include :type=mp4') -#### Query Filters - -Use structured query syntax to filter the natural language search results -- **Word Filter**: Get entries that include/exclude a specified term - - Entries that contain term_to_include: `+"term_to_include"` - - Entries that contain term_to_exclude: `-"term_to_exclude"` -- **Date Filter**: Get entries containing dates in YYYY-MM-DD format from specified date (range) - - Entries from April 1st 1984: `dt:"1984-04-01"` - - Entries after March 31st 1984: `dt>="1984-04-01"` - - Entries before April 2nd 1984 : `dt<="1984-04-01"` -- **File Filter**: Get entries from a specified file - - Entries from incoming.org file: `file:"incoming.org"` -- Combined Example - - `what is the meaning of life? file:"1984.org" dt>="1984-01-01" dt<="1985-01-01" -"big" -"brother"` - - Adds all filters to the natural language query. It should return entries - - from the file *1984.org* - - containing dates from the year *1984* - - excluding words *"big"* and *"brother"* - - that best match the natural language query *"what is the meaning of life?"* - -### Find Similar Notes -To see other notes similar to the current one, run *Khoj: Find Similar Notes* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette) - ## Upgrade -### 1. Upgrade Backend - ```shell - pip install --upgrade khoj-assistant - ``` -### 2. Upgrade Plugin 1. Open *Community plugins* tab in Obsidian settings 2. Click the *Check for updates* button 3. Click the *Update* button next to Khoj, if available -## Demo -### Search Demo -[demo](https://github-production-user-asset-6210df.s3.amazonaws.com/6413477/240061700-3e33d8ea-25bb-46c8-a3bf-c92f78d0f56b.mp4 ':include :type=mp4') - -#### Description - -1. Install Khoj via `pip` and start Khoj backend - ```shell - python -m pip install khoj-assistant && khoj - ``` -2. Install Khoj plugin via Community Plugins settings pane on Obsidian app - - Check the new Khoj plugin settings - - Wait for Khoj backend to index markdown, PDF files in the current Vault - - Open Khoj plugin on Obsidian via Search button on Left Pane - - Search \"*Announce plugin to folks*\" in the [Obsidian Plugin docs](https://marcus.se.net/obsidian-plugin-docs/) - - Jump to the [search result](https://marcus.se.net/obsidian-plugin-docs/publishing/submit-your-plugin) - - ## Troubleshooting - Open the Khoj plugin settings pane, to configure Khoj - Toggle Enable/Disable Khoj, if setting changes have not applied - Click *Update* button to force index to refresh, if results are failing or stale - -## Current Limitations -- The plugin loads the index of only one vault at a time.
- So notes across multiple vaults **cannot** be searched at the same time diff --git a/docs/search.md b/docs/search.md index 579034ec9..f2387f065 100644 --- a/docs/search.md +++ b/docs/search.md @@ -1,7 +1,7 @@ ## Khoj Search ### Use 1. Open Khoj Search - - **On Web**: Open
- Its simpler as it can skip the server *install*, *run* and *configure* step below. + It's simpler as it can skip the server *install*, *run* and *configure* step below. - Check the [Khoj Obsidian docs](/obsidian?id=_2-setup-plugin) to setup Khoj with Obsidian
Its simpler as it can skip the *configure* step below. -### 1. Install +For Installation, you can either use Docker or install Khoj locally. + +### 1. Installation (Docker) + +Use the sample docker-compose [in Github](https://github.com/khoj-ai/khoj/blob/master/docker-compose.yml) to run Khoj in Docker. Start by configuring all the environment variables to your choosing. Your admin account will automatically be created based on the admin credentials in that file, so pay attention to those. To start the container, run the following command in the same directory as the docker-compose.yml file. This will automatically setup the database and run the Khoj server. + +```shell +docker-compose up +``` + +Khoj should now be running at http://localhost:42110. You can see the web UI in your browser. + +### 1. Installation (Local) + +#### Prerequisites + +##### Install Postgres (with PgVector) + +Khoj uses the `pgvector` package to store embeddings of your index in a Postgres database. In order to use this, you need to have Postgres installed. + + + +#### **MacOS** + +Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies. + +#### **Windows** + +Use the [recommended installer](https://www.postgresql.org/download/windows/) + +#### **Linux** +From [official instructions](https://wiki.postgresql.org/wiki/Apt) + +```bash +sudo apt install -y postgresql-common +sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh +sudo apt install postgres-16 postgresql-16-pgvector +``` + +##### **From Source** +1. Follow instructions to [Install Postgres](https://www.postgresql.org/download/) +2. Follow instructions to [Install PgVector](https://github.com/pgvector/pgvector#installation) in case you need to manually install it. Reproduced instructions below for convenience. + +```bash +cd /tmp +git clone --branch v0.5.1 https://github.com/pgvector/pgvector.git +cd pgvector +make +make install # may need sudo +``` + + + + +##### Create the Khoj database + +Make sure to update your environment variables to match your Postgres configuration if you're using a different name. The default values should work for most people. + + + +#### **MacOS** +```bash +createdb khoj -U postgres +``` + +#### **Windows** +```bash +createdb khoj -U postgres +``` + +#### **Linux** +```bash +sudo -u postgres createdb khoj +``` + + + +#### Install package + +##### Local Server Setup +- *Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine* -#### 1.1 Local Server Setup Run the following command in your terminal to install the Khoj backend. -- On Linux/MacOS - ```shell - python -m pip install khoj-assistant - ``` + -- On Windows - ```shell - py -m pip install khoj-assistant - ``` -For more detailed Windows installation and troubleshooting, see [Windows Install](./windows_install.md). +#### **MacOS** + +```shell +python -m pip install khoj-assistant +``` +#### **Windows** -##### 1.1.1 Local Server Start +```shell +py -m pip install khoj-assistant +``` +For more detailed Windows installation and troubleshooting, see [Windows Install](./windows_install.md). -Run the following command from your terminal to start the Khoj backend and open Khoj in your browser. +#### **Linux** ```shell -khoj +python -m pip install khoj-assistant ``` -Khoj should now be running at http://localhost:42110. You can see the web UI in your browser. + -Note: To start Khoj automatically in the background use [Task scheduler](https://www.windowscentral.com/how-create-automated-task-using-task-scheduler-windows-10) on Windows or [Cron](https://en.wikipedia.org/wiki/Cron) on Mac, Linux (e.g with `@reboot khoj`) +##### Local Server Start -#### 1.2 Local Docker Setup -Use the sample docker-compose [in Github](https://github.com/khoj-ai/khoj/blob/master/docker-compose.yml) to run Khoj in Docker. To start the container, run the following command in the same directory as the docker-compose.yml file. You'll have to configure the mounted directories to match your local knowledge base. +Run the following command from your terminal to start the Khoj backend and open Khoj in your browser. ```shell -docker-compose up +khoj --anonymous-mode ``` +`--anonymous-mode` allows you to run the server without setting up Google credentials for login. This allows you to use any of the clients without a login wall. If you want to use Google login, you can skip this flag, but you will have to add your Google developer credentials. -Khoj should now be running at http://localhost:42110. You can see the web UI in your browser. +On the first run, you will be prompted to input credentials for your admin account and do some basic configuration for your chat model settings. Once created, you can go to http://localhost:42110/server/admin and login with the credentials you just created. -#### 1.3 Download the desktop client [Optional] +Khoj should now be running at http://localhost:42110. You can see the web UI in your browser. -You can use our desktop executables to select file paths and folders to index. You can simply select the folders or files, and they'll be automatically uploaded to the server. Once you specify a file or file path, you don't need to update the configuration again; it will grab any data diffs dynamically over time. This part is currently optional, but may make setup and configuration slightly easier. It removes the need for setting up custom file paths for your Khoj data configurations. +Note: To start Khoj automatically in the background use [Task scheduler](https://www.windowscentral.com/how-create-automated-task-using-task-scheduler-windows-10) on Windows or [Cron](https://en.wikipedia.org/wiki/Cron) on Mac, Linux (e.g with `@reboot khoj`) -**To download the desktop client, go to https://download.khoj.dev** and the correct executable for your OS will automatically start downloading. Once downloaded, you can configure your folders for indexing using the settings tab. To set your chat configuration, you'll have to use the web interface for the Khoj server you setup in the previous step. -### 1.4 Use (deprecated) desktop builds +### 2. Download the desktop client -Before `v0.12.0``, we had self-contained desktop builds that included both the server and the client. These were difficult to maintain, but are still available as part of earlier releases. To find setup instructions, see here: +You can use our desktop executables to select file paths and folders to index. You can simply select the folders or files, and they'll be automatically uploaded to the server. Once you specify a file or file path, you don't need to update the configuration again; it will grab any data diffs dynamically over time. -- [Desktop Installation](desktop_installation.md) -- [Windows Installation](windows_install.md) +**To download the latest desktop client, go to https://download.khoj.dev** and the correct executable for your OS will automatically start downloading. Once downloaded, you can configure your folders for indexing using the settings tab. To set your chat configuration, you'll have to use the web interface for the Khoj server you setup in the previous step. -### 2. Configure -1. Set `File`, `Folder` and hit `Save` in each Plugins you want to enable for Search on the Khoj config page -2. Add your OpenAI API key to Chat Feature settings if you want to use Chat -3. Click `Configure` and wait. The app will download ML models and index the content for search and (optionally) chat +To use the desktop client, you need to go to your Khoj server's settings page (http://localhost:42110/config) and copy the API key. Then, paste it into the desktop client's settings page. Once you've done that, you can select files and folders to index. - +### 3. Configure +1. Go to http://localhost:42110/server/admin and login with your admin credentials. Go to the ChatModelOptions if you want to add additional models for chat. +1. Select files and folders to index [using the desktop client](./setup.md?id=_2-download-the-desktop-client). When you click 'Save', the files will be sent to your server for indexing. + - Select Notion workspaces and Github repositories to index using the web interface. -### 3. Install Interface Plugins (Optional) +### 4. Install Client Plugins (Optional) Khoj exposes a web interface to search, chat and configure by default.
The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs. @@ -75,9 +153,17 @@ The optional steps below allow using Khoj from within an existing application li - **Khoj Emacs**:
[Install](/emacs?id=setup) khoj.el +### 5. Use Khoj 🚀 + +You can head to http://localhost:42110 to use the web interface. You can also use the desktop client to search and chat. ## Upgrade ### Upgrade Khoj Server + + + +#### **Local Setup** + ```shell pip install --upgrade khoj-assistant ``` @@ -88,6 +174,16 @@ pip install --upgrade khoj-assistant pip install --upgrade --pre khoj-assistant ``` +#### **Docker** +From the same directory where you have your `docker-compose` file, this will fetch the latest build and upgrade your server. + +```shell +docker-compose up --build +``` + + + + ### Upgrade Khoj on Emacs - Use your Emacs Package Manager to Upgrade - See [khoj.el package setup](/emacs?id=setup) for details @@ -100,8 +196,8 @@ pip install --upgrade --pre khoj-assistant 1. (Optional) Hit `Ctrl-C` in the terminal running the khoj server to stop it 2. Delete the khoj directory in your home folder (i.e `~/.khoj` on Linux, Mac or `C:\Users\
Web
+ Web
-> An AI personal assistant for your Digital Brain
+> An AI copilot for your Second Brain
## Features
+- **Chat**
+ - **Faster answers**: Find answers quickly, from your private notes or the public internet
+ - **Assisted creativity**: Smoothly weave across retrieving answers and generating content
+ - **Iterative discovery**: Iteratively explore and re-discover your notes
- **Search**
- **Natural**: Advanced natural language understanding using Transformer based ML Models
- - **Local**: Your personal data stays local. All search and indexing is done on your machine. *Unlike chat which requires access to GPT.*
- **Incremental**: Incremental search for a fast, search-as-you-type experience
-- **Chat**
- - **Faster answers**: Find answers faster and with less effort than search
- - **Iterative discovery**: Iteratively explore and (re-)discover your notes
- - **Assisted creativity**: Smoothly weave across answers retrieval and content generation
## Setup
-The Khoj web interface is the default interface. It comes packaged with the khoj server.
+No setup required. The Khoj web app is the default interface to Khoj. You can access it from any web browser. Try it on [Khoj Cloud](https://app.khoj.dev)
## Interface
diff --git a/src/interface/emacs/khoj.el b/src/interface/emacs/khoj.el
index c4cbf6984..a5dea4564 100644
--- a/src/interface/emacs/khoj.el
+++ b/src/interface/emacs/khoj.el
@@ -63,7 +63,7 @@
;; Khoj Static Configuration
;; -------------------------
-(defcustom khoj-server-url "http://localhost:42110"
+(defcustom khoj-server-url "https://app.khoj.dev"
"Location of Khoj API server."
:group 'khoj
:type 'string)
@@ -94,7 +94,7 @@
:type 'number)
(defcustom khoj-api-key nil
- "API Key to Khoj server."
+ "API Key to your Khoj. Default at https://app.khoj.dev/config#clients."
:group 'khoj
:type 'string)
diff --git a/src/interface/obsidian/src/main.ts b/src/interface/obsidian/src/main.ts
index 9f0560e81..26b0a5a1d 100644
--- a/src/interface/obsidian/src/main.ts
+++ b/src/interface/obsidian/src/main.ts
@@ -75,7 +75,7 @@ export default class Khoj extends Plugin {
if (this.settings.khojUrl === "https://app.khoj.dev") {
if (this.settings.khojApiKey === "") {
- new Notice(`❗️Khoj API key is not configured. Please visit https://app.khoj.dev to get an API key.`);
+ new Notice(`❗️Khoj API key is not configured. Please visit https://app.khoj.dev/config#clients to get an API key.`);
return;
}
diff --git a/src/interface/obsidian/src/settings.ts b/src/interface/obsidian/src/settings.ts
index d9473e4a1..9150c438a 100644
--- a/src/interface/obsidian/src/settings.ts
+++ b/src/interface/obsidian/src/settings.ts
@@ -13,7 +13,7 @@ export interface KhojSetting {
export const DEFAULT_SETTINGS: KhojSetting = {
resultsCount: 6,
- khojUrl: 'http://127.0.0.1:42110',
+ khojUrl: 'https://app.khoj.dev',
khojApiKey: '',
connectedToBackend: false,
autoConfigure: true,
diff --git a/src/khoj/interface/web/config.html b/src/khoj/interface/web/config.html
index 497dd31a3..01a3786fd 100644
--- a/src/khoj/interface/web/config.html
+++ b/src/khoj/interface/web/config.html
@@ -2,7 +2,7 @@
{% block content %}
-
+
-
+
- Features
@@ -144,9 +144,9 @@
+
Clients
-
+
{% if billing_enabled %}
-
API Keys
@@ -172,7 +172,7 @@API Keys
+
Billing
diff --git a/src/khoj/utils/helpers.py b/src/khoj/utils/helpers.py
index 3bce67a00..cc35aae0c 100644
--- a/src/khoj/utils/helpers.py
+++ b/src/khoj/utils/helpers.py
@@ -286,15 +286,15 @@ def generate_random_name():
# List of adjectives and nouns to choose from
adjectives = [
"happy",
- "irritated",
- "annoyed",
+ "serendipitous",
+ "exuberant",
"calm",
"brave",
"scared",
"energetic",
"chivalrous",
"kind",
- "grumpy",
+ "suave",
]
nouns = ["dog", "cat", "falcon", "whale", "turtle", "rabbit", "hamster", "snake", "spider", "elephant"]