Migrationsleitfaden für das Agent Runtime SDK

In Version 1.112.0 des Vertex AI SDK wurde das agent_engines Modul im Vertex AI SDK für Python zu einem clientbasierten Design umgestaltet. Auf dieser Seite werden die wichtigsten Änderungen am Modul und die Migration Ihres vorhandenen Codes zum clientbasierten Design beschrieben. Allgemeine Informationen zu Agent Runtime finden Sie unter Übersicht.

Wichtigste Änderungen

Im Allgemeinen werden Dienstclientparameter pro Client initialisiert und der Client enthält die relevanten Module für Dienstinteraktionen. Dazu gehören:

import vertexai
from vertexai import agent_engines
vertexai.init(project=GCP_PROJECT, location=GCP_REGION)
agent_engines.create(...)

wird ersetzt durch

import vertexai
# Mandatory for cross-project deployment and for use of the framework-specific templates.
vertexai.init(project=GCP_PROJECT, location=GCP_REGION)
client = vertexai.Client(project=GCP_PROJECT, location=GCP_REGION)
client.agent_engines.create(...)

Die folgenden Namespaces für Agent Runtime im Vertex AI SDK befinden sich in der Einstellungsphase. Verwenden Sie die entsprechenden Namespaces aus dem clientbasierten Vertex AI SDK, das alle Funktionen der eingestellten Module und Pakete bietet.

Vertex AI SDK-Namespace Betroffener Code Clientbasierter Ersatz für das Vertex AI SDK
vertexai.agent_engines Betroffene Methoden:
  • vertexai.agent_engines.create
  • vertexai.agent_engines.get
  • vertexai.agent_engines.list
  • vertexai.agent_engines.update
  • vertexai.agent_engines.delete
Ersatz:
  • client.agent_engines.create
  • client.agent_engines.get
  • client.agent_engines.list
  • client.agent_engines.update
  • client.agent_engines.delete
client.agent_engines Betroffene Methoden:
  • client.agent_engines.create_memory
  • client.agent_engines.delete_memory
  • client.agent_engines.generate_memories
  • client.agent_engines.get_memory
  • client.agent_engines.list_memories
  • client.agent_engines.retrieve_memories
  • client.agent_engines.create_session
  • client.agent_engines.delete_session
  • client.agent_engines.get_session
  • client.agent_engines.list_sessions
  • client.agent_engines.append_session_event
  • client.agent_engines.list_session_events
Ersatz:
  • client.agent_engines.memories.create
  • client.agent_engines.memories.delete
  • client.agent_engines.memories.generate
  • client.agent_engines.memories.get
  • client.agent_engines.memories.list
  • client.agent_engines.memories.retrieve
  • client.agent_engines.sessions.create
  • client.agent_engines.sessions.delete
  • client.agent_engines.sessions.get
  • client.agent_engines.sessions.list
  • client.agent_engines.sessions.events.append
  • client.agent_engines.sessions.events.list

Zum clientbasierten Design migrieren

Dieser Abschnitt enthält Code-Snippets, die zeigen, wie Sie Ihren vorhandenen Agent Runtime-Code zum clientbasierten Design migrieren. Hinweis: In den Beispielen werden möglicherweise Importe, Abhängigkeiten und anderer Boilerplate-Code ausgelassen, um die Lesbarkeit zu verbessern.

Agent Runtime-Instanz erstellen

Vorher

import vertexai
from vertexai import agent_engines
vertexai.init(
  project=PROJECT,
  location=LOCATION,
  staging_bucket=STAGING_BUCKET,
)
agent_engines.create(
    local_agent,
    requirements=REQUIREMENTS,
    extra_packages=EXTRA_PACKAGES,
    # ...
)

Nach

import vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
client.agent_engines.create(
    agent=local_agent,
    config={
        "staging_bucket": STAGING_BUCKET,
        "requirements": REQUIREMENTS,
        "extra_packages": EXTRA_PACKAGES,
        # ...
    },
)

Agent Runtime-Instanz aktualisieren

Vorher

import vertexai
from vertexai import agent_engines
vertexai.init(
  project=PROJECT,
  location=LOCATION,
  staging_bucket=STAGING_BUCKET,
)
agent_engines.update(
    resource_name,
    agent_engine=local_agent,
    requirements=REQUIREMENTS,
    extra_packages=EXTRA_PACKAGES,
    # ...
)

Nach

import vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
client.agent_engines.update(
    name=resource_name,
    agent=local_agent,
    config={
        "staging_bucket": STAGING_BUCKET,
        "requirements": REQUIREMENTS,
        "extra_packages": EXTRA_PACKAGES,
        # ...
    },
)

Agent Runtime-Instanz abrufen

Vorher

import vertexai
from vertexai import agent_engines
vertexai.init(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = agent_engines.get(resource_name)

Nach

import vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = client.agent_engines.get(name=resource_name)

Agent Runtime-Instanzen auflisten

Vorher

import vertexai
from vertexai import agent_engines
vertexai.init(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = agent_engines.list()

Nach

import vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = client.agent_engines.list()

Agent Runtime-Instanz löschen

Vorher

agent_engine.delete(
    force=True,  # Optional
)

Alternativ: py import vertexai from vertexai import agent_engines vertexai.init( project=PROJECT, location=LOCATION, ) agent_engine = agent_engines.delete( resource_name, # Required. force=True, # Optional )

Nach

agent_engine.delete(
    force=True,     # Optional.
)

Alternativ: py import vertexai client = vertexai.Client( project=PROJECT, location=LOCATION, ) agent_engine = client.agent_engines.delete( name=resource_name, # Required. force=True, # Optional. )