Diese Seite wurde von der Cloud Translation API übersetzt.

ADK-Agenten registrieren und verwalten, die in Vertex AI Agent Engine gehostet werden

Auf dieser Seite wird beschrieben, wie Gemini Enterprise-Administratoren ADK-Agenten (Agent Development Kit) registrieren können, die in Vertex AI Agent Engine gehostet werden, damit sie Nutzern in der Gemini Enterprise Web-App zur Verfügung gestellt werden können.

Hinweise

Sie benötigen Folgendes:

Die Rolle Discovery Engine Admin.
Aktivieren Sie die Discovery Engine API. Wenn Sie die Discovery Engine API für das Google Cloud-Projekt aktivieren möchten, rufen Sie in der Google Cloud Console die Seite Discovery Engine API auf.

Zur Discovery Engine API
Eine vorhandene Gemini Enterprise-App. Informationen zum Erstellen einer App finden Sie unter App erstellen.
Ein ADK-Agent, der in der Vertex AI Agent Engine gehostet wird. Weitere Informationen finden Sie unter Übersicht über das Agent Development Kit.

Autorisierungsdetails konfigurieren

Erstellen Sie OAuth 2.0-Anmeldedaten für den Agenten, damit er im Namen eines Nutzers auf Ressourcen von Google Cloud wie BigQuery-Tabellen zugreifen kann.

Details zur Autorisierung abrufen

So rufen Sie die Autorisierungsdetails ab:

Rufen Sie in der Google Cloud Console auf der Seite APIs & Dienste die Seite Anmeldedaten auf.

Zu den Anmeldedaten
Wählen Sie das Projekt von Google Cloud aus, in dem sich die Datenquelle befindet, auf die der Agent zugreifen soll. Wählen Sie beispielsweise das Projekt aus, das das BigQuery-Dataset enthält, das der Agent abfragen soll.
Klicken Sie auf Anmeldedaten erstellen und wählen Sie OAuth-Client-ID aus.
Wählen Sie unter Anwendungstyp die Option Webanwendung aus.
Fügen Sie im Abschnitt Autorisierte Weiterleitungs-URIs die folgenden URIs hinzu:
- https://vertexaisearch.cloud.google.com/oauth-redirect
- https://vertexaisearch.cloud.google.com/static/oauth/oauth.html
Klicken Sie auf Erstellen.
Klicken Sie im Bereich OAuth-Client erstellt auf JSON herunterladen. Die heruntergeladene JSON-Datei enthält die Client ID, Authorization URI, Token URI und Client secret für das ausgewählteGoogle Cloud -Projekt. Sie benötigen diese Informationen, um eine Autorisierungsressource zu erstellen:

Autorisierungsressource zu Gemini Enterprise hinzufügen

Führen Sie den folgenden Befehl aus, um eine Autorisierungsressource bei Gemini Enterprise zu registrieren:

REST

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"
      }
   }'

Ersetzen Sie Folgendes:

PROJECT_ID: die Projekt-ID.
ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
- us- für die multiregionale Option „USA“
- eu- für die multiregionale Option „EU“
- global- für den globalen Standort
Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
LOCATION: die Multiregion Ihres Datenspeichers: global, us oder eu
AUTH_ID: die ID der Autorisierungsressource. Dies ist eine beliebige alphanumerische ID, die Sie definieren. Sie müssen später auf diese ID verweisen, wenn Sie einen Agenten registrieren, der OAuth-Unterstützung erfordert.
OAUTH_CLIENT_ID: die OAuth 2.0-Client-ID, die Sie beim Erstellen der OAuth-Anmeldedaten erhalten haben.
OAUTH_CLIENT_SECRET: der OAuth 2.0-Clientschlüssel, den Sie beim Erstellen der OAuth-Anmeldedaten erhalten haben.
OAUTH_AUTH_URI: der Autorisierungs-URI, den Sie beim Erstellen der OAuth-Anmeldedaten erhalten haben. Er hat folgendes Format: https://accounts.google.com/o/oauth2/v2/auth?client_id=CLIENT_ID&redirect_uri=https%3A%2F%2Fvertexaisearch.cloud.google.com%2Fstatic%2Foauth%2Foauth.html&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fbigquery&include_granted_scopes=true&response_type=code&access_type=offline&prompt=consent
OAUTH_TOKEN_URI: der Token-URI, den Sie beim Erstellen der OAuth-Anmeldedaten erhalten haben.

