mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-02 21:19:12 +00:00
Add a demo for the khoj mini application, minor updates to other pages, remove out of date demos page
This commit is contained in:
@@ -15,6 +15,7 @@ Khoj will keep these files in sync to provide contextual responses when you sear
|
|||||||
- **Faster answers**: Find answers quickly, from your private notes or the public internet
|
- **Faster answers**: Find answers quickly, from your private notes or the public internet
|
||||||
- **Assisted creativity**: Smoothly weave across retrieving answers and generating content
|
- **Assisted creativity**: Smoothly weave across retrieving answers and generating content
|
||||||
- **Iterative discovery**: Iteratively explore and re-discover your notes
|
- **Iterative discovery**: Iteratively explore and re-discover your notes
|
||||||
|
- **Quick access**: Use [Khoj Mini](/features/desktop_shortcut) on the desktop to quickly pull up a mini chat module for quicker answers
|
||||||
- **Search**
|
- **Search**
|
||||||
- **Natural**: Advanced natural language understanding using Transformer based ML Models
|
- **Natural**: Advanced natural language understanding using Transformer based ML Models
|
||||||
- **Incremental**: Incremental search for a fast, search-as-you-type experience
|
- **Incremental**: Incremental search for a fast, search-as-you-type experience
|
||||||
|
|||||||
9
documentation/docs/features/khoj_mini.md
Normal file
9
documentation/docs/features/khoj_mini.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# Desktop Quick Chat (Khoj Mini)
|
||||||
|
|
||||||
|
Once you have the Khoj [desktop application](https://khoj.dev/downloads) installed, you can use the desktop shortcut to quickly pull up a mini chat module for quicker answers. See the desktop setup instructions [in the docs](/clients/desktop.md) for more information.
|
||||||
|
|
||||||
|
To use it, you just have to copy the text you want to inject into your query, and then run `Ctrl + Shift + K` (or `Cmd + Shift + K` on Mac) to open the mini chat module. The text you copied will be automatically pasted into the chat module, and you can then hit enter to get the answer. You can edit the text before hitting enter if you want to refine your query.
|
||||||
|
|
||||||
|
The desktop shortcut is a great way to quickly get answers to your questions without having to switch between windows or tabs. It's especially useful when you're working on a project and need to quickly look up something without losing your focus.
|
||||||
|
|
||||||
|

|
||||||
@@ -1,51 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 2
|
|
||||||
---
|
|
||||||
|
|
||||||
# Demos
|
|
||||||
|
|
||||||
Check out a couple of demos and screenshots of Khoj in action.
|
|
||||||
|
|
||||||
### Screenshots
|
|
||||||
|
|
||||||
| Web | Obsidian | Emacs |
|
|
||||||
|:---:|:--------:|:-----:|
|
|
||||||
|  |  |  |
|
|
||||||
|  |  |  |
|
|
||||||
|
|
||||||
|
|
||||||
### Videos
|
|
||||||
#### Khoj in Obsidian
|
|
||||||
[Link to Video](https://github-production-user-asset-6210df.s3.amazonaws.com/6413477/240061700-3e33d8ea-25bb-46c8-a3bf-c92f78d0f56b.mp4)
|
|
||||||
|
|
||||||
##### Installation
|
|
||||||
|
|
||||||
1. Install Khoj via `pip` and start Khoj backend in a terminal (Run `khoj`)
|
|
||||||
```bash
|
|
||||||
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
|
|
||||||
- Let Khoj backend index the markdown, pdf, Github markdown 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)
|
|
||||||
|
|
||||||
#### Khoj in Emacs, Browser
|
|
||||||
[Link to Video](https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9087-a1ea194b8f4b.mp4)
|
|
||||||
|
|
||||||
##### Installation
|
|
||||||
|
|
||||||
- Install Khoj via pip
|
|
||||||
- Start Khoj app
|
|
||||||
- Add this readme and [khoj.el readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs) as org-mode for Khoj to index
|
|
||||||
- Search \"*Setup editor*\" on the Web and Emacs. Re-rank the results for better accuracy
|
|
||||||
- Top result is what we are looking for, the [section to Install Khoj.el on Emacs](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#2-Install-Khojel)
|
|
||||||
|
|
||||||
##### Analysis
|
|
||||||
|
|
||||||
- The results do not have any words used in the query
|
|
||||||
- *Based on the top result it seems the re-ranking model understands that Emacs is an editor?*
|
|
||||||
- The results incrementally update as the query is entered
|
|
||||||
- The results are re-ranked, for better accuracy, once user hits enter
|
|
||||||
@@ -27,10 +27,10 @@ keywords: ["khoj", "khoj ai", "khoj docs", "khoj documentation", "khoj features"
|
|||||||
Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's features.
|
Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's features.
|
||||||
|
|
||||||
- Khoj is an open source, personal AI
|
- Khoj is an open source, personal AI
|
||||||
- You can [chat](/features/chat) with it about anything. It'll use files you shared with it to respond, when relevant
|
- You can [chat](/features/chat) with it about anything. It'll use files you shared with it to respond, when relevant. It can also access information from the public internet.
|
||||||
- Quickly [find](/features/search) relevant notes and documents using natural language
|
- Quickly [find](/features/search) relevant notes and documents using natural language
|
||||||
- It understands pdf, plaintext, markdown, org-mode files, [notion pages](/data-sources/notion_integration) and [github repositories](/data-sources/github_integration)
|
- It understands pdf, plaintext, markdown, org-mode files, [notion pages](/data-sources/notion_integration) and [github repositories](/data-sources/github_integration)
|
||||||
- Access it from your [Emacs](/clients/emacs), [Obsidian](/clients/obsidian), [Web browser](/clients/web) or the [Khoj Desktop app](/clients/desktop)
|
- Access it from your [Emacs](/clients/emacs), [Obsidian](/clients/obsidian), the [Khoj desktop app](/clients/desktop), or [any web browser](/clients/web)
|
||||||
- Use [cloud](https://app.khoj.dev/login) to access your Khoj anytime from anywhere, [self-host](/get-started/setup) on consumer hardware for privacy
|
- Use [cloud](https://app.khoj.dev/login) to access your Khoj anytime from anywhere, [self-host](/get-started/setup) on consumer hardware for privacy
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
@@ -39,13 +39,3 @@ Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's
|
|||||||
|
|
||||||
## At a Glance
|
## At a Glance
|
||||||

|

|
||||||
|
|
||||||
#### [Search](/features/search)
|
|
||||||
- **Natural**: Use natural language queries to quickly find relevant notes and documents.
|
|
||||||
- **Incremental**: Incremental search for a fast, search-as-you-type experience
|
|
||||||
|
|
||||||
#### [Chat](/features/chat)
|
|
||||||
- **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
|
|
||||||
- **Online or Offline**: Choose online or offline chat depending on your requirements
|
|
||||||
|
|||||||
@@ -22,6 +22,8 @@ Self-hosting isn't for everyone, so we've still taken steps to make Khoj privacy
|
|||||||
1. Your embeddings and the associated raw text are stored in a secure Postgres DB in our private AWS cloud. Your data is sharded on a unique user ID. We store the raw text in your files to improve file syncing and provide context when you chat with Khoj.
|
1. Your embeddings and the associated raw text are stored in a secure Postgres DB in our private AWS cloud. Your data is sharded on a unique user ID. We store the raw text in your files to improve file syncing and provide context when you chat with Khoj.
|
||||||
1. When you use the single-sign-on option with Google, we only receive your name, a link to your profile photo, and your email address.
|
1. When you use the single-sign-on option with Google, we only receive your name, a link to your profile photo, and your email address.
|
||||||
|
|
||||||
|
You can see our full privacy policy [here](https://khoj.dev/privacy-policy).
|
||||||
|
|
||||||
|
|
||||||
:::tip[Info]
|
:::tip[Info]
|
||||||
Your data is yours. We do not sell your data or use it for training models. Khoj is a sustainable, open-source alternative to closed-source, commercial personal AI. We have no interest in selling your data to make a quick buck.
|
Your data is yours. We do not sell your data or use it for training models. Khoj is a sustainable, open-source alternative to closed-source, commercial personal AI. We have no interest in selling your data to make a quick buck.
|
||||||
|
|||||||
Reference in New Issue
Block a user