Guide de migration du SDK Agent Runtime

Dans la version 1.112.0 du SDK Vertex AI, le agent_engines module du SDK Vertex AI pour Python a été refactorisé pour adopter une conception basée sur le client. Cette page décrit les principales modifications apportées au module et explique comment migrer votre code existant vers la conception basée sur le client. 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 par 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ée par

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

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

Espace de noms du SDK Vertex AI	Code concerné	Remplacement du SDK Vertex AI basé sur le client
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.agent_engines.create client.agent_engines.get client.agent_engines.list client.agent_engines.update client.agent_engines.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.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

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 basée sur le client. Remarque : Les exemples peuvent omettre des importations, des 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 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,
        # ...
    },
)

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

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

Supprimer une instance Agent Runtime

Avant

agent_engine.delete(
    force=True,  # Optional
)

Vous pouvez également utiliser 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 )

Après

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

Vous pouvez également utiliser py import vertexai client = vertexai.Client( project=PROJECT, location=LOCATION, ) agent_engine = client.agent_engines.delete( name=resource_name, # Required. force=True, # Optional. )