sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-18 10:37:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 23
khoj/docs/chat.md

51 lines
3.6 KiB
Markdown
Raw Normal View History

Simplify setup, features since Khoj cloud in docs - No Khoj server setup required to start using Khoj from Obsidian, Emacs - Use tabs for install, upgrade in Emacs with different package managers - Use default subtitles in Khoj Docs - Deduplicate query filters, remove backend setup instructions in plugin pages - Remove stale Setup demo on Khoj Obsidian plugin docs
2023-11-19 01:25:52 +00:00
## Khoj Chat
### Overview
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
- Creates a personal assistant for you to inquire and engage with your notes
Update docs with setup instructions for Offline and Online Chat
2023-07-29 17:49:40 +00:00
- You can choose to use Online or Offline Chat depending on your requirements
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
- Supports multi-turn conversations with the relevant notes for context
- Shows reference notes used to generate a response
Fix diff blocks, links, remove footnotes & rearrange sections in docs Extract performance into separate sectin into shoving it under search Create page for web interface
2023-07-21 07:05:44 +00:00
Update references to all documentation to reflect instructions for managed service - By default assume the audience of this website is people looking to understand the featuer offering of Khoj, and then people who are looking to self-host
2023-11-16 23:26:03 +00:00
### Setup (Self-Hosting)
Update docs with setup instructions for Offline and Online Chat
2023-07-29 17:49:40 +00:00
#### Offline Chat
Update references to all documentation to reflect instructions for managed service - By default assume the audience of this website is people looking to understand the featuer offering of Khoj, and then people who are looking to self-host
2023-11-16 23:26:03 +00:00
Offline chat stays completely private and works without internet using open-source models.
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Document system requirements to run offline chat Closes #375
2023-10-17 02:39:06 +00:00
> **System Requirements**:
Update system requirements in docs for offline chat models
2023-10-23 01:43:02 +00:00
> - Minimum 8 GB RAM. Recommend **16Gb VRAM**
> - Minimum **5 GB of Disk** available
Document system requirements to run offline chat Closes #375
2023-10-17 02:39:06 +00:00
> - 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
Fix diff blocks, links, remove footnotes & rearrange sections in docs Extract performance into separate sectin into shoving it under search Create page for web interface
2023-07-21 07:05:44 +00:00
Update references to all documentation to reflect instructions for managed service - By default assume the audience of this website is people looking to understand the featuer offering of Khoj, and then people who are looking to self-host
2023-11-16 23:26:03 +00:00
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`.
Fix diff blocks, links, remove footnotes & rearrange sections in docs Extract performance into separate sectin into shoving it under search Create page for web interface
2023-07-21 07:05:44 +00:00
Update references to all documentation to reflect instructions for managed service - By default assume the audience of this website is people looking to understand the featuer offering of Khoj, and then people who are looking to self-host
2023-11-16 23:26:03 +00:00
!> **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.
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Update docs with setup instructions for Offline and Online Chat
2023-07-29 17:49:40 +00:00
#### Online Chat
Online chat requires internet to use ChatGPT but is faster, higher quality and less compute intensive.
Document system requirements to run offline chat Closes #375
2023-10-17 02:39:06 +00:00
!> **Warning**: This will enable Khoj to send your chat queries and query relevant notes to OpenAI for processing
Update docs with setup instructions for Offline and Online Chat
2023-07-29 17:49:40 +00:00
1. Get your [OpenAI API Key](https://platform.openai.com/account/api-keys)
Update references to all documentation to reflect instructions for managed service - By default assume the audience of this website is people looking to understand the featuer offering of Khoj, and then people who are looking to self-host
2023-11-16 23:26:03 +00:00
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.
Update docs with setup instructions for Offline and Online Chat
2023-07-29 17:49:40 +00:00
### Use
Document slash command and query filter in docs for chat and search
2023-08-28 17:43:17 +00:00
1. Open Khoj Chat
Update references to all documentation to reflect instructions for managed service - By default assume the audience of this website is people looking to understand the featuer offering of Khoj, and then people who are looking to self-host
2023-11-16 23:26:03 +00:00
- **On Web**: Open [/chat](https://app.khoj.dev/chat) in your web browser
Document slash command and query filter in docs for chat and search
2023-08-28 17:43:17 +00:00
- **On Obsidian**: Search for *Khoj: Chat* in the [Command Palette](https://help.obsidian.md/Plugins/Command+palette)
- **On Emacs**: Run `M-x khoj <user-query>`
2. Enter your queries to chat with Khoj. Use [slash commands](#commands) and [query filters](./advanced.md#query-filters) to change what Khoj uses to respond
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Update Screenshots and Demos in Docs
2023-07-21 22:22:35 +00:00
![](./assets/khoj_chat_on_web.png ':size=400px')
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Update docs with setup instructions for Offline and Online Chat
2023-07-29 17:49:40 +00:00
#### Details
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
1. Your query is used to retrieve the most relevant notes, if any, using Khoj search
Update docs with setup instructions for Offline and Online Chat
2023-07-29 17:49:40 +00:00
2. These notes, the last few messages and associated metadata is passed to the enabled chat model along with your query to generate a response
Document slash command and query filter in docs for chat and search
2023-08-28 17:43:17 +00:00
#### Commands
Slash commands allows you to change what Khoj uses to respond to your query
- **/notes**: Limit chat to only respond using your notes, not just Khoj's general world knowledge as reference
- **/general**: Limit chat to only respond using Khoj's general world knowledge, not using your notes as reference
- **/default**: Allow chat to respond using your notes or it's general knowledge as reference. It's the default behavior when no slash command is used
- **/help**: Use /help to get all available commands and general information about Khoj
Reference in a new issue Copy permalink