diff --git a/README.md b/README.md index 5a968128..6887fe71 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ [Khoj](https://khoj.dev) is a personal AI app to extend your capabilities. It smoothly scales up from an on-device personal AI to a cloud-scale enterprise AI. -- Chat with any local or online LLM (e.g llama3, qwen, gemma, mistral, gpt, claude, gemini). +- Chat with any local or online LLM (e.g llama3, qwen, gemma, mistral, gpt, claude, gemini, deepseek). - Get answers from the internet and your docs (including image, pdf, markdown, org-mode, word, notion files). - Access it from your Browser, Obsidian, Emacs, Desktop, Phone or Whatsapp. - Create agents with custom knowledge, persona, chat model and tools to take on any role. @@ -71,6 +71,19 @@ To get started with self-hosting Khoj, [read the docs](https://docs.khoj.dev/get Khoj is available as a cloud service, on-premises, or as a hybrid solution. To learn more about Khoj Enterprise, [visit our website](https://khoj.dev/teams). +## Frequently Asked Questions (FAQ) + +Q: Can I use Khoj without self-hosting? +Yes! You can use Khoj right away at [https://app.khoj.dev](https://app.khoj.dev) — no setup required. + +Q: What kinds of documents can Khoj read? +Khoj supports a wide variety: PDFs, Markdown, Notion, Word docs, org-mode files, and more. + +Q: How can I make my own agent? +Check out [this blog post](https://blog.khoj.dev/posts/create-agents-on-khoj/) for a step-by-step guide to custom agents. +For more questions, head over to our [Discord](https://discord.gg/BDgyabRM6e)! + + ## Contributors Cheers to our awesome contributors! 🎉 diff --git a/documentation/docs/advanced/gcp-vertex.md b/documentation/docs/advanced/gcp-vertex.md index 7069fc33..da9ac771 100644 --- a/documentation/docs/advanced/gcp-vertex.md +++ b/documentation/docs/advanced/gcp-vertex.md @@ -24,3 +24,22 @@ Khoj can use Google's Gemini and Anthropic's Claude family of AI models from [Ve - **Max prompt size**: `60000` (replace with the max prompt size of your model) - **Tokenizer**: *Do not set* 5. Select the chat model on [your settings page](http://localhost:42110/settings) and start a conversation. + +## Troubleshooting & gcp AI Tips + +- Permission Denied? + Ensure your service account has the `Vertex AI User` role and that the API is enabled in your GCP project. + +- Region Errors? + Double-check that the model you're trying to use is supported in your selected region. Some Claude or Gemini models are restricted to specific zones like `us-east5` or `us-central1`. + +- Prompt Size Limitations + The "Max prompt size" should align with the limits defined in the model documentation. Exceeding it can silently fail or truncate inputs. + +- Testing the API Key + Before adding it to Khoj, you can verify that your key works by making a simple curl request to Vertex AI. This helps debug auth issues early. + +- Use Environment Variables + For better security, consider using environment variables to manage sensitive keys and inject them at runtime during base64 encoding. + +If you encounter any issues, the [Khoj Discord](https://discord.gg/BDgyabRM6e) is a great place to ask for help!