sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-04 12:53:01 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
khoj/documentation/docs/features/chat.md

65 lines
3.9 KiB
Markdown
Raw Normal View History

Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 15:58:15 +01:00
---
sidebar_position: 2
---
# Chat
You can configure Khoj to chat with you about anything. When relevant, it'll use any notes or documents you shared with it to respond.
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 02:25:52 +01:00
### 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 07:34:25 +02: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 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 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-17 00:26:03 +01:00
### Setup (Self-Hosting)
Update docs with setup instructions for Offline and Online Chat
2023-07-29 19:49:40 +02:00
#### Offline Chat
Update docs to show how to setup llama-cpp with Khoj - How to pip install khoj to run offline chat on GPU After migration to llama-cpp-python more GPU types are supported but require build step so mention how - New default offline chat model - Where to get supported chat models from on HuggingFace
2024-03-15 23:55:14 +01:00
Offline chat stays completely private and can work 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 07:34:25 +02:00
Document system requirements to run offline chat Closes #375
2023-10-17 04:39:06 +02:00
> **System Requirements**:
Update system requirements in docs for offline chat models
2023-10-23 03:43:02 +02: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 04:39:06 +02:00
> - A CPU supporting [AVX or AVX2 instructions](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) is required
Update docs to show how to setup llama-cpp with Khoj - How to pip install khoj to run offline chat on GPU After migration to llama-cpp-python more GPU types are supported but require build step so mention how - New default offline chat model - Where to get supported chat models from on HuggingFace
2024-03-15 23:55:14 +01:00
> - An Nvidia, AMD GPU or a Mac M1+ machine would 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
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-17 00:26:03 +01:00
1. Open your [Khoj offline settings](http://localhost:42110/server/admin/database/offlinechatprocessorconversationconfig/) and click *Enable* on the Offline Chat configuration.
Fix docs showing how to setup llama-cpp with Khoj
2024-03-31 12:05:22 +02:00
2. Open your [Chat model options settings](http://localhost:42110/server/admin/database/chatmodeloptions/) and add any [GGUF chat model](https://huggingface.co/models?library=gguf) to use for offline chat. Make sure to use `Offline` as its type. For a balanced chat model that runs well on standard consumer hardware we recommend using [Hermes-2-Pro-Mistral-7B by NousResearch](https://huggingface.co/NousResearch/Hermes-2-Pro-Mistral-7B-GGUF) by default.
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
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 15:58:15 +01:00
:::tip[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 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.
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 15:58:15 +01:00
:::danger[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)
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-17 00:26:03 +01: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 19:49:40 +02:00
### 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
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-17 00:26:03 +01: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 19:43:17 +02: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>`
Make the docs overview page as the main docs landing page - Make the docs overview page available at docs.khoj.dev root instead of under docs.khoj.dev/docs path - Remove the new landing page, it is unnecessary. - Remove /docs path prefix from links to internal doc pages - Remove .md path suffix in internal doc pages for consistency
2024-01-07 20:02:23 +01:00
2. Enter your queries to chat with Khoj. Use [slash commands](#commands) and [query filters](/miscellaneous/advanced#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
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 15:58:15 +01:00
![](/img/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
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 15:58:15 +01:00
- **/online**: Use online information and incorporate it in the prompt to the LLM to send you a response.
- **/image**: Generate an image in response to your query.
Document slash command and query filter in docs for chat and search
2023-08-28 19:43:17 +02:00
- **/help**: Use /help to get all available commands and general information about Khoj
Reference in a new issue Copy permalink