Gérer les agents déployés

Cette page explique comment gérer les agents déployés dans l'environnement d'exécution géré Vertex AI Agent Engine. Les agents déployés sont des ressources de type reasoningEngine dans Vertex AI.

Lister les agents déployés

Répertoriez tous les agents déployés pour un projet et un emplacement donnés :

Console

  1. Dans la console Google Cloud , accédez à la page Vertex AI Agent Engine.

    Accéder à Agent Engine

Les agents déployés qui font partie du projet sélectionné apparaissent dans la liste. Vous pouvez utiliser le champ Filtrer pour filtrer la liste en fonction de la colonne spécifiée.

SDK Vertex AI pour Python

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    project="PROJECT_ID",
    location="LOCATION",
)

for agent in client.agent_engines.list():
    print(agent)

Pour filtrer la liste par display_name :

for agent in client.agent_engines.list(
    config={
        "filter": 'display_name="DISPLAY_NAME"',
    },
):
    print(agent)

REST

Appelez la méthode reasoningEngines.list.

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • PROJECT_ID : ID de votre projet GCP
  • LOCATION : une région compatible

Méthode HTTP et URL :

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir un code d'état indiquant le succès de l'opération (2xx), ainsi qu'une réponse vide.

Mode Express Vertex AI

Vous pouvez utiliser le SDK Vertex AI pour Python ou REST avec le mode express Vertex AI. Pour en savoir plus sur le mode express de Vertex AI et obtenir des instructions sur la façon de s'inscrire, consultez la présentation du mode express de Vertex AI.

SDK Vertex AI

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    api_key="API_KEY",
)

for agent in client.agent_engines.list():
    print(agent)

Remplacez API_KEY par votre clé API en mode express.

Pour filtrer la liste par display_name :

for agent in client.agent_engines.list(
    config={
        "filter": 'display_name="DISPLAY_NAME"',
    },
):
    print(agent)

API REST

La commande REST suivante appelle la méthode reasoningEngines.list :

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • API_KEY : votre clé API en mode express

Méthode HTTP et URL :

GET https://aiplatform.googleapis.com/v1/projects/reasoningEngines?key=API_KEY

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir un code d'état indiquant le succès de l'opération (2xx), ainsi qu'une réponse vide.

Obtenir un agent déployé

Chaque agent déployé possède un identifiant RESOURCE_ID unique. Pour en savoir plus, consultez Déployer un agent.

Console

  1. Dans la console Google Cloud , accédez à la page Vertex AI Agent Engine.

    Accéder à Agent Engine

    Les agents déployés qui font partie du projet sélectionné apparaissent dans la liste. Vous pouvez utiliser le champ Filtrer pour filtrer la liste en fonction de la colonne spécifiée.

  2. Cliquez sur le nom de l'agent spécifié. La page Métriques de l'agent s'ouvre.

  3. (Facultatif) Pour afficher les détails du déploiement de l'agent, cliquez sur Détails du déploiement. Le volet Détails du déploiement s'ouvre. Pour fermer le volet, cliquez sur OK.

  4. (Facultatif) Pour afficher les URL query et streamQuery de l'agent, cliquez sur URL de l'API. Le volet URL de l'API s'ouvre. Pour fermer le volet, cliquez sur OK.

SDK Vertex AI pour Python

Le code suivant vous permet d'obtenir un agent déployé spécifique :

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    project="PROJECT_ID",
    location="LOCATION",
)

remote_agent = client.agent_engines.get(
    name="projects/PROJECT_ID_OR_NUMBER/locations/LOCATION/reasoningEngines/RESOURCE_ID"
)

REST

Appelez la méthode reasoningEngines.get.

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • PROJECT_ID : ID de votre projet GCP
  • LOCATION : une région compatible
  • RESOURCE_ID : ID de ressource de l'agent déployé

Méthode HTTP et URL :

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir un code d'état indiquant le succès de l'opération (2xx), ainsi qu'une réponse vide.

Mode Express Vertex AI

Vous pouvez utiliser le SDK Vertex AI pour Python ou REST avec le mode express Vertex AI. Pour en savoir plus sur le mode express de Vertex AI et obtenir des instructions sur la façon de s'inscrire, consultez la présentation du mode express de Vertex AI.

SDK Vertex AI

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    api_key="API_KEY",
)

remote_agent = client.agent_engines.get(
    name="RESOURCE_NAME"
)
# Resource Name: "projects/{PROJECT_NUMBER}/locations/{LOCATION}/reasoningEngines/{RESOURCE_ID}"
# RESOURCE_ID can be used for the REST commands

Remplacez API_KEY par votre clé API en mode express.

API REST

La commande REST suivante appelle la méthode reasoningEngines.get :

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • RESOURCE_ID : ID de ressource de l'agent déployé
  • API_KEY : votre clé API en mode express

Méthode HTTP et URL :

GET https://aiplatform.googleapis.com/v1/reasoningEngines/RESOURCE_ID?key=API_KEY

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir un code d'état indiquant le succès de l'opération (2xx), ainsi qu'une réponse vide.

Mettre à jour un agent déployé

