Добавить описания объектов схемы в агент данных (предварительная версия)

Описания объектов схемы дают бизнес-контекст агента данных о таблицах, столбцах и других элементах в схеме источника данных. Этот контекст помогает агенту различать объекты с похожими названиями или неоднозначными, понять назначение каждого объекта и генерировать более точные запросы. Описания особенно полезны для больших схем, где имена объектов сами по себе не отражают их значение.

Описания объектов схемы поддерживаются для источников данных SQL, включая lakehouses, хранилища, базы данных Fabric SQL и зеркальные базы данных.

Примечание.

Описания объектов схемы сейчас находятся в публичном предпросмотре.

Примечание.

Описания объектов схемы доступны только тогда, когда ваш агент данных использует среду предварительного просмотра.

Добавить или отредактировать описание

По умолчанию агент данных наследует доступные описания от источника данных и автоматически их обновляет. Когда вы редактируете унаследованное описание в агенте данных, изменение применяется только к агенту данных. Он не перезаписывает описание в исходном коде, и этот объект больше не получает обновления описания от источника.

  1. Откройте агент данных и выберите «Настройка».
  2. В источнике данных выберите описания объектов схемы.
  3. Разверните схему, чтобы найти нужный объект.
  4. Выберите значок «Редактировать » рядом с объектом.
  5. Введите описание и выберите «Готово».

Скриншот редактирования описания таблицы в панели описаний объектов схемы агента данных.

Добавьте описание с помощью Python SDK

Используйте агент данных Fabric Python SDK для программного управления описаниями объектов схемы. Следующий пример задаёт описание одной таблицы в первом источнике данных существующего агента данных:

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

Кортеж идентифицирует элемент схемы по его пути в источнике данных. Чтобы описать столбец, добавьте его имя в путь к таблице. Например, используйте table_path + ("adoption_date",). Имена путей чувствительны к регистру и должны соответствовать иерархии, показанной для источника данных.

Создавайте эффективные описания

Используйте описания, чтобы объяснить значение бизнеса, которое не видно из названия объекта. Держите каждое описание кратким и конкретным.

  • Для таблиц опишите представленные бизнес-единицы или события, уровень детализации таблицы и её основное назначение.
  • Для столбцов указывайте бизнес-смысл значения, формат, единицу измерения или ожидаемые значения, если они могут быть неясны.
  • Для других элементов схемы объясните их роль и когда агент данных должен их использовать.
  • Уточните сокращения, внутреннюю терминологию и объекты с похожими названиями.
  • Включайте контекст, который помогает агенту выбрать правильные объекты и отношения при генерации запроса.

Связанные материалы

  • Последнее обновление: