Legg til skjemaobjektbeskrivelser i en dataagent (forhåndsvisning)

Skjemaobjektbeskrivelser gir dataagentens forretningskontekst om tabeller, kolonner og andre elementer i et datakildeskjema. Denne konteksten hjelper agenten å skille mellom objekter med lignende navn eller tvetydigheter, forstå formålet med hvert objekt, og generere mer nøyaktige spørringer. Beskrivelser er spesielt nyttige for store skjemaer der objektnavn alene ikke tydelig formidler betydningen.

Skjemaobjektbeskrivelser støttes for SQL-datakilder, inkludert lakehouses, warehouses, Fabric SQL-databaser og speilede databaser.

Merknad

Beskrivelser av skjemaobjekter er for øyeblikket i offentlig forhåndsvisning.

Merknad

Beskrivelser av skjemaobjekter er kun tilgjengelige når dataagenten din bruker forhåndsvisningskjøringen.

Legg til eller rediger en beskrivelse

Som standard arver dataagenten tilgjengelige beskrivelser fra datakilden og oppdaterer dem automatisk. Når du redigerer en arvet beskrivelse i dataagenten, gjelder endringen kun for dataagenten. Den overskriver ikke beskrivelsen i kilden, og det objektet mottar ikke lenger beskrivelsesoppdateringer fra kilden.

  1. Åpne dataagenten din, og velg deretter Oppsett.
  2. Under datakilden, velg Skjema-objektbeskrivelser.
  3. Utvid skjemaet for å finne objektet du vil beskrive.
  4. Velg Rediger-ikonet ved siden av objektet.
  5. Skriv inn en beskrivelse, og velg deretter Ferdig.

Skjermbilde av redigering av en tabellbeskrivelse i Schema-objektbeskrivelsespanelet til en dataagent.

Legg til en beskrivelse med Python SDK

Bruk Fabric-dataagenten Python SDK for å administrere skjema-objektbeskrivelser programmatisk. Følgende eksempel setter en beskrivelse for én tabell i den første datakilden til en eksisterende 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 identifiserer skjema-elementet via dets sti i datakilden. For å beskrive en kolonne, legg til navnet dens i tabellens sti. Bruk table_path + ("adoption_date",)for eksempel. Stinavn er små og små bokstaver og må samsvare med hierarkiet som vises for datakilden.

Skrive effektive beskrivelser

Bruk beskrivelser for å forklare forretningsbetydning som ikke er tydelig ut fra objektets navn. Hold hver beskrivelse kortfattet og spesifikk.

  • For tabeller, beskriv forretningsenhetene eller hendelsene som representeres, tabellens detaljnivå og dens primære formål.
  • For kolonner, definer verdiens forretningsbetydning, format, enhet eller forventede verdier når de kan være uklare.
  • For andre skjemaelementer, forklar deres rolle og når dataagenten skal bruke dem.
  • Klargjør forkortelser, intern terminologi og lignende navngitte objekter.
  • Inkluder kontekst som hjelper agenten med å velge riktige objekter og relasjoner når de genererer en spørring.