Aggiungi descrizioni degli oggetti schema a un data agent (anteprima)

Le descrizioni degli oggetti dello schema forniscono al data agent un contesto aziendale riguardo a tabelle, colonne e altri elementi in uno schema di sorgente dati. Questo contesto aiuta l'agente a distinguere tra oggetti con nome simile o ambigui, a comprendere lo scopo di ciascun oggetto e a generare query più accurate. Le descrizioni sono particolarmente utili per grandi schemi dove i nomi degli oggetti da soli non ne trasmettono chiaramente il significato.

Le descrizioni degli oggetti schema sono supportate per sorgenti dati SQL, inclusi lakehouse, magazzini, database Fabric SQL e database speculari.

Annotazioni

Le descrizioni degli oggetti schema sono attualmente in anteprima pubblica.

Annotazioni

Le descrizioni degli oggetti dello schema sono disponibili solo quando il tuo agente dati utilizza il runtime di anteprima.

Aggiungi o modifica una descrizione

Per impostazione predefinita, l'agente dati eredita le descrizioni disponibili dalla fonte dei dati e le aggiorna automaticamente. Quando modifichi una descrizione ereditata nell'agente dati, la modifica si applica solo all'agente dati. Non sovrascrive la descrizione nel sorgente, e quell'oggetto non riceve più aggiornamenti di descrizione dalla fonte.

  1. Apri il tuo data agent e poi seleziona Configura.
  2. Sotto la sorgente dati, seleziona Descrizioni degli oggetti schema.
  3. Espandi lo schema per trovare l'oggetto che vuoi descrivere.
  4. Seleziona l'icona Modifica accanto all'oggetto.
  5. Inserisci una descrizione e poi seleziona Fatto.

Schermata della modifica della descrizione di una tabella nel riquadro delle descrizioni degli oggetti dello schema di un agente dati.

Aggiungi una descrizione con l'SDK Python

Usa l'SDK Python dell'agente dati Fabric per gestire le descrizioni degli oggetti schema in modo programmativo. Il seguente esempio fornisce una descrizione per una tabella nella prima fonte dati di un agente dati esistente:

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

La tupla identifica l'elemento dello schema tramite il suo percorso nella sorgente dati. Per descrivere una colonna, aggiungi il suo nome al percorso della tabella. Ad esempio, usare table_path + ("adoption_date",). I nomi dei percorsi sono sensibili a maiuscole e minuscole e devono corrispondere alla gerarchia mostrata per l'origine dati.

Scrivi descrizioni efficaci

Usa descrizioni per spiegare il significato commerciale che non è evidente dal nome di un oggetto. Mantieni ogni descrizione concisa e specifica.

  • Per le tabelle, descrivi le entità aziendali o gli eventi rappresentati, il livello di dettaglio della tabella e il suo scopo principale.
  • Per le colonne, definisci il significato business, il formato, l'unità o i valori attesi del valore quando potrebbero non essere chiari.
  • Per gli altri elementi dello schema, spiega il loro ruolo e quando l'agente dati dovrebbe utilizzarli.
  • Chiarire abbreviazioni, terminologia interna e oggetti con nomi simili.
  • Includi un contesto che aiuti l'agente a selezionare gli oggetti e le relazioni corrette quando genera una query.