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

En la versión v1.112.0 del SDK de Vertex AI, se refactorizó el módulo agent_engines dentro del SDK de Vertex AI para Python a un diseño basado en el cliente. En la página, se describen los cambios clave en el módulo y cómo migrar tu código existente al diseño basado en el cliente. Para obtener información general sobre Agent Runtime, consulta Descripción general.

Cambios clave

En un nivel alto, los parámetros del cliente de servicio se inicializan por cliente, y el cliente contiene los módulos relevantes 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 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(...)

Los siguientes espacios de nombres para Agent Runtime en el SDK de Vertex AI están en la fase de baja. Usa los espacios de nombres equivalentes del SDK de Vertex AI basado en el cliente, que tiene una paridad de funciones completa con los módulos y paquetes obsoletos.

Espacio de nombres del SDK de Vertex AI	Código afectado	Reemplazo del SDK de Vertex AI basado en el cliente
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.agent_engines.create client.agent_engines.get client.agent_engines.list client.agent_engines.update client.agent_engines.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.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

Migra al diseño basado en el cliente

Esta sección contiene fragmentos de código que muestran cómo migrar tu código existente de Agent Runtime al diseño basado en el cliente. 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 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,
        # ...
    },
)

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

Obtén 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 vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = client.agent_engines.get(name=resource_name)

Enumera 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 vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = client.agent_engines.list()

Borra una instancia de Agent Runtime

Antes

agent_engine.delete(
    force=True,  # Optional
)

Como alternativa, 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 )

Después

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

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