Guia de migração do SDK do Agent Runtime

Na versão v1.112.0 do SDK da Vertex AI, o agent_engines módulo no SDK da Vertex AI para Python foi refatorado para um design baseado em cliente. A página descreve as principais mudanças no módulo e como migrar seu código atual para o design baseado em cliente. Para informações gerais sobre o Agent Runtime, consulte Visão geral.

Mudanças importantes

Em um nível alto, 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(...)

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

Os namespaces a seguir para o Agent Runtime no SDK da Vertex AI estão na fase de suspensão do uso. Use os namespaces equivalentes do SDK da Vertex AI baseado em cliente, que tem paridade total de recursos com os módulos e pacotes suspensos.

Namespace do SDK da Vertex AI	Código afetado	Substituição do SDK da Vertex AI baseado em cliente
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.agent_engines.create client.agent_engines.get client.agent_engines.list client.agent_engines.update client.agent_engines.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.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 para o design baseado em cliente

Esta seção contém snippets de código que demonstram como migrar seu código do Agent Runtime para o design baseado em cliente. 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 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,
        # ...
    },
)

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

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

Como excluir uma instância do 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 )

Depois

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