ADK-Agenten bei Gemini Enterprise registrieren

Sie können Ihren ADK-Agenten bei Gemini Enterprise entweder über dieGoogle Cloud -Konsole oder die REST API registrieren. Dadurch wird der Agent für Nutzer in einer Gemini Enterprise-App verfügbar.

Console

So registrieren Sie einen ADK-Agenten über die Google Cloud Console:

Rufen Sie in der Google Cloud Console die Seite Gemini Enterprise auf.

Gemini Enterprise
Klicken Sie auf den Namen der App, für die Sie den Agenten registrieren möchten.
Klicken Sie auf Agenten > Agenten hinzufügen.
Klicken Sie im Bereich Agenttyp auswählen für Benutzerdefinierter Agent über Agent Engine auf Hinzufügen.
Wenn der Agent in Ihrem Namen auf Google Cloud Ressourcen zugreifen soll, gehen Sie so vor:
1. Klicken Sie auf Autorisierung hinzufügen.
2. Geben Sie einen eindeutigen Wert für Name der Autorisierung ein. Eine ID wird basierend auf dem Namen generiert und kann später nicht mehr geändert werden.
3. Geben Sie die Client-ID, den Clientschlüssel, den Autorisierungs-URI und den Token-URI ein, die Sie im Abschnitt Autorisierungsdetails abrufen generiert haben.
4. Klicken Sie auf Autorisierung hinzufügen.
Klicken Sie auf Weiter.
So konfigurieren Sie Ihren Agent:
1. Geben Sie im Feld Agent name (Agent-Name) einen Namen ein. Dieser Wert wird in der Gemini Enterprise Web-App als Anzeigename Ihres KI-Agenten angezeigt.
2. Geben Sie im Feld Beschreiben Sie Ihren Agent eine Beschreibung ein. Dieser Wert wird von einem LLM verwendet, um zu bestimmen, ob Ihr Agent für die Antwort auf eine Nutzeranfrage aufgerufen werden soll.
3. Geben Sie den Ressourcenpfad für die Reasoning Engine der Agent Engine ein. Der Ressourcenpfad hat das folgende Format:
```
    https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/ADK_RESOURCE_ID
 
```
  Weitere Informationen zum Auflisten der in Vertex AI Agent Engine gehosteten Agents und zum Abrufen des Ressourcenpfads finden Sie unter Bereitgestellte Agents auflisten.
4. Konfigurieren Sie die Tooleinstellungen:
  1. Geben Sie eine Beschreibung in das Feld Tool-Beschreibung ein. Anhand dieser Beschreibung versteht das LLM den Zweck des Tools und entscheidet, wann es verwendet werden soll.
  2. Geben Sie den Namen in das Feld Name des Eingabeparameters ein. Das ist der Parametername für den Funktionsaufruf. Dieser Parametername gibt dem LLM einen Hinweis auf den erwarteten Eingabetyp, z. B. question, command oder search_query.
  3. Geben Sie die Beschreibung für das Feld Beschreibung des Eingabeparameters ein. Diese Parameterbeschreibung liefert dem LLM weitere Informationen zum Parameter, z. B. den erwarteten Inhalt und die auszuführenden Aktionen.
5. Klicken Sie auf Erstellen.

REST

In diesem Codebeispiel wird gezeigt, wie Sie Ihre ADK-Agents registrieren.

   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"
      },
      "adk_agent_definition": {
         "provisioned_reasoning_engine": {
            "reasoning_engine":
            "projects/PROJECT_ID/locations/REASONING_ENGINE_LOCATION/reasoningEngines/ADK_RESOURCE_ID"
         }
      },
   "authorization_config": {


   "tool_authorizations": [
   "projects/PROJECT_ID/locations/global/authorizations/AUTH_ID"
   ]
   }
   }'

Ersetzen Sie die Variablen durch folgende Werte:

