Register and manage ADK agents hosted on Vertex AI Agent Engine

This page describes how Gemini Enterprise admins can register Agent Development Kit (ADK) agents hosted on Vertex AI Agent Engine so they can be made available to users on the Gemini Enterprise web app.

Before you begin

Make sure you have the following:

• The Discovery Engine Admin role.

• Enable the Discovery Engine API. To enable the Discovery Engine API for the Google Cloud project, in the Google Cloud console, go to the Discovery Engine APIpage.

  Go to Discovery Engine API

• An existing Gemini Enterprise app. To create an app, see Create an app .

• An ADK agent that is hosted on the Vertex AI Agent Engine. For more information, see Overview of Agent Development Kit .

  • If you don't have an agent, follow the steps in the adk-samples GitHub Repository to deploy a fun_facts agent to Vertex AI Agent Engine. You can then register the agent with Gemini Enterprise.

Configure authorization details (Optional)

Create OAuth 2.0 credentials for the agent to access Google Cloud resources, such as BigQuery tables, on a user's behalf.

Obtain authorization details

Follow these steps to obtain the authorization details.

1. In the Google Cloud console, on the APIs & Servicespage, go to the Credentialspage.

   Go to Credentials

2. Select the Google Cloud project, which has the data source you want the agent to access. For example, select the project that contains the BigQuery dataset that you want the agent to query.

3. Click Create credentialsand select OAuth client ID.

4. In Application type, select Web application.

5. In the Authorized redirect URIssection, add the following URIs:

   • https://vertexaisearch.cloud.google.com/oauth-redirect
   • https://vertexaisearch.cloud.google.com/static/oauth/oauth.html

6. Click Create.

7. In the OAuth client createdpanel, click Download JSON. The downloaded JSON includes the Client ID , Authorization URI , Token URI , and Client secret for the selected Google Cloud project. You need these details to create an authorization resource:

Add an authorization resource to Gemini Enterprise

Run the following command to register an authorization resource with Gemini Enterprise:

 curl  
-X  
POST  
 \ 
  
-H  
 "Authorization: Bearer 
 $( 
gcloud  
auth  
print-access-token ) 
 " 
  
 \ 
  
-H  
 "Content-Type: application/json" 
  
 \ 
  
-H  
 "X-Goog-User-Project: PROJECT_ID 
" 
  
 \ 
  
 "https:// ENDPOINT_LOCATION 
-discoveryengine.googleapis.com/v1alpha/projects/ PROJECT_ID 
/locations/ LOCATION 
/authorizations?authorizationId= AUTH_ID 
" 
  
 \ 
  
-d  
 '{ 
 "name": "projects/ PROJECT_ID 
/locations/ LOCATION 
/authorizations/ AUTH_ID 
", 
 "serverSideOauth2": { 
 "clientId": " OAUTH_CLIENT_ID 
", 
 "clientSecret": " OAUTH_CLIENT_SECRET 
", 
 "authorizationUri": " OAUTH_AUTH_URI 
", 
 "tokenUri": " OAUTH_TOKEN_URI 
" 
 } 
 }' 
 

Register an ADK agent with Gemini Enterprise

You can register your ADK agent with Gemini Enterprise using either the Google Cloud console or the REST API. This makes the agent available to users within a Gemini Enterprise app.

   
curl  
-X  
POST  
 \ 
  
-H  
 "Authorization: Bearer 
 $( 
gcloud  
auth  
print-access-token ) 
 " 
  
 \ 
  
-H  
 "Content-Type: application/json" 
  
 \ 
  
-H  
 "X-Goog-User-Project: PROJECT_ID 
" 
  
 \ 
  
 "https:// ENDPOINT_LOCATION 
-discoveryengine.googleapis.com/v1alpha/projects/ PROJECT_ID 
/locations/global/collections/default_collection/engines/ APP_ID 
/assistants/default_assistant/agents" 
  
 \ 
  
-d  
 '{ 
 "displayName": " DISPLAY_NAME 
", 
 "description": " DESCRIPTION 
", 
 "icon": { 
 "uri": " ICON_URI 
" 
 }, 
 "adkAgentDefinition": { 
 "provisionedReasoningEngine": { 
 "reasoningEngine": "projects/ PROJECT_ID 
/locations/ AGENT_ENGINE_LOCATION 
/reasoningEngines/ AGENT_ENGINE_ID 
" 
 } 
 }, 
 "authorizationConfig": { 
 "toolAuthorizations": [ 
 "projects/ PROJECT_NUMBER 
/locations/global/authorizations/ AUTH_ID 
" 
 ] 
 } 
 }' 
 

Add permissioned users

To add permissioned users to an ADK agent using the Google Cloud console, see Add or modify users and their permissions .

List agents connected to an app

The following code sample demonstrates how you can get the details of all the agents connected to your app:

 curl  
-X  
GET  
 \ 
-H  
 "Authorization: Bearer 
 $( 
gcloud  
auth  
print-access-token ) 
 " 
  
 \ 
 "https:// ENDPOINT_LOCATION 
-discoveryengine.googleapis.com/v1alpha/projects/ PROJECT_ID 
/locations/ LOCATION 
/collections/default_collection/engines/ APP_ID 
/assistants/default_assistant/agents" 
 

  { 
 "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/assistants/default_assistant/agents/12345678901234567890", 
 ... 
 } 
 

View the details of an ADK agent

The following code sample demonstrates how you can retrieve the details of an agent that was registered with Gemini Enterprise:

 curl  
-X  
GET  
 \ 
-H  
 "Authorization: Bearer 
 $( 
gcloud  
auth  
print-access-token ) 
 " 
  
 \ 
 "https:// ENDPOINT_LOCATION 
-discoveryengine.googleapis.com/v1alpha/projects/ PROJECT_ID 
/locations/ LOCATION 
/collections/default_collection/engines/ APP_ID 
/assistants/default_assistant/agents/ AGENT_ID 
" 
 

Update an ADK agent

You can modify the details of an existing agent registered with Gemini Enterprise using either the Google Cloud console or the REST API.

Delete an ADK agent

The following code sample demonstrates how you can delete an agent that is connected to your app:

  curl -X DELETE \ 
 -H "Authorization: Bearer $(gcloud auth print-access-token)" \ 
 "https:// ENDPOINT_LOCATION 
-discoveryengine.googleapis.com/v1alpha/projects/ PROJECT_ID 
/locations/ LOCATION 
/collections/default_collection/engines/ APP_ID 
/assistants/default_assistant/agents/ AGENT_ID 
" 
 

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://global-discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/assistants/default_assistant/agents/12345678901234567890"
{
  "name": "projects/123456/locations/global/collections/default_collection/engines/my-app/assistants/default_assistant/agents/12345678901234567890/operations/delete-agent-12345678901234567890",
  "done": true
}

Vertex AI Agent Engine location

When registering or updating an agent, the Vertex AI Agent Engine location must be compatible with the location of your Gemini Enterprise app. Mismatched locations result in an error.

Refer to the following table for compatibility requirements: