mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-02 21:19:12 +00:00
dc398d30f8
Added a “Troubleshooting & Tips” section to the GCP Vertex documentation. This section provides guidance for self-hosted users on common issues they may encounter when setting up Google Vertex AI integration in Khoj. Topics covered include permissions, region compatibility, prompt size limits, API key testing, and secure key management with environment variables. The goal is to improve the onboarding experience and reduce setup errors for contributors and self-hosters using Vertex AI models like Claude and Gemini. Signed off by: brightally6@gmail.com
99 lines
4.1 KiB
Markdown
99 lines
4.1 KiB
Markdown
<p align="center"><img src="https://assets.khoj.dev/khoj-logo-sideways-1200x540.png" width="230" alt="Khoj Logo"></p>
|
|
|
|
<div align="center">
|
|
|
|
[](https://github.com/khoj-ai/khoj/actions/workflows/test.yml)
|
|
[](https://github.com/khoj-ai/khoj/pkgs/container/khoj)
|
|
[](https://pypi.org/project/khoj/)
|
|
[](https://discord.gg/BDgyabRM6e)
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
<b>Your AI second brain</b>
|
|
</div>
|
|
|
|
<br />
|
|
|
|
<div align="center">
|
|
|
|
[📑 Docs](https://docs.khoj.dev)
|
|
<span> • </span>
|
|
[🌐 Web](https://khoj.dev)
|
|
<span> • </span>
|
|
[🔥 App](https://app.khoj.dev)
|
|
<span> • </span>
|
|
[💬 Discord](https://discord.gg/BDgyabRM6e)
|
|
<span> • </span>
|
|
[✍🏽 Blog](https://blog.khoj.dev)
|
|
|
|
</div>
|
|
|
|
***
|
|
|
|
### 🎁 New
|
|
* Start any message with `/research` to try out the experimental research mode with Khoj.
|
|
* Anyone can now [create custom agents](https://blog.khoj.dev/posts/create-agents-on-khoj/) with tunable personality, tools and knowledge bases.
|
|
* [Read](https://blog.khoj.dev/posts/evaluate-khoj-quality/) about Khoj's excellent performance on modern retrieval and reasoning benchmarks.
|
|
|
|
***
|
|
|
|
## Overview
|
|
|
|
[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, 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.
|
|
- Automate away repetitive research. Get personal newsletters and smart notifications delivered to your inbox.
|
|
- Find relevant docs quickly and easily using our advanced semantic search.
|
|
- Generate images, talk out loud, play your messages.
|
|
- Khoj is open-source, self-hostable. Always.
|
|
- Run it privately on [your computer](https://docs.khoj.dev/get-started/setup) or try it on our [cloud app](https://app.khoj.dev).
|
|
|
|
***
|
|
|
|
## See it in action
|
|
|
|
|
|
|
|
Go to https://app.khoj.dev to see Khoj live.
|
|
|
|
## Full feature list
|
|
You can see the full feature list [here](https://docs.khoj.dev/category/features).
|
|
|
|
## Self-Host
|
|
|
|
To get started with self-hosting Khoj, [read the docs](https://docs.khoj.dev/get-started/setup).
|
|
|
|
## Enterprise
|
|
|
|
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! 🎉
|
|
|
|
<a href="https://github.com/khoj-ai/khoj/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=khoj-ai/khoj" />
|
|
</a>
|
|
|
|
Made with [contrib.rocks](https://contrib.rocks).
|
|
|
|
### Interested in Contributing?
|
|
|
|
We are always looking for contributors to help us build new features, improve the project documentation, or fix bugs. If you're interested, please see our [Contributing Guidelines](https://docs.khoj.dev/contributing/development) and check out our [Contributors Project Board](https://github.com/orgs/khoj-ai/projects/4).
|