diff --git a/documentation/assets/img/mic_chat_icon.png b/documentation/assets/img/mic_chat_icon.png new file mode 100644 index 00000000..0bf64de6 Binary files /dev/null and b/documentation/assets/img/mic_chat_icon.png differ diff --git a/documentation/assets/img/speaker_icon.png b/documentation/assets/img/speaker_icon.png new file mode 100644 index 00000000..cdf7e002 Binary files /dev/null and b/documentation/assets/img/speaker_icon.png differ diff --git a/documentation/docs/features/automations.md b/documentation/docs/features/automations.md index 7284e1ea..1c057d48 100644 --- a/documentation/docs/features/automations.md +++ b/documentation/docs/features/automations.md @@ -5,5 +5,5 @@ Khoj will use your local time zone to determine the scheduling localization. You can go back and configure the prompt any time you want from the automations page. You can also delete the automation if you no longer need it. :::danger[Note] -Automations will not deliver emails to self-hosted users out of the box. You'll have to have Resend and [Google Auth](/miscellaneous/google_auth) setup to send emails. +Automations will not deliver emails to self-hosted users out of the box. You'll have to have Resend and [Authentication](/miscellaneous/authentication) setup to send emails. ::: diff --git a/documentation/docs/features/voice_chat.md b/documentation/docs/features/voice_chat.md index 370a1737..86c85189 100644 --- a/documentation/docs/features/voice_chat.md +++ b/documentation/docs/features/voice_chat.md @@ -1,10 +1,16 @@ # 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/. +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. -:::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. -::: +![Voice Chat](/img/mic_chat_icon.png) + +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/. + +## Voice Response + +When you get a response from Khoj, you can click on the speaker icon to hear the response. This feature is available only on the web view right now. + +![Speaker Icon](/img/speaker_icon.png) ## Setup (Self-Hosting) @@ -12,3 +18,9 @@ Voice chat will automatically be configured when you initialize the application. 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`. + +If you want to use the Text to Speech feature, you can set it up by following these steps: + +1. Setup your account on [ElevenLabs.io](https://elevenlabs.io/). +2. Configure your API key in your environment variables with the key `ELEVEN_LABS_API_KEY`. +2. (Optional) Create a new [Voice model option](http://localhost:42110/server/admin/database/voicemodeloption/) with a specific voice ID from whichever voice you want to use. You can explore the options [here](https://elevenlabs.io/app/voice-library).