Inspecter et appeler un agent de données

Ce document explique comment inspecter un agent et mettre à jour son fichier de contexte. Vous pouvez inspecter un agent pour tester sa capacité à générer des requêtes SQL à partir de questions en langage naturel. Si une requête générée n'est pas précise, vous pouvez mettre à jour le contexte de l'agent.

Pour en savoir plus sur les agents de données, consultez la présentation des agents de données.

Avant de commencer

Assurez-vous qu'un agent de données a déjà été créé et que le contexte de l'agent a été importé dans l'agent de données. Pour en savoir plus, consultez Gérer les agents de données dans AlloyDB Studio.

Inspecter un agent de données

Pour inspecter un agent de données, procédez comme suit :

  1. Dans la Google Cloud console, accédez à la page AlloyDB.

    Accéder à AlloyDB

  2. Sélectionnez un cluster dans la liste.

  3. Dans le menu de navigation, cliquez sur AlloyDB Studio.

  4. Connectez-vous à Studio à l'aide de l'authentification Identity and Access Management (IAM).

  5. Dans le volet Explorateur, cliquez sur Afficher les actions à côté de l'agent de données que vous utilisez.

  6. Cliquez sur Inspecter l'agent.

  7. Dans l'éditeur de requête, cliquez sur Générer du code SQL pour ouvrir le volet Aidez-moi à coder.

  8. Saisissez une question en langage naturel dans l'éditeur pour générer une requête SQL, puis cliquez sur Générer.

  9. Vérifiez l'exactitude de la requête SQL.

Télécharger et mettre à jour le contexte d'un agent de données

Si vous n'êtes pas satisfait de la requête SQL générée pour une question en langage naturel, téléchargez le fichier de contexte de l'agent existant. Vous pouvez ensuite examiner et mettre à jour le modèle de requête, puis importer à nouveau le fichier de contexte mis à jour dans l'agent.

Pour télécharger et mettre à jour le contexte d'un agent de données, procédez comme suit :

  1. Dans le volet Explorateur, cliquez sur Afficher les actions.
  2. Cliquez sur Télécharger le fichier de contexte de l'agent.
  3. Suivez les étapes de la section Créer des contextes à l'aide de Gemini CLI pour mettre à jour le contexte avec des paires de requêtes supplémentaires.
  4. Dans le volet Explorateur, cliquez sur Afficher les actions à côté de l'agent de données que vous utilisez.
  5. Cliquez sur Modifier l'agent.
  6. Cliquez sur Parcourir dans la section Importer le fichier de contexte de l'agent, puis sélectionnez le fichier de contexte de l'agent mis à jour.
  7. Cliquez sur Enregistrer pour mettre à jour le contexte de l'agent.

Une fois que vous êtes satisfait de l'exactitude de vos réponses, vous pouvez utiliser le point de terminaison QueryData pour connecter votre application à l'agent de données.

Rechercher l'ID de contexte de l'agent

Pour connecter une application de données à l'agent de données, vous avez besoin de l'ID de contexte de l'agent.

  1. Dans la Google Cloud console, accédez à la page AlloyDB.

    Accéder à AlloyDB

  2. Sélectionnez un cluster dans la liste.

  3. Dans le menu de navigation, cliquez sur AlloyDB Studio.

  4. Connectez-vous à Studio à l'aide de l'authentification Identity and Access Management (IAM).

  5. Dans le volet Explorateur, cliquez sur Afficher les actions à côté de l'agent de données que vous utilisez.

  6. Cliquez sur Modifier l'agent.

  7. Notez l'ID de contexte dans ID de contexte de l'agent. Le format de l'ID de contexte de l'agent est semblable à projects/data-agents-project/locations/us-east1/contextSets/bdf_pg_all_templates.

Connecter l'agent de données à l'application

Définissez l'ID de contexte de l'agent dans l'appel de méthode QueryData pour fournir un contexte créé pour les sources de données de base de données telles qu'AlloyDB, Spanner, Cloud SQL et Cloud SQL pour PostgreSQL. Pour en savoir plus, consultez Définir le contexte de l'agent de données pour les sources de données de base de données.

