khoj/docs/chat.md

### 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
#### Offline Chat
Offline chat stays completely private and works without internet. But it is slower, lower quality and more compute intensive.

> **System Requirements**:
>  - Machine with at least **6 GB of RAM** and **4 GB of Disk** available
>  - 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

![Configure offline chat](https://user-images.githubusercontent.com/6413477/257021364-8a2029f5-dc21-4de8-9af9-9ba6100d695c.mp4 ':include :type=mp4')

#### Online Chat
Online chat requires internet to use ChatGPT but is faster, higher quality and less compute intensive.

!> **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.

![Configure online chat](https://user-images.githubusercontent.com/6413477/256998908-ac26e55e-13a2-45fb-9348-3b90a62f7687.mp4 ':include :type=mp4')


### Use
1. Open Khoj Chat
    - **On Web**: Open [/chat](http://localhost:42110/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 <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

![](./assets/khoj_chat_on_web.png ':size=400px')

#### Details
1. Your query is used to retrieve the most relevant notes, if any, using Khoj search
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

#### 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
📝 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 07:34:25 +02:00			`### Khoj Chat`
			`#### Overview`
			`- 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 19:49:40 +02: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 07:34:25 +02: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 09:05:44 +02:00
Update docs with setup instructions for Offline and Online Chat 2023-07-29 19:49:40 +02:00			`### Setup`
			`#### Offline Chat`
Document system requirements to run offline chat Closes #375 2023-10-17 04:39:06 +02:00			`Offline chat stays completely private and works without internet. But it is slower, lower quality and more compute intensive.`
📝 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 07:34:25 +02:00
Document system requirements to run offline chat Closes #375 2023-10-17 04:39:06 +02:00			`> System Requirements:`
Set >=6Gb RAM required for offline chat Llama v2 7B with 4bit quantization technically needs ~3.5Gb RAM (7B * 0.5byte), practically a system with 6Gb of RAM should suffice 2023-10-18 21:05:54 +02:00			`> - Machine with at least 6 GB of RAM and 4 GB of Disk available`
Document system requirements to run offline chat Closes #375 2023-10-17 04:39:06 +02: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 09:05:44 +02:00
Document system requirements to run offline chat Closes #375 2023-10-17 04:39:06 +02:00			`- Open your [Khoj settings](http://localhost:42110/config/) and click Enable on the Offline Chat card`
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 09:05:44 +02:00
Update demo video to configure offline chat via the web interface 2023-07-30 04:17:40 +02:00			`![Configure offline chat](https://user-images.githubusercontent.com/6413477/257021364-8a2029f5-dc21-4de8-9af9-9ba6100d695c.mp4 ':include :type=mp4')`
📝 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 07:34:25 +02:00
Update docs with setup instructions for Offline and Online Chat 2023-07-29 19:49:40 +02: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 04:39:06 +02: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 19:49:40 +02:00
			`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.

			`![Configure online chat](https://user-images.githubusercontent.com/6413477/256998908-ac26e55e-13a2-45fb-9348-3b90a62f7687.mp4 ':include :type=mp4')`


			`### Use`
Document slash command and query filter in docs for chat and search 2023-08-28 19:43:17 +02:00			`1. Open Khoj Chat`
			`- On Web: Open [/chat](http://localhost:42110/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 <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 07:34:25 +02:00
Update Screenshots and Demos in Docs 2023-07-22 00:22:35 +02: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 07:34:25 +02:00
Update docs with setup instructions for Offline and Online Chat 2023-07-29 19:49:40 +02: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 07:34:25 +02: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 19:49:40 +02: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 19:43:17 +02: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`