Sitzungen mit direkten API-Aufrufen verwalten

In diesem Abschnitt wird beschrieben, wie Sie Sitzungen mit Vertex AI Agent Engine mit direkten API-Aufrufen verwalten. Wenn Sie Sitzungen nicht mit einem ADK-Agent verwalten möchten, können Sie API-Aufrufe direkt ausführen.

Informationen zum Verwalten von Sitzungen mit dem ADK-Agenten finden Sie unter Sitzungen mit dem Agent Development Kit verwalten.

Vertex AI Agent Engine-Instanz erstellen

Für den Zugriff auf Vertex AI Agent Engine-Sitzungen benötigen Sie eine Vertex AI Agent Engine-Instanz. Sie müssen keinen Code bereitstellen, um Sitzungen zu verwenden. Ohne Codebereitstellung dauert das Erstellen einer Vertex AI Agent Engine-Instanz nur wenige Sekunden.

Wenn Sie keine vorhandene Vertex AI Agent Engine-Instanz haben, erstellen Sie eine mit dem folgenden Code:

import vertexai
from vertexai import agent_engines

# Create an agent engine instance
agent_engine = agent_engines.create()

Sitzungen auflisten

Alle Sitzungen auflisten, die mit Ihrer Vertex AI Agent Engine-Instanz verknüpft sind.

REST API

Verwenden Sie die Methode sessions.list:

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Projekt-ID.
  • LOCATION: Die Region, in der Sie Ihre Agent Engine-Instanz erstellt haben.
  • AGENT_ENGINE_ID: Die Ressourcen-ID Ihrer Agent Engine-Instanz.

HTTP-Methode und URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus: 

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions"

PowerShell

Führen Sie folgenden Befehl aus: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions" | Select-Object -Expand Content

Es sollte eine Liste mit Sitzungen angezeigt werden.

Sitzung erstellen

Erstellen Sie eine Sitzung, die mit einer Nutzer-ID verknüpft ist.

REST API

Verwenden Sie die Methode sessions.create.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Projekt-ID.
  • LOCATION: Die Region, in der Sie Ihre Agent Engine-Instanz erstellt haben.
  • AGENT_ENGINE_ID: Die Ressourcen-ID Ihrer Agent Engine-Instanz.
  • USER_ID: eine Nutzer-ID

HTTP-Methode und URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions

JSON-Text der Anfrage:

{
  "userId": USER_ID
}

Wenn Sie die Anfrage senden möchten, wählen Sie eine der folgenden Optionen aus:

curl

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json und führen Sie den folgenden Befehl aus: 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions"

PowerShell

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json und führen Sie den folgenden Befehl aus: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions" | Select-Object -Expand Content

Sie sollten einen lange laufenden Vorgang erhalten, den Sie abfragen können, um den Erstellungsstatus Ihrer Sitzung zu prüfen.

Sitzung abrufen

Rufen Sie eine bestimmte Sitzung ab, die mit Ihrer Vertex AI Agent Engine-Instanz verknüpft ist.

REST API

Verwenden Sie die Methode sessions.get.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Projekt-ID.
  • LOCATION: Die Region, in der Sie Ihre Agent Engine-Instanz erstellt haben.
  • AGENT_ENGINE_ID: Die Ressourcen-ID Ihrer Agent Engine-Instanz.
  • SESSION_ID: Die Ressourcen-ID der Sitzung, die Sie abrufen möchten. Sie können die Sitzungs-ID aus der Antwort abrufen, die Sie beim Erstellen der Sitzung erhalten haben.

HTTP-Methode und URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus: 

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID"

PowerShell

Führen Sie folgenden Befehl aus: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID" | Select-Object -Expand Content

In der Antwort sollten Informationen zu Ihrer Sitzung angezeigt werden.

Sitzung löschen

Löschen Sie eine Sitzung, die mit Ihrer Vertex AI Agent Engine-Instanz verknüpft ist.

REST API

Verwenden Sie die Methode sessions.delete.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Projekt-ID.
  • LOCATION: Die Region, in der Sie die Example Store-Instanz erstellen möchten.
  • AGENT_ENGINE_ID: Die Ressourcen-ID Ihrer Agent Engine-Instanz.
  • SESSION_ID: Die Ressourcen-ID der Sitzung, die Sie abrufen möchten.

HTTP-Methode und URL:

DELETE https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/sessions/SESSION_ID

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus: 

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/sessions/SESSION_ID"

PowerShell

Führen Sie folgenden Befehl aus: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/sessions/SESSION_ID" | Select-Object -Expand Content

Sie sollten einen erfolgreichen Statuscode (2xx) und eine leere Antwort als Ausgabe erhalten.

Ereignisse in einer Sitzung auflisten

Ereignisse in einer Sitzung auflisten, die mit Ihrer Vertex AI Agent Engine-Instanz verknüpft sind.

REST API

Verwenden Sie die Methode events.list.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Projekt-ID.
  • LOCATION: Die Region, in der Sie Ihre Agent Engine-Instanz erstellt haben.
  • AGENT_ENGINE_ID: Die Ressourcen-ID Ihrer Agent Engine-Instanz.
  • SESSION_ID: Die Ressourcen-ID der Sitzung, die Sie abrufen möchten.

HTTP-Methode und URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID/events

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus: 

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID/events"

PowerShell

Führen Sie folgenden Befehl aus: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID/events" | Select-Object -Expand Content

In der Antwort sollte eine Liste der Ereignisse angezeigt werden, die mit Ihrer Sitzung verknüpft sind.

Ereignis an eine Sitzung anhängen

Ein Ereignis an eine Sitzung anhängen, die mit einer Vertex AI Agent Engine-Instanz verknüpft ist.

REST API

Verwenden Sie die Methode sessions.appendEvent.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Projekt-ID.
  • LOCATION: Die Region, in der Sie Ihre Agent Engine-Instanz erstellt haben.
  • AGENT_ENGINE_ID: Die Ressourcen-ID Ihrer Agent Engine-Instanz.
  • SESSION_ID: Die Ressourcen-ID der Sitzung, der Sie Ereignisse hinzufügen möchten.
  • AUTHOR: Der Autor des Ereignisses. Das kann 'user' oder ein Name des Kundenservicemitarbeiters sein.
  • INVOCATION_ID: Eine Kennung für einen Aufruf.
  • TIMESTAMP: Der Zeitstempel des Ereignisses.

HTTP-Methode und URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID

JSON-Text der Anfrage:

{
  "author": AUTHOR,
  "invocationId": INVOCATION_ID,
  "timestamp": TIMESTAMP,
}

Wenn Sie die Anfrage senden möchten, wählen Sie eine der folgenden Optionen aus:

curl

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json und führen Sie den folgenden Befehl aus: 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID"

PowerShell

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json und führen Sie den folgenden Befehl aus: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID" | Select-Object -Expand Content

Sie sollten einen erfolgreichen Statuscode (2xx) und eine leere Antwort als Ausgabe erhalten.