ENDPOINT_LOCATION-: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
- us- für die multiregionale Option „USA“
- eu- für die multiregionale Option „EU“
- global- für den globalen Standort
Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
PROJECT_ID: Die ID Ihres Projekts in Google Cloud .
APP_ID: die eindeutige Kennung für die Gemini Enterprise-App.
DESCRIPTION : Die Beschreibung des Agenten, die in Gemini Enterprise angezeigt wird.
ICON_URI: Der öffentliche URI des Symbols, das neben dem Namen des Agenten angezeigt werden soll. Alternativ können Sie Base64-codierten Inhalt der Bilddatei übergeben. Verwenden Sie in diesem Fall icon.content.
ADK_RESOURCE_ID: Die ID des Reasoning-Engine-Endpunkts, an dem der ADK-Agent bereitgestellt wird. Weitere Informationen dazu, wie Sie die in Vertex AI Agent Engine gehosteten Agents auflisten und die Ressourcen-ID abrufen, finden Sie unter Bereitgestellte Agents auflisten.
REASONING_ENGINE_LOCATION: Der Cloud-Standort der Reasoning Engine. Weitere Informationen finden Sie unter Standort der Reasoning Engine.
authorizationConfig: Wenn Sie die Autorisierungsdetails erhalten haben und der KI-Agent im Namen des Nutzers auf Ressourcen von Google Cloud zugreifen soll, fügen Sie das Feld authorization_config in Ihre JSON-Ressource ein.
```
 * <code><var>AUTH_ID</var></code>: the value that you used for
    <var>AUTH_ID</var> in the [Configure authorization details](#authorize-your-adk-agent)
    section.
```

Mit einer App verbundene Agenten auflisten

Im folgenden Codebeispiel wird gezeigt, wie Sie die Details aller mit Ihrer App verbundenen Agenten abrufen können:

REST

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"

Ersetzen Sie die Variablen durch folgende Werte:

ENDPOINT_LOCATION-: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
- us- für die multiregionale Option „USA“
- eu- für die multiregionale Option „EU“
- global- für den globalen Standort
Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
PROJECT_ID: Die ID Ihres Projekts in Google Cloud .
LOCATION: die Multiregion Ihrer App: global, us oder eu.
APP_ID: Die ID Ihrer Gemini Enterprise-App.

Wenn Ihr Agent nicht von Google vorab erstellt wurde, enthält die Antwort in den ersten Zeilen das Feld name. Der Wert dieses Felds enthält die Agent-ID am Ende des Pfads. In der folgenden Antwort lautet die Agent-ID beispielsweise 12345678901234567890:

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

Details eines ADK-Agents ansehen

Im folgenden Codebeispiel wird gezeigt, wie Sie die Details eines Agenten abrufen können, der bei Gemini Enterprise registriert wurde:

REST

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"

Ersetzen Sie die Variablen durch folgende Werte:

ENDPOINT_LOCATION-: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
- us- für die multiregionale Option „USA“
- eu- für die multiregionale Option „EU“
- global- für den globalen Standort
Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
PROJECT_ID: Die ID Ihres Projekts in Google Cloud .
LOCATION: die Multiregion Ihrer App: global, us oder eu.
APP_ID: Die ID Ihrer Gemini Enterprise-App.
AGENT_ID: Die ID des Agenten. Die Agent-ID finden Sie, indem Sie die mit Ihrer App verbundenen Agenten auflisten.

ADK-Agenten aktualisieren

Sie können die Details eines vorhandenen Agents, der bei Gemini Enterprise registriert ist, entweder über die Google Cloud -Console oder die REST API ändern.

Console

So aktualisieren Sie den Agent über die Google Cloud Console:

Rufen Sie in der Google Cloud Console die Seite Gemini Enterprise auf.

Gemini Enterprise
Klicken Sie auf den Namen der App, die den Agenten enthält, den Sie aktualisieren möchten.
Klicken Sie auf KI-Agenten.
Klicken Sie auf den Namen des Agent Engine-Agents, den Sie aktualisieren möchten, und dann auf Bearbeiten.
Aktualisieren Sie den Anzeigenamen, die Beschreibung oder die Agent Engine-Problemlösungs-Engine.

