Guide de migration du SDK Agent Runtime

Dans la version 2.0.1 du SDK Agent Platform, le module agent_engines du SDK a été refactorisé et renommé runtimes dans le package agentplatform autonome. Cette page décrit les principaux changements apportés au module et explique comment migrer votre code existant vers la nouvelle structure du SDK. Pour obtenir des informations générales sur Agent Runtime, consultez la présentation.

Principales modifications

De manière générale, les paramètres du client de service sont initialisés pour chaque client, et le client contient les modules pertinents pour les interactions de service. par exemple les éléments suivants :

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

est remplacé par

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

Les espaces de noms suivants du SDK sont en phase d'abandon. Utilisez les espaces de noms équivalents du SDK Agent Platform basé sur le client, qui offre une parité de fonctionnalités complète avec les modules et packages obsolètes.

Ancien espace de noms Code concerné Remplacement (agentplatform)
vertexai.agent_engines Méthodes concernées :
  • vertexai.agent_engines.create
  • vertexai.agent_engines.get
  • vertexai.agent_engines.list
  • vertexai.agent_engines.update
  • vertexai.agent_engines.delete
 Remplacement :
  • client.runtimes.create
  • client.runtimes.get
  • client.runtimes.list
  • client.runtimes.update
  • client.runtimes.delete
client.agent_engines Méthodes concernées :
  • 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
 Remplacement :
  • 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

Migrer vers la conception basée sur le client

Cette section contient des extraits de code qui montrent comment migrer votre code Agent Runtime existant vers la conception du SDK agentplatform. Remarque : Les exemples peuvent omettre les importations, les dépendances et d'autres codes récurrents pour améliorer la lisibilité.

Créer une instance Agent Runtime

Avant 

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

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

Mettre à jour une instance Agent Runtime

Avant 

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

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

Obtenir une instance Agent Runtime

Avant 

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

Après 

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

Lister les instances Agent Runtime

Avant 

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

Après 

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

Supprimer une instance Agent Runtime

Avant 

agent_engine.delete(
    force=True,  # Optional
)

Par ailleurs,

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

Après 

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

Par ailleurs,

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