Skip to content

Commit

Permalink
Creates "Connect to Google vertex" llm connector guide (#5475)
Browse files Browse the repository at this point in the history
* Implements changes from ESS PR

* fixes broken id-based links

* updates docnav

* minor bugfix

* Adds google vertex LLM connector setup guide

* minor fix

* incorporates Charles' review

* bugfix

* incorporates Nat's review

* incorporates Nat's review

* incorporates reviews
  • Loading branch information
benironside authored Jun 25, 2024
1 parent e3b8fbb commit 2fb51b1
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/serverless/assistant/connect-to-openai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The following video demonstrates these steps.

## Configure the OpenAI connector

To integrate with ((kib)):
Finally, configure the connector in ((kib)):

1. Log in to ((kib)).
2. Navigate to **Stack Management → Connectors → Create Connector → OpenAI**.
Expand Down
67 changes: 67 additions & 0 deletions docs/serverless/assistant/connect-to-vertex.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
slug: /serverless/security/connect-to-google-vertex
title: Connect to Google Vertex AI
description: Set up a Google Vertex LLM connector.
tags: ["security", "overview", "get-started"]
status: in review
---

This page provides step-by-step instructions for setting up a Google Vertex AI connector for the first time. This connector type enables you to leverage Vertex AI's large language models (LLMs) within ((elastic-sec)). You'll first need to enable Vertex AI, then generate an API key, and finally configure the connector in your ((elastic-sec)) project.

<DocCallOut title="Important">
Before continuing, you should have an active project in one of Google Vertex AI's [supported regions](https://cloud.google.com/vertex-ai/docs/general/locations#feature-availability).
</DocCallOut>

## Enable the Vertex AI API

1. Log in to the GCP console and navigate to **Vertex AI → Vertex AI Studio → Overview**.
2. If you're new to Vertex AI, the **Get started with Vertex AI Studio** popup appears. Click **Vertex AI API**, then click **ENABLE**.

The following video demonstrates these steps.

<DocVideo source="vidyard" id="vFhtbiCZiKhvdZGy2FjyeT"/>

<DocCallOut title="Note">
For more information about enabling the Vertex AI API, refer to [Google's documentation](https://cloud.google.com/vertex-ai/docs/start/cloud-environment).
</DocCallOut>

## Create a Vertex AI service account

1. In the GCP console, navigate to **APIs & Services → Library**.
2. Search for **Vertex AI API**, select it, and click **MANAGE**.
3. In the left menu, navigate to **Credentials** then click **+ CREATE CREDENTIALS** and select **Service account**.
4. Name the new service account, then click **CREATE AND CONTINUE**.
5. Under **Select a role**, select **Vertex AI User**, then click **CONTINUE**.
6. Click **Done**.

The following video demonstrates these steps.

<DocVideo source="vidyard" id="tmresYYiags2w2nTv3Gac8"/>

## Generate an API key

1. Return to Vertex AI's **Credentials** menu and click **Manage service accounts**.
2. Search for the service account you just created, select it, then click the link that appears under **Email**.
3. Go to the **KEYS** tab, click **ADD KEY**, then select **Create new key**.
4. Select **JSON**, then click **CREATE** to download the key. Keep it somewhere secure.

The following video demonstrates these steps.

<DocVideo source="vidyard" id="hrcy3F9AodwhJcV1i2yqbG"/>

## Configure the Google Gemini connector

Finally, configure the connector in ((kib)):

1. Log in to ((kib)).
2. Navigate to **Stack Management → Connectors → Create Connector → Google Gemini**.
3. Name your connector to help keep track of the model version you are using.
4. Under **URL**, enter the URL for your region.
5. Enter your **GCP Region** and **GCP Project ID**.
6. Under **Default model**, specify either `gemini-1.5.pro` or `gemini-1.5-flash`. [Learn more about the models](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models).
7. Under **Authentication**, enter your API key.
8. Click **Save**.

The following video demonstrates these steps.

<DocVideo source="vidyard" id="8L2WPm2HKN1cH872Gs5uvL"/>
4 changes: 3 additions & 1 deletion docs/serverless/assistant/llm-connector-guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,6 @@ Setup guides are available for the following LLM providers:

* <DocLink slug="/serverless/security/connect-to-azure-openai" text="Azure OpenAI"/>
* <DocLink slug="/serverless/security/connect-to-bedrock" text="Amazon Bedrock"/>
* <DocLink slug="/serverless/security/connect-to-openai" text="OpenAI"/>
* <DocLink slug="/serverless/security/connect-to-openai" text="OpenAI"/>
* <DocLink slug="/serverless/security/connect-to-google-vertex" text="Google Vertex"/>

Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ From a discovery on the Attack discovery page, click **View in AI Assistant** to

AI Assistant can quickly compile essential data and provide suggestions to help you generate an incident report and plan an effective response. You can ask it to provide relevant data or answer questions, such as “How can I remediate this threat?” or “What ((esql)) query would isolate actions taken by this user?”


<DocImage url="images/attck-disc-esql-query-gen-example.png" alt="An AI Assistant dialogue in which the user asks for a purpose-built ES|QL query" />

The image above shows an ((esql)) query generated by AI Assistant in response to a user prompt. Learn more about <DocLink slug="/serverless/security/ai-assistant-esql-queries" text="using AI Assistant for ES|QL"/>.
Expand Down
3 changes: 3 additions & 0 deletions docs/serverless/serverless-security.docnav.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
},
{
"slug": "/serverless/security/connect-to-openai"
},
{
"slug": "/serverless/security/connect-to-google-vertex"
}
]
},
Expand Down

0 comments on commit 2fb51b1

Please sign in to comment.