Guía de migración de Agent Engine

En la versión 1.112.0 del SDK de Vertex AI, el módulo agent_engines del SDK de Vertex AI para Python se ha refactorizado para adoptar un diseño basado en clientes.

En esta página se describen los cambios clave del módulo y cómo migrar el código actual al diseño basado en el cliente.

Para obtener información general sobre Agent Engine, consulta la introducción.

Principales cambios

A grandes rasgos, los parámetros del cliente de servicio se inicializan por cliente y el cliente contiene los módulos pertinentes para las interacciones de servicio.

Por ejemplo:

import vertexai
from vertexai import agent_engines

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

se sustituye por

import vertexai

client = vertexai.Client(project=GCP_PROJECT, location=GCP_REGION)
client.agent_engines.create(...)

Los siguientes espacios de nombres de Vertex AI Agent Engine en el SDK de Vertex AI están en fase de discontinuación. 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	Sustitución 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	Sustitución: 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	Sustitución: 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

Migrar al diseño basado en el cliente

En esta sección se incluyen fragmentos de código que muestran cómo migrar el código de Agent Engine a un diseño basado en el cliente.

Nota: En los ejemplos se pueden omitir importaciones, dependencias y otro código repetitivo para mejorar la legibilidad.

Crear una instancia de Agent Engine

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

Actualizar una instancia de Agent Engine

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

Obtener una instancia de Agent Engine

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)

Listar instancias de Agent Engine

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

Eliminar una instancia de Agent Engine

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