Guía de migración del SDK de Agent Runtime

En la versión 2.0.1 del SDK de Agent Platform, se refactorizó el módulo agent_engines dentro del SDK y se cambió su nombre a runtimes en el paquete agentplatform independiente. En la página, se describen los cambios clave del módulo y cómo migrar tu código existente a la nueva estructura del SDK. Para obtener información general sobre Agent Runtime, consulta Descripción general.

Cambios clave

En un nivel general, los parámetros del cliente de servicio se inicializan para cada cliente, y el cliente contiene los módulos pertinentes para las interacciones de servicio. Es decir,

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

se reemplaza por

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(...)

Los siguientes espacios de nombres del SDK se encuentran en la fase de baja. Usa los espacios de nombres equivalentes del SDK de Agent Platform basado en el cliente, que tiene paridad completa de funciones con los módulos y paquetes desaprobados.

Espacio de nombres heredado	Código afectado	Reemplazo (agentplatform)
vertexai.agent_engines	Métodos afectados: vertexai.agent_engines.create vertexai.agent_engines.get vertexai.agent_engines.list vertexai.agent_engines.update vertexai.agent_engines.delete	Reemplazo: client.runtimes.create client.runtimes.get client.runtimes.list client.runtimes.update client.runtimes.delete
client.agent_engines	Métodos afectados: 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	Reemplazo: 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

Migra al diseño basado en el cliente

En esta sección, se incluyen fragmentos de código que muestran cómo migrar tu código existente de Agent Runtime al diseño del SDK de agentplatform. Nota: Es posible que los ejemplos omitan importaciones, dependencias y otro código estándar para mejorar la legibilidad.

Crea una instancia de Agent Runtime

Antes

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,
    # ...
)

Después

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,
        # ...
    },
)

Actualiza una instancia de Agent Runtime

Antes

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,
    # ...
)

Después

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,
        # ...
    },
)

Cómo obtener una instancia de Agent Runtime

Antes

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

Después

import agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
remote_agent = client.runtimes.get(name=resource_name)

Cómo generar una lista de instancias de Agent Runtime

Antes

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

Después

import agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
runtimes = client.runtimes.list()

Borra una instancia de Agent Runtime

Antes

agent_engine.delete(
    force=True,  # Optional
)

O, como alternativa:

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

Después

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

O, como alternativa:

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