Der Ressourcenpfad hat das folgende Format:
```
  https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/ADK_RESOURCE_ID
```
Weitere Informationen zum Auflisten der in Vertex AI Agent Engine gehosteten Agents und zum Abrufen des Ressourcenpfads finden Sie unter Bereitgestellte Agents auflisten.
Klicken Sie auf Speichern.

REST

Sie können alle Felder bei der Registrierung des Agenten aktualisieren. Die folgenden Felder müssen jedoch aktualisiert werden:

displayName
description

reasoningEngine

In diesem Codebeispiel wird gezeigt, wie Sie die Registrierung eines vorhandenen ADK-Agenten aktualisieren:

curl -X PATCH \
   -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/AGENT_RESOURCE_NAME" \
   -d '{
         "displayName": "DISPLAY_NAME",
         "description": "DESCRIPTION",
         "adkAgentDefinition": {
         "provisionedReasoningEngine": {
            "reasoningEngine":
            "projects/PROJECT_ID/locations/REASONING_ENGINE_LOCATION/reasoningEngine
            s/ADK_RESOURCE_ID"
         },
      }
}'

Ersetzen Sie die Variablen durch folgende Werte:

ENDPOINT_LOCATION-: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
- us- für die multiregionale Option „USA“
- eu- für die multiregionale Option „EU“
- global- für den globalen Standort
Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
PROJECT_ID: Die ID Ihres Projekts in Google Cloud .
AGENT_RESOURCE_NAME: Der Ressourcenname des registrierten Agenten, der aktualisiert werden soll.
DISPLAY_NAME: Erforderlich. Der nutzerfreundliche Name für Ihren Agenten, der in Gemini Enterprise angezeigt wird.
DESCRIPTION: Erforderlich. Eine kurze Beschreibung der Funktion Ihres Agenten, die Nutzern in Gemini Enterprise angezeigt wird.
REASONING_ENGINE_LOCATION: Erforderlich. Der Cloud-Standort der Reasoning Engine, auf der Sie den Agenten erstellen. Weitere Informationen finden Sie unter Standort der Reasoning Engine.
ADK_RESOURCE_ID: Die ID des Reasoning-Engine-Endpunkts, auf dem der ADK-Agent bereitgestellt wird. Weitere Informationen dazu, wie Sie die in Vertex AI Agent Engine gehosteten Agents auflisten und die Ressourcen-ID abrufen, finden Sie unter Bereitgestellte Agents auflisten.

ADK-Agenten löschen

Im folgenden Codebeispiel wird gezeigt, wie Sie einen Agenten löschen, der mit Ihrer App verbunden ist:

REST

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"

Ersetzen Sie die Variablen durch folgende Werte:

ENDPOINT_LOCATION-: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
- us- für die multiregionale Option „USA“
- eu- für die multiregionale Option „EU“
- global- für den globalen Standort
Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
PROJECT_ID: Die ID Ihres Projekts in Google Cloud .
LOCATION: die Multiregion Ihrer App: global, us oder eu
APP_ID: Die ID Ihrer Gemini Enterprise-App.
AGENT_ID: die ID des Agenten. Die Agent-ID finden Sie, indem Sie die mit Ihrer App verbundenen Agenten auflisten.

Beispielbefehl und -ergebnis

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
}

Standort der Reasoning Engine

Verwenden Sie die folgende Tabelle, um Ihren API-Aufruf an den richtigen Standort der Reasoning Engine zu senden:

Cloud-Standort, den Sie aufrufen	Standort der Reasoning Engine
`us`	`us-central1`
`eu`	`europe-west1`
Andere (einschließlich `global`)	`us-central1`

ADK-Agenten registrieren und verwalten, die in Vertex AI Agent Engine gehostet werden Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Hinweise

Autorisierungsdetails konfigurieren

Details zur Autorisierung abrufen

Autorisierungsressource zu Gemini Enterprise hinzufügen

REST

ADK-Agenten bei Gemini Enterprise registrieren

Console

REST

Mit einer App verbundene Agenten auflisten

REST

Details eines ADK-Agents ansehen

REST

ADK-Agenten aktualisieren

Console

REST

ADK-Agenten löschen

REST

Beispielbefehl und -ergebnis

Standort der Reasoning Engine

ADK-Agenten registrieren und verwalten, die in Vertex AI Agent Engine gehostet werden