Voeg schema-objectbeschrijvingen toe aan een data-agent (preview)

Schema-objectbeschrijvingen geven de dataagent bedrijfscontext over tabellen, kolommen en andere elementen in een databronschema. Deze context helpt de agent onderscheid te maken tussen objecten met vergelijkbare of dubbelzinnige benoemingen, het doel van elk object te begrijpen en nauwkeurigere zoekopdrachten te genereren. Beschrijvingen zijn vooral nuttig voor grote schema's waarbij objectnamen alleen hun betekenis niet duidelijk overbrengen.

Schema-objectbeschrijvingen worden ondersteund voor SQL-databronnen, waaronder lakehouses, warehouses, Fabric SQL-databases en gespiegelde databases.

Opmerking

Schema-objectbeschrijvingen zijn momenteel in openbare preview.

Opmerking

Schema-objectbeschrijvingen zijn alleen beschikbaar wanneer je data-agent de preview-runtime gebruikt.

Voeg een beschrijving toe of bewerk

Standaard erft de dataagent beschikbare beschrijvingen van de databron en werkt deze automatisch bij. Wanneer je een geërfde beschrijving in de data-agent bewerkt, geldt de wijziging alleen voor de data-agent. Het overschrijft de beschrijving in de bron niet, en dat object ontvangt geen beschrijvingsupdates meer van de bron.

  1. Open je data-agent en selecteer dan Setup.
  2. Selecteer onder de gegevensbron Schema objectbeschrijvingen.
  3. Breid het schema uit om het object te vinden dat je wilt beschrijven.
  4. Selecteer het Bewerken-icoon naast het object.
  5. Voer een beschrijving in en selecteer dan Klaar.

Screenshot van het bewerken van een tabelbeschrijving in het Schema object descriptions-paneel van een data-agent.

Voeg een beschrijving toe met de Python SDK

Gebruik de Fabric data agent Python SDK om schema-objectbeschrijvingen programmatisch te beheren. Het volgende voorbeeld geeft een beschrijving voor één tabel in de eerste databron van een bestaande data-agent:

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

De tuple identificeert het schema-element via zijn pad in de databron. Om een kolom te beschrijven, voeg je de naam toe aan het tabelpad. Gebruik bijvoorbeeld table_path + ("adoption_date",). Padnamen zijn hoofdlettergevoelig en moeten overeenkomen met de hiërarchie die voor de databron wordt getoond.

Effectieve beschrijvingen schrijven

Gebruik beschrijvingen om zakelijke betekenis uit te leggen die niet duidelijk is uit de naam van een object. Houd elke beschrijving beknopt en specifiek.

  • Voor tabellen beschrijf je de voorgestelde bedrijfsentiteiten of gebeurtenissen, het detailniveau van de tabel en het primaire doel ervan.
  • Definieer voor kolommen de zakelijke betekenis, formaat, eenheid of verwachte waarden van de waarde wanneer deze onduidelijk kunnen zijn.
  • Voor andere schema-elementen, leg hun rol uit en wanneer de data-agent ze moet gebruiken.
  • Verduidelijking van afkortingen, interne terminologie en objecten met vergelijkbare namen.
  • Voeg context toe die de agent helpt de juiste objecten en relaties te selecteren bij het genereren van een query.

Verwante onderwerpen

  • Last updated on