diff --git a/documentation/assets/img/dream_house.png b/documentation/assets/img/dream_house.png new file mode 100644 index 00000000..adfc9a37 Binary files /dev/null and b/documentation/assets/img/dream_house.png differ diff --git a/documentation/assets/img/plants_i_got.png b/documentation/assets/img/plants_i_got.png new file mode 100644 index 00000000..72e0d193 Binary files /dev/null and b/documentation/assets/img/plants_i_got.png differ diff --git a/documentation/assets/img/using_khoj_for_studying.gif b/documentation/assets/img/using_khoj_for_studying.gif new file mode 100644 index 00000000..898a3710 Binary files /dev/null and b/documentation/assets/img/using_khoj_for_studying.gif differ diff --git a/documentation/docs/features/agents.md b/documentation/docs/features/agents.md index 31884907..249f5bde 100644 --- a/documentation/docs/features/agents.md +++ b/documentation/docs/features/agents.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- # Agents diff --git a/documentation/docs/features/all_features.md b/documentation/docs/features/all_features.md index c482805b..3d3b8941 100644 --- a/documentation/docs/features/all_features.md +++ b/documentation/docs/features/all_features.md @@ -2,7 +2,7 @@ sidebar_position: 1 --- -# Features +# Overview Khoj supports a variety of features, including search and chat with a wide range of data sources and interfaces. diff --git a/documentation/docs/features/image_generation.md b/documentation/docs/features/image_generation.md new file mode 100644 index 00000000..181b17f1 --- /dev/null +++ b/documentation/docs/features/image_generation.md @@ -0,0 +1,15 @@ +# Image Generation +You can use Khoj to generate images from text prompts. You can get deeper into the details of our image generation flow in this blog post: https://blog.khoj.dev/posts/how-khoj-generates-images/. + +To generate images, you just need to provide a prompt to Khoj in which the image generation is in the instructions. Khoj will automatically detect the image generation intent, augment your generation prompt, and then create the image. Here are some examples: +| Prompt | Image | +| --- | --- | +| Paint a picture of the plants I got last month, pixar-animation | ![plants](/img/plants_i_got.png) | +| Create a picture of my dream house, based on my interests | ![house](/img/dream_house.png) | + + +## Setup (Self-Hosting) + +Right now, we only support integration with OpenAI's DALL-E. You need to have an OpenAI API key to use this feature. Here's how you can set it up: +1. Setup your OpenAI API key. See instructions [here](./get-started/setup#2-configure) +2. Create a text to image config at http://localhost:42110/server/admin/database/texttoimagemodelconfig/. We recommend the value `dall-e-3`. diff --git a/documentation/docs/features/voice_chat.md b/documentation/docs/features/voice_chat.md new file mode 100644 index 00000000..f0024857 --- /dev/null +++ b/documentation/docs/features/voice_chat.md @@ -0,0 +1,14 @@ +# Voice + +You can talk to Khoj using your voice. Khoj will respond to your queries using the same models as the chat feature. You can use voice chat on the web, Desktop, and Obsidian apps. Click on the little mic icon to send your voice message to Khoj. It will send back what it heard via text. You'll have some time to edit it before sending it, if required. Try it at https://app.khoj.dev/. + +:::info[Voice Response] +Khoj doesn't yet respond with voice, but it will send back a text response. Let us know if you're interested in voice responses at team at khoj.dev. +::: + +## Setup (Self-Hosting) + +Voice chat will automatically be configured when you initialize the application. The default configuration will run locally. If you want to use the OpenAI whisper API for voice chat, you can set it up by following these steps: + +1. Setup your OpenAI API key. See instructions [here](./get-started/setup#2-configure). +2. Create a new configuration at http://localhost:42110/server/admin/database/speechtotextmodeloptions/. We recommend the value `whisper-1` and model type `Openai`. diff --git a/documentation/docs/get-started/overview.md b/documentation/docs/get-started/overview.md index 4b571226..b0d2a51c 100644 --- a/documentation/docs/get-started/overview.md +++ b/documentation/docs/get-started/overview.md @@ -37,9 +37,7 @@ Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's - [Read these instructions](/get-started/setup) to self-host a private instance of Khoj ## At a Glance - -   - +![demo_chat](/img/using_khoj_for_studying.gif) #### [Search](/features/search) - **Natural**: Use natural language queries to quickly find relevant notes and documents. diff --git a/documentation/docs/get-started/setup.mdx b/documentation/docs/get-started/setup.mdx index 7a1551f3..7d547935 100644 --- a/documentation/docs/get-started/setup.mdx +++ b/documentation/docs/get-started/setup.mdx @@ -25,6 +25,10 @@ These are the general setup instructions for self-hosted Khoj. For Installation, you can either use Docker or install the Khoj server locally. +:::info[Offline Model + GPU] +If you want to use the offline chat model and you have a GPU, you should use Installation Option 2 - local setup via the Python package directly. Our Docker image doesn't currently support running the offline chat model on GPU, making inference times really slow. +::: + ### Installation Option 1 (Docker) #### Prerequisites