sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-27 17:35:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make some basic updates to the chat documentation. Inc. conversation file filters, new screenshot

Browse source
This commit is contained in:
sabaimran 2024-06-18 12:14:59 +05:30
parent 76e1bed8f9
commit 327045be43
3 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
documentation/assets/img/khoj_chat_on_web.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 358 KiB

After

Width:  |  Height:  |  Size: 187 KiB

BIN
documentation/assets/img/select_file_filter.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 31 KiB

12
documentation/docs/features/chat.md
View file

@ -4,10 +4,12 @@ sidebar_position: 2
# Chat # 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. 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. It acts as an excellent research assistant, search engine, or personal tutor.
<img src="/img/khoj_chat_on_web.png" alt="Chat on Web" style={{width: '400px'}}/>
### Overview ### Overview
- Creates a personal assistant for you to inquire and engage with your notes - Creates a personal assistant for you to inquire and engage with your notes or online information as needed
- You can choose to use Online or Offline Chat depending on your requirements - You can choose to use Online or Offline Chat depending on your requirements
- Supports multi-turn conversations with the relevant notes for context - Supports multi-turn conversations with the relevant notes for context
- Shows reference notes used to generate a response - Shows reference notes used to generate a response
@ -48,12 +50,16 @@ This will enable Khoj to send your chat queries and query relevant notes to Open
- **On Emacs**: Run `M-x khoj <user-query>` - **On Emacs**: Run `M-x khoj <user-query>`
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 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
![](/img/khoj_chat_on_web.png ':size=400px')
#### Details #### Details
1. Your query is used to retrieve the most relevant notes, if any, using Khoj search 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 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
#### Conversation File Filters
You can use conversation file filters to limit the notes used in the chat response. To do so, use the left panel in the web UI. Alternatively, you can also use [query filters](/miscellaneous/advanced#query-filters) to limit the notes used in the chat response.
<img src="/img/select_file_filter.png" alt="Conversation File Filter" style={{width: '400px'}}/>
#### Commands #### Commands
Slash commands allows you to change what Khoj uses to respond to your query 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 - **/notes**: Limit chat to only respond using your notes, not just Khoj's general world knowledge as reference