Guia de migração do SDK do Agent Runtime

Na versão 2.0.1 do SDK da Agent Platform, o módulo agent_engines no SDK foi refatorado e renomeado como runtimes no pacote independente agentplatform. A página descreve as principais mudanças no módulo e como migrar seu código atual para a nova estrutura do SDK. Para informações gerais sobre o Agent Runtime, consulte Visão geral.

Mudanças importantes

Em um nível geral, os parâmetros do cliente de serviço são inicializados por cliente, e o cliente contém os módulos relevantes para interações de serviço. nas situações a seguir.

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

é substituído 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(...)

Os namespaces a seguir no SDK estão na fase de descontinuação. Use os namespaces equivalentes do SDK da Agent Platform baseada em cliente, que tem paridade total de recursos com os módulos e pacotes descontinuados.

Namespace legado	Código afetado	Substituição (agentplatform)
vertexai.agent_engines	Métodos afetados: vertexai.agent_engines.create vertexai.agent_engines.get vertexai.agent_engines.list vertexai.agent_engines.update vertexai.agent_engines.delete	Substituição: client.runtimes.create client.runtimes.get client.runtimes.list client.runtimes.update client.runtimes.delete
client.agent_engines	Métodos afetados: 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	Substituição: 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

Migrar para o design baseado em cliente

Esta seção contém snippets de código que demonstram como migrar seu código atual do Agent Runtime para o design do SDK agentplatform. Observação: os exemplos podem omitir importações, dependências e outros códigos boilerplate para melhorar a legibilidade.

Como criar uma instância do 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,
    # ...
)

Depois

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

Como atualizar uma instância do 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,
    # ...
)

Depois

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

Como receber uma instância do Agent Runtime

Antes

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

Depois

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

Como listar instâncias do Agent Runtime

Antes

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

Depois

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

Excluir uma instância do Agent Runtime

Antes

agent_engine.delete(
    force=True,  # Optional
)

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
)

Depois

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

Como alternativa,

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