Migrationsleitfaden für das Agent Runtime SDK

In Version 2.0.1 des Agent Platform SDK wurde das Modul agent_engines im SDK umgestaltet und in runtimes unter dem eigenständigen Paket agentplatform umbenannt. Auf dieser Seite werden die wichtigsten Änderungen am Modul und die Migration Ihres vorhandenen Codes zur neuen SDK-Struktur beschrieben. Allgemeine Informationen zur Agent Runtime finden Sie unter Übersicht.

Wichtigste Änderungen

Auf hoher Ebene werden Dienstclientparameter clientweise 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 agentplatform
# Mandatory for cross-project deployment and for use of the framework-specific templates.
client = agentplatform.Client(project=GCP_PROJECT, location=GCP_REGION)
client.runtimes.create(...)

Die folgenden Namespaces im SDK befinden sich in der Einstellungsphase. Verwenden Sie die entsprechenden Namespaces aus dem clientbasierten Agent Platform SDK, das dieselben Funktionen wie die eingestellten Module und Pakete bietet.

Alter Namespace	Betroffener Code	Ersatzgerät (agentplatform)
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.runtimes.create client.runtimes.get client.runtimes.list client.runtimes.update client.runtimes.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.memory_banks.memories.create client.memory_banks.memories.delete client.memory_banks.memories.generate client.memory_banks.memories.get client.memory_banks.memories.list client.memory_banks.memories.retrieve client.sessions.create client.sessions.delete client.sessions.get client.sessions.list client.sessions.events.append client.sessions.events.list

Zur clientbasierten Gestaltung migrieren

Dieser Abschnitt enthält Code-Snippets, die zeigen, wie Sie Ihren vorhandenen Agent Runtime-Code zum agentplatform SDK migrieren. Hinweis: Zur besseren Lesbarkeit werden in den Beispielen möglicherweise Importe, Abhängigkeiten und anderer Boilerplate-Code weggelassen.

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 agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
client.runtimes.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 agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
client.runtimes.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 agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
remote_agent = client.runtimes.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 agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
runtimes = client.runtimes.list()

Agent Runtime-Instanz löschen

Vorher

agent_engine.delete(
    force=True,  # Optional
)

Sie haben folgende Alternativen:

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

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

Sie haben folgende Alternativen:

import agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
remote_agent = client.runtimes.delete(
    name=resource_name,  # Required.
    force=True,          # Optional.
)