diff --git a/documentation/docs/advanced/gcp-vertex.md b/documentation/docs/advanced/gcp-vertex.md new file mode 100644 index 00000000..7069fc33 --- /dev/null +++ b/documentation/docs/advanced/gcp-vertex.md @@ -0,0 +1,26 @@ +# Google Vertex AI +:::info +This is only helpful for self-hosted users. If you're using [Khoj Cloud](https://app.khoj.dev), you can directly use any of the pre-configured AI models. +::: + +Khoj can use Google's Gemini and Anthropic's Claude family of AI models from [Vertex AI](https://cloud.google.com/vertex-ai) on Google Cloud. Explore Anthropic and Gemini AI models available on Vertex AI's [Model Garden](https://console.cloud.google.com/vertex-ai/model-garden). + +## Setup +1. Follow [these instructions](https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/use-claude#before_you_begin) to use models on GCP Vertex AI. +2. Create [Service Account](https://console.cloud.google.com/apis/credentials/serviceaccountkey) credentials. + - Download the credentials keyfile in json format. + - Base64 encode the credentials json keyfile. For example by running the following command from your terminal: + `base64 -i ` +3. Create a new [API Model API](http://localhost:42110/server/admin/database/aimodelapi/add) on your Khoj admin panel. + - **Name**: `Google Vertex` (or whatever friendly name you prefer). + - **Api Key**: `base64 encoded json keyfile` from step 2. + - **Api Base Url**: `https://{MODEL_GCP_REGION}-aiplatform.googleapis.com/v1/projects/{YOUR_GCP_PROJECT_ID}` + - MODEL_GCP_REGION: A region the AI model is available in. For example `us-east5` works for [Claude](https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/use-claude#regions). + - YOUR_GCP_PROJECT_ID: Get your project id from the [Google cloud dashboard](https://console.cloud.google.com/home/dashboard) +4. Create a new [Chat Model](http://localhost:42110/server/admin/database/chatmodel/add) on your Khoj admin panel. + - **Name**: `claude-3-7-sonnet@20250219`. Any Claude or Gemini model on Vertex's Model Garden should work. + - **Model Type**: `Anthropic` or `Google` + - **Ai Model API**: *the Google Vertex Ai Model API you created in step 3* + - **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.