Vous pouvez mettre à jour un ou plusieurs champs de l'agent déployé simultanément, mais vous devez spécifier au moins l'un des champs à mettre à jour. Le temps nécessaire pour mettre à jour l'agent déployé dépend de la mise à jour effectuée, mais il faut généralement entre quelques secondes et quelques minutes.

Console

  1. Dans la console Google Cloud , accédez à la page Vertex AI Agent Engine.

    Accéder à Agent Engine

  2. Pour l'agent spécifié, cliquez sur le menu Autres actions ().

  3. Cliquez sur Modifier. Le volet Modifier de l'agent s'ouvre.

  4. Modifiez le nom à afficher ou la description de l'agent.

  5. Cliquez sur Enregistrer.

SDK Vertex AI pour Python

Pour mettre à jour un agent déployé (correspondant à RESOURCE_NAME) vers un agent mis à jour (correspondant à UPDATED_AGENT) :

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    project="PROJECT_ID",
    location="LOCATION",
)

client.agent_engines.update(
    name=RESOURCE_NAME,                    # Required.
    agent=UPDATED_AGENT,                   # Optional.
    config={                                                # Optional.
        "requirements": REQUIREMENTS,      # Optional.
        "display_name": "DISPLAY_NAME",    # Optional.
        "description": "DESCRIPTION",      # Optional.
        "extra_packages": EXTRA_PACKAGES,  # Optional.
    },
)

Les arguments sont les mêmes que lorsque vous déployez un agent.

REST

Appelez la méthode reasoningEngines.patch et fournissez un update_mask pour spécifier les champs à mettre à jour.

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • PROJECT_ID : ID de votre projet GCP
  • LOCATION : une région compatible
  • RESOURCE_ID : ID de ressource de l'agent déployé
  • update_mask : liste de champs à mettre à jour, séparés par une virgule

Méthode HTTP et URL :

PATCH https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID?update_mask="display_name,description"

Corps JSON de la requête :

{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir un code d'état indiquant le succès de l'opération (2xx), ainsi qu'une réponse vide.

Mode Express Vertex AI

Vous pouvez utiliser le SDK Vertex AI pour Python ou REST avec le mode express de Vertex AI. Pour en savoir plus sur le mode express de Vertex AI et obtenir des instructions sur la façon de s'inscrire, consultez la présentation du mode express de Vertex AI.

SDK Vertex AI

Le code suivant utilise le SDK Vertex AI pour Python afin de mettre à jour un agent déployé (correspondant à RESOURCE_NAME) vers un agent mis à jour (correspondant à UPDATED_AGENT) :

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    api_key="API_KEY",
)

client.agent_engines.update(
    name=RESOURCE_NAME,                    # Required.
    agent=UPDATED_AGENT,                   # Optional.
    config={                                                # Optional.
        "requirements": REQUIREMENTS,      # Optional.
        "display_name": "DISPLAY_NAME",    # Optional.
        "description": "DESCRIPTION",      # Optional.
        "extra_packages": EXTRA_PACKAGES,  # Optional.
    },
)

Remplacez API_KEY par votre clé API en mode express.

API REST

La commande REST suivante appelle la méthode reasoningEngines.patch et fournit un update_mask pour spécifier les champs à mettre à jour :

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • RESOURCE_ID : ID de ressource de l'agent déployé
  • API_KEY : votre clé API en mode express
  • update_mask : liste de champs à mettre à jour, séparés par une virgule

Méthode HTTP et URL :

PATCH https://aiplatform.googleapis.com/v1/reasoningEngines/RESOURCE_ID?update_mask="display_name,description"&key=API_KEY

Corps JSON de la requête :

