Lägg till schemaobjektbeskrivningar till en dataagent (förhandsgranskning)

Beskrivningar av schemaobjekten ger dataagentens affärskontext om tabeller, kolumner och andra element i ett datakällschema. Denna kontext hjälper agenten att skilja mellan liknande namngiven eller tvetydig objekt, förstå syftet med varje objekt och generera mer exakta frågor. Beskrivningar är särskilt användbara för stora scheman där objektnamn ensamma inte tydligt förmedlar deras betydelse.

Schemaobjektbeskrivningar stöds för SQL-datakällor, inklusive lakehouses, lager, Fabric SQL-databaser och speglade databaser.

Anmärkning

Schemaobjektbeskrivningar finns för närvarande i offentlig förhandsvisning.

Anmärkning

Schemaobjektbeskrivningar är endast tillgängliga när din dataagent använder preview-runtime.

Lägg till eller redigera en beskrivning

Som standard ärver dataagenten tillgängliga beskrivningar från datakällan och uppdaterar dem automatiskt. När du redigerar en ärvd beskrivning i dataagenten gäller ändringen endast dataagenten. Den skriver inte över beskrivningen i källkoden, och det objektet får inte längre beskrivningsuppdateringar från källkoden.

  1. Öppna din dataagent och välj sedan Setup.
  2. Under datakällan, välj Schema-objektbeskrivningar.
  3. Expandera schemat för att hitta objektet du vill beskriva.
  4. Välj Redigera-ikonen bredvid objektet.
  5. Skriv in en beskrivning och välj sedan Klart.

Skärmdump av redigering av en tabellbeskrivning i panelen Schema objektbeskrivningar i en dataagent.

Lägg till en beskrivning med Python SDK

Använd Fabric data agent Python SDK för att hantera schema-objektbeskrivningar programmatiskt. Följande exempel anger en beskrivning för en tabell i den första datakällan för en befintlig dataagent:

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

Tuplen identifierar schemaelementet genom dess väg i datakällan. För att beskriva en kolumn lägger du till kolumnens namn i tabellsökvägen. Använd till exempel table_path + ("adoption_date",). Vägnamn är kasuskänsliga och måste matcha hierarkin som visas för datakällan.

Skriv effektiva beskrivningar

Använd beskrivningar för att förklara affärsbetydelse som inte är uppenbar från ett objekts namn. Håll varje beskrivning kortfattad och specifik.

  • För tabeller, beskriv de affärsenheter eller händelser som representeras, tabellens detaljnivå och dess huvudsakliga syfte.
  • För kolumner, definiera värdets affärsbetydelse, format, enhet eller förväntade värden när de kan vara oklara.
  • För andra schemaelement, förklara deras roll och när dataagenten ska använda dem.
  • Förtydliga förkortningar, intern terminologi och objekt med liknande namn.
  • Inkludera kontext som hjälper agenten att välja rätt objekt och relationer när en fråga genereras.

Relaterat innehåll

  • Last updated on