Après avoir inspecté l'agent de données, vous pouvez référencer la source de données de base de données dans votre appel QueryData.

Exemple de requête QueryData avec un contexte créé

L'exemple suivant montre une requête QueryData utilisant la source de données de base de données alloydb. Le champ agent_context_reference.context_set_id est utilisé pour établir un lien vers le contexte pré-créé stocké dans la base de données.

{
  "parent": "projects/data-agents-project/locations/us-central1",
  "prompt": "How many accounts in the Prague region are eligible for loans? A3 contains the data of region.",
  "context": {
    "datasource_references": [
      {
        "alloydb": {
          "database_reference": {
            "project_id": "data-agents-project",
            "region": "us-central1",
            "cluster_id": "sqlgen-magic",
            "instance_id": "data-agents-primary",
            "database_id": "financial"
          },
          "agent_context_reference": {
            "context_set_id": "projects/data-agents-project/locations/us-east1/contextSets/bdf_pg_all_templates"
          }
        }
      }
    ]
  },
  "generation_options": {
    "generate_query_result": true,
    "generate_natural_language_answer": true,
    "generate_disambiguation_question": true,
    "generate_explanation": true
  }
}

Le corps de la requête contient les champs suivants :

  • prompt : question en langage naturel de l'utilisateur final.
  • context : contient des informations sur les sources de données.
    • datasource_references : spécifie le type de source de données.
      • alloydb : obligatoire lors de l'interrogation de la base de données. Ce champ change en fonction de la base de données que vous interrogez.
        • database_reference : spécifie les informations liées à votre instance de base de données.
          • cluster_id : ID de cluster de l'instance de base de données.
          • project_id : ID de projet de l'instance de base de données.
          • region : région de l'instance AlloyDB.
          • instance_id : ID d'instance de l'instance AlloyDB.
          • database_id : ID de la base de données.
        • agent_context_reference : établit un lien vers le contexte créé dans la base de données.
          • context_set_id : ID de contexte complet de l'agent du contexte stocké dans la base de données. Exemple : projects/data-agents-project/locations/us-east1/contextSets/bdf_gsql_gemini_all_templates.
  • generationOptions : configure le type de sortie à générer.
    • generate_query_result : défini sur "true" pour générer et renvoyer les résultats de la requête.
    • generate_natural_language_answer : facultatif. Si la valeur est "true", génère une réponse en langage naturel.
    • generate_explanation : facultatif. Si la valeur est "true", génère une explication de la requête SQL.
    • generate_disambiguation_question : facultatif. Si la valeur est "true", génère des questions de levée d'ambiguïté si la requête est ambiguë.

Exemple de réponse QueryData

Voici un exemple de réponse réussie d'un appel QueryData :

{
  "generated_query": "-- Count the number of accounts in Prague that are eligible for loans\nSELECT\n  COUNT(DISTINCT \"loans\".\"account_id\")\nFROM \"loans\"\nJOIN \"district\" -- Join based on district ID\n  ON \"loans\".\"district_id\" = \"district\".\"district_id\"\nWHERE\n  \"district\".\"A3\" = 'Prague'; -- Filter for the Prague region",
  "intent_explanation": "The question asks for the number of accounts eligible for loans in the Prague region. I need to join the `district` table with the `loans` table to filter by region and count the distinct accounts. The `A3` column in the `district` table contains the region information, and I'll filter for 'Prague'. The `loans` table contains information about loans, including the `account_id` and `district_id`. I will join these two tables on their respective district IDs.",
  "query_result": {
    "columns": [
      {
        "name": "count"
      }
    ],
    "rows": [
      {
        "values": [
          {
            "value": "2"
          }
        ]
      }
    ],
    "total_row_count": 1
  },
  "natural_language_answer": "There are 2 accounts in Prague that are eligible for loans."
}

Étape suivante