{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir un code d'état indiquant le succès de l'opération (2xx), ainsi qu'une réponse vide.

Configurer la télémétrie pour votre agent déployé

Si vous avez activé les traces lors du développement de l'agent, vous pouvez utiliser la console Google Cloud pour configurer la télémétrie de votre agent déployé.

Configurez la télémétrie pour les agents déployés avec la télémétrie activée :

  1. Dans la console Google Cloud , accédez à la page Vertex AI Agent Engine.

    Accéder à Agent Engine

    Les instances Agent Engine faisant partie du projet sélectionné apparaissent dans la liste. Vous pouvez utiliser le champ Filtrer pour filtrer la liste en fonction de la colonne spécifiée.

  2. Recherchez la ligne correspondant à votre instance Agent Engine. Dans la colonne Configuration de la télémétrie, cliquez sur Configurer. Le panneau Configuration du service s'ouvre.

  3. Vous pouvez effectuer les configurations suivantes :

    • Observabilité : vous pouvez configurer les éléments suivants :

      • Activer l'instrumentation des traces et des journaux OpenTelemetry : pour remplir le tableau de bord d'observabilité de l'agent et les pages de traces, cliquez sur le bouton bascule pour l'activer.

      • Activer la journalisation des entrées de prompt et des sorties de réponse : pour collecter et stocker le contenu complet des prompts et des réponses des utilisateurs, cliquez sur le bouton bascule pour l'activer.

      Si la collecte de données de télémétrie est désactivée pour votre agent, vous devez le redéployer et mettre à jour votre version du SDK Vertex AI vers >= 1.126.1 afin d'afficher les options de configuration pour l'observabilité.

    • Conteneurs : configurez les paramètres du conteneur pour votre agent déployé :

      • Scaling : saisissez un nombre minimal d'instances et un nombre maximal d'instances.

      • Ressources : sélectionnez les limites de mémoire et de processeur pour chaque conteneur.

      • Simultanéité des conteneurs : saisissez un nombre minimal d'instances pour définir la simultanéité de chaque conteneur et serveur d'agent. La valeur recommandée est (2 * CPU + 1), et la valeur par défaut est 9.

    • Accès et autorisations : cliquez sur Gérer les autorisations dans IAM pour gérer les autorisations de l'agent sur le compte de service associé.

    • Détails du déploiement : affichez les détails du déploiement de l'agent, y compris le nom de la ressource et le nom à afficher.

    • Banque de mémoire : affichez les détails de la banque de mémoire pour l'agent, y compris la génération de mémoire et la recherche dans la mémoire.

  4. Cliquez sur Mettre à jour ou Fermer.

Afficher les métriques de votre agent déployé

Pour les agents déployés, vous pouvez utiliser la console pour afficher les métriques de votre agent :

  1. Dans la console Google Cloud , accédez à la page Vertex AI Agent Engine.

    Accéder à Agent Engine

    Les agents déployés qui font partie du projet sélectionné apparaissent dans la liste. Vous pouvez utiliser le champ Filtrer pour filtrer la liste en fonction de la colonne spécifiée.

  2. Cliquez sur le nom de votre agent. Le tableau de bord de l'agent sélectionné s'affiche.

  3. Sélectionnez l'un des onglets Tableau de bord suivants :

    • Présentation : affichez un tableau de bord récapitulatif des métriques de votre agent, y compris la latence, le nombre de requêtes et le taux d'erreur.

    • Modèles : affichez un tableau de bord de métriques pour le modèle de votre agent, y compris le nombre d'appels de modèle, le taux d'erreur du modèle et l'utilisation des jetons du modèle.

    • Outils : affichez un tableau de bord des métriques pour les outils de votre agent, y compris le nombre d'appels d'outils, le taux d'erreur des outils et la latence des outils.

    • Utilisation : affichez un tableau de bord des métriques d'utilisation de votre agent, y compris l'utilisation des jetons par entrée et sortie, l'allocation de processeur et de mémoire des conteneurs.

    • Journaux : affichez les journaux de votre agent si vous avez activé Cloud Logging pour votre agent.

Tableau de bord Vertex AI Agent Engine

Supprimer un agent déployé

Supprimez un agent déployé de l'environnement d'exécution géré Vertex AI Agent Engine.

Console

  1. Dans la console Google Cloud , accédez à la page Vertex AI Agent Engine.

    Accéder à Agent Engine

  2. Pour l'agent spécifié, cliquez sur le menu Autres actions ().

  3. Cliquez sur Supprimer.

  4. Cliquez sur Supprimer l'agent.

SDK Vertex AI pour Python

Si vous disposez déjà d'une instance existante de l'agent déployé (en tant que remote_agent), vous pouvez exécuter la commande suivante :

remote_agent.delete(
    force=True, # Optional, if the agent has resources (e.g. sessions, memory)
)

Vous pouvez également appeler agent_engines.delete() pour supprimer l'agent déployé correspondant à RESOURCE_NAME de la manière suivante :

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    project="PROJECT_ID",
    location="LOCATION",
)

client.agent_engines.delete(
    name=RESOURCE_NAME,
    force=True, # Optional, if the agent has resources (e.g. sessions, memory)
)

REST

Appelez la méthode reasoningEngines.delete.

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • PROJECT_ID : ID de votre projet GCP
  • LOCATION : une région compatible
  • RESOURCE_ID : ID de ressource de l'agent déployé

Méthode HTTP et URL :

DELETE https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir un code d'état indiquant le succès de l'opération (2xx), ainsi qu'une réponse vide.

Mode Express Vertex AI

Vous pouvez utiliser le SDK Vertex AI pour Python ou REST avec le mode express Vertex AI.

SDK Vertex AI

Le code suivant utilise le SDK Vertex AI pour Python afin de supprimer l'agent déployé correspondant à RESOURCE_NAME de la manière suivante :

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    api_key="API_KEY",
)

client.agent_engines.delete(
    name=RESOURCE_NAME,
    force=True, # Optional, if the agent has resources (e.g. sessions, memory)
)

Remplacez API_KEY par votre clé API en mode express.

API REST

La commande REST suivante appelle la méthode reasoningEngines.delete :

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • RESOURCE_ID : ID de ressource de l'agent déployé
  • API_KEY : votre clé API en mode express

Méthode HTTP et URL :

DELETE https://aiplatform.googleapis.com/v1/projects/reasoningEngines/RESOURCE_ID?key=API_KEY

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir un code d'état indiquant le succès de l'opération (2xx), ainsi qu'une réponse vide.

Étapes suivantes