Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 4.45 KB

VertexAI.md

File metadata and controls

91 lines (63 loc) · 4.45 KB

Working with Google Models

Google has two different ways for you to access their models. They are governed by different Terms of Use and usage policies.

Advising you on which method to use is beyond the scope of this document, but there are differences to consider.

The options are:

  1. Gemini Developer API link to documentation
  2. Google Vertex AI on Google Cloud Platform link to documentation

Using Gemini Developer API

Get a Gemini API Key from Google and start using it quickly within the Agent Service Toolkit.

  1. Put your API Key into the GOOGLE_API_KEY environment variable in your .env file
  2. Agent Service Toolkit should see the credentials and you should be good to go

Using Google Vertex AI on Google Cloud Platform

Prerequisites

Ensure you have a Google Cloud project with billing enabled.

About Authentication

To use Vertex AI programmatically, you’ll create a service account and use its credentials to authenticate your application. These credentials, distinct from your personal Google Account credentials, determine your application’s access to Google Cloud services and APIs.

Vertex uses a JSON based credential file and read the GOOGLE_APPLICATION_CREDENTIALS Environment Variable to get the path to this credentials file at runtime.

Models

Vertex AI includes both stable and experimental/preview models. Experimental and preview models may change or be discontinued without notice, so for production applications, it’s strongly recommended to use stable models. Check the Vertex AI documentation for the latest information on model status.

Steps

1. Enable the Vertex AI API

  • Go to the Google Cloud API Library.
  • Select your project from the dropdown at the top.
  • Search for "Vertex AI API" and click Enable.

2. Create and Configure a Service Account

  • Navigate to the Credentials page.
  • Click Create Credentials > Service Account.
  • Fill in the details (e.g., name and description).
  • Assign roles: For Vertex AI, grant at least the "Vertex AI User" role.
  • Click Done, then find your service account, click the three dots (⋮), and select Manage Keys.
  • Click Add Key > Create New Key, select JSON, and click Create.
  • The JSON key file will download. Store it securely—you won’t be able to download it again.

3. Add the JSON Key File to the File-based Credentials Path

Place the downloaded JSON file in the privatecredentials/ of your project (e.g., privatecredentials/service-account-key.json).

Contents of the File-based Credentials path are made available to your container at runtime in /privatecredentials/ , but are excluded from git commits and docker builds.

4. Set the GOOGLE_APPLICATION_CREDENTIALS Environment Variable

Set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the full path of your JSON file:

  • .env (for docker compose) : 
    GOOGLE_APPLICATION_CREDENTIALS=/privatecredentials/service-account-key.json
  • Unix-like systems: 
    export GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/project/privatecredentials/service-account-key.json
  • Windows: 
    set GOOGLE_APPLICATION_CREDENTIALS=C:\path\to\your\project\privatecredentials\service-account-key.json

5. Protect Your Credentials

  • Make sure the JSON file is covered by your .gitignore file (Already done if you placed it in the provided privatecredentials/ folder ) : 
    service-account-key.json
  • Keep this file private, as it grants access to your Google Cloud resources and could lead to unauthorized usage or billing.

Verify Your Setup

Test your credentials with:

gcloud auth activate-service-account --key-file=/path/to/your/service-account-key.json
gcloud auth list

Your service account should appear as active.

Production Note

This setup is ideal for development. In production, consider more secure alternatives. Some options are listed on the File-based Credentials page.