Dodaj opisy obiektów schematu do agenta danych (podgląd)

Opisy obiektów schematu przekazują agentowi danych kontekst biznesowy dotyczący tabel, kolumn i innych elementów w schemacie źródła danych. Ten kontekst pomaga agentowi rozróżnić obiekty o podobnej nazwie lub niejednoznaczności, zrozumieć cel każdego z nich oraz generować dokładniejsze zapytania. Opisy są szczególnie przydatne w dużych schematach, gdzie same nazwy obiektów nie przekazują jasno ich znaczenia.

Opisy obiektów schematów są obsługiwane dla źródeł danych SQL, w tym domów nad jeziorem, magazynów, baz danych Fabric SQL oraz baz danych lustrzanych.

Uwaga / Notatka

Opisy obiektów schematu są obecnie dostępne w publicznym podglądzie.

Uwaga / Notatka

Opisy obiektów schematu są dostępne tylko wtedy, gdy Twój agent danych korzysta z środowiska uruchomieniowego w wersji zapoznawczej.

Dodaj lub edytuj opis

Domyślnie agent danych dziedziczy dostępne opisy ze źródła danych i aktualizuje je automatycznie. Gdy edytujesz odziedziczony opis w agencie danych, zmiana dotyczy tylko agenta danych. Nie nadpisuje opisu w źródle, a ten obiekt nie otrzymuje już aktualizacji opisu ze źródła.

  1. Otwórz swojego agenta danych, a następnie wybierz Konfiguruj.
  2. W źródle danych wybierz opisy obiektów schematu.
  3. Rozwiń schemat, aby znaleźć obiekt, który chcesz opisać.
  4. Wybierz ikonę Edytuj obok obiektu.
  5. Wprowadź opis, a następnie wybierz Gotowe.

Zrzut ekranu edycji opisu tabeli w panelu opisów obiektów Schema agenta danych.

Dodaj opis za pomocą SDK Python

Użyj Fabric Data Agent Python SDK do programowego zarządzania opisami obiektów schematu. Poniższy przykład przedstawia opis dla jednej tabeli w pierwszym źródle danych istniejącego agenta danych:

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."
})

Krotka identyfikuje element schematu na podstawie jego ścieżki w źródle danych. Aby opisać kolumnę, dodaj jej nazwę do ścieżki tabeli. Na przykład użyj table_path + ("adoption_date",). Nazwy ścieżek są wrażliwe na wielka litera i muszą odpowiadać hierarchii przedstawionej dla źródła danych.

Twórz efektywne opisy

Używaj opisów, aby wyjaśnić znaczenie biznesowe, które nie wynika z nazwy obiektu. Każdy opis powinien być zwięzły i konkretny.

  • W tabelach opisz reprezentowane podmioty biznesowe lub zdarzenia, poziom szczegółowości tabeli oraz jej główny cel.
  • Dla kolumn zdefiniuj biznesowe znaczenie wartości, jej format, jednostkę lub oczekiwane wartości, jeśli mogą być niejasne.
  • W przypadku innych elementów schematu wyjaśnij ich rolę i kiedy agent danych powinien ich używać.
  • Wyjaśnij skróty, terminologię wewnętrzną oraz obiekty o podobnych nazwach.
  • Uwzględnij kontekst, który pomaga agentowi wybrać właściwe obiekty i relacje podczas generowania zapytania.