Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.15] creates Google vertex guide for ESS #5549

Merged
merged 1 commit into from
Jul 17, 2024

Conversation

benironside
Copy link
Contributor

@benironside benironside commented Jul 10, 2024

Fixes #5373, adds an llm connector guide for Google Vertex.

Previews: Connect to Google Vertex
LLM connector guides

@benironside benironside self-assigned this Jul 10, 2024
@benironside benironside requested a review from a team as a code owner July 10, 2024 18:34
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some optional nits but went ahead and approved since they come down to personal preference. Nice work!

:frontmatter-tags-content-type: [guide]
:frontmatter-tags-user-goals: [get-started]

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice context-setting intro!

== 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**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional nit: I'm not a fan of replicating all-caps for UI labels, because it feels like yelling (especially if it happens more than just once or twice in a doc). But I don't think we have any style guidelines about it, so it might come down to personal preference.


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**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar preference: when UI labels include extraneous typographical symbols like + or >>, I tend to omit them. They seem distracting in docs and usually aren't necessary for readers to understand which button you're referring to.

@benironside benironside merged commit 5d44e69 into main Jul 17, 2024
4 checks passed
mergify bot pushed a commit that referenced this pull request Jul 17, 2024
benironside added a commit that referenced this pull request Jul 30, 2024
(cherry picked from commit 5d44e69)

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request] New Google Gemini Connector for GenAI
2 participants