Aller au contenu principal

Ajouter des commentaires aux données et actifs d'IA.

Cet article présente les commentaires pour les assets de données et d'IA et explique comment les ajouter. Les commentaires peuvent vous aider, vous et d'autres utilisateurs, à trouver et à gérer les assets de données et d'IA dont vous avez besoin.

Les commentaires fournissent un champ de métadonnées pour annoter vos objets sécurisables. Vous pouvez ajouter des commentaires à tout objet sécurisable dans Unity Catalog, tels que des catalogues, des schémas, des tables, des volumes, des modèles d'IA, et plus encore. Vous pouvez également ajouter des commentaires aux colonnes de table.

Après avoir ajouté des commentaires à un objet sécurisable, tout utilisateur disposant de privilèges BROWSE peut consulter les commentaires. Ceci améliore la visibilité des données dans votre catalogue.

Vous pouvez ajouter des commentaires manuellement, ou vous pouvez laisser Databricks créer des commentaires générés par l'IA pour vous. Les commentaires générés par l'IA (également appelés documentation générée par l'IA) sont disponibles pour les tables et les colonnes de table. Voir Ajouter des commentaires générés par l'IA aux objets Unity Catalog.

Lorsque vous modifiez des commentaires pour une table Unity Catalog (ou une table Delta Lake dans le Hive metastore hérité), une opération SET TBLPROPERTIES dans l'historique de la table enregistre la query SQL qui a été utilisée pour définir le commentaire de la table.

Avant de commencer

Vous devez satisfaire aux exigences suivantes pour ajouter ou modifier des commentaires :

  • Pour ajouter ou modifier des commentaires sur un catalogue, un schéma, un volume, un modèle, un partage, un destinataire, un fournisseur, un identifiant de stockage, un emplacement externe ou une connexion, vous devez être le propriétaire de l'objet ou disposer du privilège MANAGE sur l'objet.

  • Pour ajouter ou modifier des commentaires sur une table ou une colonne, vous devez en être le propriétaire ou disposer des privilèges suivants :

    • MODIFY et SELECT sur la table.
    • USE CATALOG et USE SCHEMA sur le catalogue parent et le schéma.
  • Pour ajouter ou modifier des commentaires sur une vue ou une vue matérialisée, vous devez être le propriétaire de la vue. Disposer du privilège MANAGE est insuffisant.

  • Vous devez utiliser un SQL warehouse ou un autre compute qui prend en charge Unity Catalog.

  • Pour utiliser les commentaires générés par l'IA, votre Workspace doit être activé pour les fonctionnalités d'assistance par l'IA. Voir Ajouter des commentaires générés par l'IA aux objets Unity Catalog.

Ajouter et modifier les commentaires

Vous pouvez ajouter des commentaires aux objets sécurisables ou les modifier à l'aide de commandes SQL ou de l'Explorateur de catalogue.

important

L'enregistrement des commentaires déclenche une commande SQL ALTER, ce qui peut perturber les pipelines et les jobs Databricks.

  1. Dans la barre latérale du Workspace, cliquez sur Icône de données. Catalogue pour ouvrir l'Explorateur de catalogues.

  2. Recherchez et sélectionnez l'objet que vous souhaitez commenter.

    Les objets de données et d'IA sont répertoriés et consultables dans le volet Catalogue . Les partages, les identifiants de stockage, les emplacements externes et les connexions sont accessibles à l'aide du menu qui s'ouvre lorsque vous cliquez sur l'icône Icône d'engrenage. en forme d'engrenage.

  3. Ajoutez un commentaire ou modifiez un commentaire existant.

    • Pour ajouter un commentaire à une table à l'aide de commentaires générés par l'IA , affichez le commentaire suggéré par l'IA dans le volet droit de la tab Vue d'ensemble . Son affichage peut prendre quelques secondes. Vous pouvez soit l' accepter tel quel, soit le modifier et l'enregistrer.
    • Pour ajouter un commentaire à une colonne de tableau en utilisant des commentaires générés par l'IA , cliquez sur le bouton Générer de l'IA au-dessus de la liste des colonnes. Databricks génère des commentaires pour chaque colonne. Acceptez-les en l'état ou modifiez-les. Cliquez sur la coche pour enregistrer le commentaire.
    • Pour ajouter un commentaire à un objet qui ne prend pas en charge les commentaires générés par l'IA , cliquez sur Ajouter un commentaire pour ajouter un commentaire.
    • Pour ajouter un commentaire à une colonne de tableau sans utiliser les commentaires générés par l'IA , cliquez sur l'icône Icône pour ajouter un tag ou un commentaire de colonne Ajouter un commentaire dans la ligne de la colonne.
    • Si un commentaire existe déjà , il apparaît dans le volet droit de l'onglet tab ou sous le nom de l'objet. Si ce n'est pas généré par l'IA, cliquez sur l'icône « Modifier » Icône de modification pour le modifier.

Vous pouvez utiliser du Markdown de base pour styliser les commentaires dans l'interface utilisateur de Catalog Explorer. La mise en forme Markdown ne s'affiche pas lorsqu'elle est renvoyée par les déclarations DESCRIBE. Toute la syntaxe de base est prise en charge dans l'Explorateur de catalogues, à l'exception des images. Pour plus d'informations, consultez la syntaxe de base.

Pour plus d'informations sur les commentaires générés par l'IA, consultez Ajouter des commentaires générés par l'IA aux objets Unity Catalog.