Añadir descripciones de objetos de esquema a un agente de datos (vista previa)

Las descripciones de objetos de esquema proporcionan al agente de datos contexto empresarial sobre tablas, columnas y otros elementos en un esquema fuente de datos. Este contexto ayuda al agente a distinguir entre objetos con nombres similares o ambiguos, entender el propósito de cada objeto y generar consultas más precisas. Las descripciones son especialmente útiles para esquemas grandes donde los nombres de los objetos por sí solos no transmiten claramente su significado.

Se soportan descripciones de objetos de esquema para fuentes de datos SQL, incluyendo lakehouses, almacenes, bases de datos SQL Fabric y bases de datos espejadas.

Nota:

Las descripciones de los objetos de esquema están actualmente en vista previa pública.

Nota:

Las descripciones de objetos de esquema solo están disponibles cuando tu agente de datos utiliza el tiempo de ejecución de la previsualización.

Añadir o editar una descripción

Por defecto, el agente de datos hereda las descripciones disponibles de la fuente de datos y las actualiza automáticamente. Cuando editas una descripción heredada en el agente de datos, el cambio solo se aplica al agente de datos. No sobrescribe la descripción en la fuente, y ese objeto ya no recibe actualizaciones de descripción de la fuente.

  1. Abre tu agente de datos y luego selecciona Configurar.
  2. En la fuente de datos, selecciona Descripciones de objetos de esquema.
  3. Amplía el esquema para encontrar el objeto que quieres describir.
  4. Selecciona el icono de Editar junto al objeto.
  5. Escribe una descripción y, a continuación, selecciona Listo.

Captura de pantalla de la edición de una descripción de tabla en el panel de descripciones de objetos Esquema de un agente de datos.

Añadir una descripción con el SDK de Python

Utiliza el Fabric Data Agent Python SDK para gestionar las descripciones de objetos de esquema de forma programática. El siguiente ejemplo establece una descripción para una tabla en la primera fuente de datos de un agente de datos existente:

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 el elemento del esquema por su camino en la fuente de datos. Para describir una columna, añade su nombre al camino de la tabla. Por ejemplo, use table_path + ("adoption_date",). Los nombres de ruta distinguen entre mayúsculas y minúsculas y deben coincidir con la jerarquía mostrada para la fuente de datos.

Escribir descripciones efectivas

Utiliza descripciones para explicar el significado empresarial que no se refleja en el nombre de un objeto. Mantén cada descripción concisa y específica.

  • Para las tablas, describe las entidades o eventos empresariales representados, el nivel de detalle de la tabla y su propósito principal.
  • Para las columnas, define el significado de negocio, formato, unidad o valores esperados del valor cuando puedan no ser claros.
  • Para otros elementos del esquema, explica su función y cuándo debe usarlos el agente de datos.
  • Aclarar abreviaturas, terminología interna y objetos con nombres similares.
  • Incluye contexto que ayude al agente a seleccionar los objetos y relaciones correctos al generar una consulta.

Contenido relacionado

  • Last updated on