Ajouter des descriptions d’objets de schéma à un agent de données (aperçu)

Les descriptions d’objets de schéma fournissent à l’agent de données un contexte métier concernant les tables, colonnes et autres éléments dans un schéma de source de données. Ce contexte aide l’agent à distinguer entre des objets au nom similaire ou ambigus, à comprendre le but de chaque objet et à générer des requêtes plus précises. Les descriptions sont particulièrement utiles pour les grands schémas où les noms des objets seuls ne transmettent pas clairement leur signification.

Les descriptions des objets de schéma sont prises en charge avec les sources de données SQL, notamment les lakehouses, les entrepôts, les bases de données SQL Fabric et les bases de données mises en miroir.

Note

Les descriptions des objets de schéma sont actuellement en aperçu public.

Note

Les descriptions d’objets schéma ne sont disponibles que lorsque votre agent de données utilise l’exécution de prévisualisation.

Ajoutez ou modifiez une description

Par défaut, l’agent de données hérite des descriptions disponibles de la source de données et les met à jour automatiquement. Lorsque vous modifiez une description héritée dans l’agent de données, le changement ne s’applique qu’à l’agent de données. Il ne remplace pas la description dans la source, et cet objet ne reçoit plus de mises à jour de description de la source.

  1. Ouvrez votre agent de données, puis sélectionnez Configurer.
  2. Sous la source de données, sélectionnez Descriptions d’objets de schéma.
  3. Déplacez le schéma pour trouver l’objet que vous souhaitez décrire.
  4. Sélectionnez l’icône Modifier à côté de l’objet.
  5. Entrez une description, puis sélectionnez Terminé.

Capture d’écran de l’édition d’une description de tableau dans le panneau descriptions d’objets Schema d’un agent de données.

Ajoutez une description avec le SDK Python

Utilisez le SDK Python de l’agent de données Fabric pour gérer les descriptions d’objets de schéma de façon programmatique. L’exemple suivant présente une description pour une table dans la première source de données d’un agent de données existant :

from fabric.dataagent.client import FabricDataAgentManagement

agent = FabricDataAgentManagement("<data-agent-name>")
datasource = agent.get_datasources()[0]

table_path = ("Schemas", "dbo", "Tables", "adoptions")
datasource.update_description({
    table_path: "Contains one row for each pet adoption transaction."
})

Le tuple identifie l’élément de schéma par son chemin dans la source de données. Pour décrire une colonne, ajoutez son nom au chemin de la table. Par exemple, utilisez table_path + ("adoption_date",). Les noms de chemin sont sensibles à la casse et doivent correspondre à la hiérarchie indiquée pour la source de données.

Rédiger des descriptions efficaces

Utilisez des descriptions pour expliquer le sens commercial qui n’est pas évident dans le nom d’un objet. Gardez chaque description concise et précise.

  • Pour les tableaux, décrivez les entités commerciales ou événements représentés, le niveau de détail de la table et son objectif principal.
  • Pour les colonnes, définissez la signification métier, le format, l’unité ou les valeurs attendues de la valeur lorsqu’elles peuvent être floues.
  • Pour les autres éléments de schéma, expliquez leur rôle et quand l’agent de données doit les utiliser.
  • Clarifiez les abréviations, la terminologie interne et les objets au nom similaire.
  • Incluez un contexte qui aide l’agent à sélectionner les bons objets et relations lors de la génération d’une requête.

Contenu connexe

  • Last updated on