Метаданные агента в представлениях метрик

Метаданные агента (также известные как семантические метаданные) улучшают визуализацию данных и повышают точность больших языковых моделей (LLM), предоставляя отображаемые имена, спецификации формата и синонимы, которые дают бизнес-контекст метрик. Эти метаданные помогают средствам визуализации и обработки естественного языка, таким как Genie Agents, более эффективно интерпретировать ваши данные и работать с ними.

Note

Требуется Databricks Runtime 17.3 и YAML версии 1.1. См. требования к версии.

Что такое метаданные агента?

Метаданные агента включают отображаемые имена, спецификации формата и синонимы, которые предоставляют дополнительный контекст. Эти метаданные помогают средствам визуализации, таким как панели мониторинга ИИ/BI, а также средства естественного языка, такие как агенты Genie, интерпретируют и работают с данными более эффективно. Метаданные агента определяются в YAML-определении представления метрик.

Note

При создании или изменении представлений метрик с спецификацией версии 1.1 при сохранении определения YAML удаляются все однострочные примечания (обозначаемые с #) в определении YAML. Сведения о параметрах и рекомендациях при обновлении существующих определений YAML см. в разделе "Обновление до YAML 1.1 ".

Примеры на этой странице используют TPC-H пример набора данных (samples.tpch.orders), который доступен по умолчанию в наборах данных каталога Unity. Набор данных TPC-H моделирует оптовую цепочку поставок с таблицами для заказов, клиентов, поставщиков и частей. Имена столбцов в orders таблице используют o_ префикс (например, o_orderdate для даты заказа, o_totalprice для общей цены). Дополнительные сведения о схеме и модели данных TPC-H см. в руководстве по созданию представления метрик с присоединением и моделированием данных.

Отображаемые имена

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

В следующем примере показаны отображаемые имена, заданные для поля order_date (отслеживает время размещения заказов) и меры total_revenue (вычисляет сумму цен всех заказов).

version: 1.1
source: samples.tpch.orders

fields:
  - name: order_date
    expr: o_orderdate
    display_name: 'Order Date'

measures:
  - name: total_revenue
    expr: SUM(o_totalprice)
    display_name: 'Total Revenue'

Synonyms

Синонимы помогают средствам LLM, таким как Genie, обнаруживать поля (также называемые измерениями) и меры с помощью пользовательских входных данных, предоставляя альтернативные имена. Синонимы можно определить с помощью стиля блоков или стиля потока YAML. Каждое поле или мера может иметь до 10 синонимов. Каждый синоним ограничен 255 символами.

В следующем примере показаны синонимы, определенные в order_date поле (когда заказы были размещены) и total_revenue мера (сумма всех цен на заказ). Синонимы позволяют пользователям задавать вопросы с помощью естественного языка, например "показать мне доход по времени заказа" или "что такое общий объем продаж по дате заказа":

version: 1.1
source: samples.tpch.orders

fields:
  - name: order_date
    expr: o_orderdate
    # block style
    synonyms:
      - 'order time'
      - 'date of order'

measures:
  - name: total_revenue
    expr: SUM(o_totalprice)
    # flow style
    synonyms: ['revenue', 'total sales']

Спецификации формата

Спецификации формата определяют способ отображения значений в средствах визуализации. В следующих таблицах приведены поддерживаемые типы форматов и примеры.

Числовые форматы

Тип формата Обязательные параметры Необязательные параметры
Число: Используйте обычный числовой формат для общих числовых значений с необязательной настройкой десятичных знаков и параметрами сокращений. type: number
  • decimal_places: определяет количество мест, отображаемых после десятичного разряда.
    • type: (Требуется, если decimal_places задано)
      • max
      • exact
      • all
    • places: целочисленное значение от 0 до 10 (обязательно, если тип — max или exact)
  • hide_group_separator: если задано значение true, удаляет любой применимый разделитель группирования чисел, например ,.
    • true
    • false
  • abbreviation:
    • none
    • compact
    • scientific
Валюта: используйте формат валюты для денежных значений с кодами валют ISO-4217. type: currency
  • currency_code: код ISO-4217 (обязательный). Например, следующие коды вставляют символ для долларов США, евро и иены соответственно.
    • USD
    • EUR
    • JPY
  • decimal_places: определяет количество мест, отображаемых после десятичного разряда.
    • type: (Требуется, если decimal_places задано)
      • max
      • exact
      • all
  • hide_group_separator: при значении true удаляет любой соответствующий разделитель группирования чисел.
    • true
    • false
  • abbreviation:
    • none
    • compact
    • scientific
Процент: используйте процентный формат для значений соотношения, выраженных в процентах. type: percentage
  • decimal_places: определяет количество мест, отображаемых после десятичного разряда.
    • type: (Требуется, если decimal_places задано)
      • max
      • exact
      • all
  • hide_group_separator: при значении true удаляет любой соответствующий разделитель группирования чисел.
    • true
    • false
Байт: используйте формат байтов для значений размера данных, отображаемых с соответствующими единицами байтов (КБ, МБ, ГБ и т. д.). type: byte
  • decimal_places: определяет количество мест, отображаемых после десятичного разряда.
    • type: (Требуется, если decimal_places задано)
      • max
      • exact
      • all
    • places: целочисленное значение от 0 до 10 (обязательно, если тип — max или exact)
  • hide_group_separator: при значении true удаляет любой соответствующий разделитель группирования чисел.
    • true
    • false

Примеры числовых форматирований

Number

format:
  type: number
  decimal_places:
    type: max
    places: 2
  hide_group_separator: false
  abbreviation: compact

Валюта

format:
  type: currency
  currency_code: USD
  decimal_places:
    type: exact
    places: 2
  hide_group_separator: false
  abbreviation: compact

Процент

format:
  type: percentage
  decimal_places:
    type: all
  hide_group_separator: true

Byte

format:
  type: byte
  decimal_places:
    type: max
    places: 2
  hide_group_separator: false

Форматы даты и времени

В следующей таблице объясняется, как работать с форматами даты и времени.

Тип формата Обязательные параметры Необязательные параметры
Дата: используйте формат даты для значений дат с различными параметрами отображения.
  • type: date
  • date_format: определяет способ отображения даты
    • locale_short_month: отображает дату с сокращенным месяцем
    • locale_long_month: отображает дату с полным именем месяца
    • year_month_day: форматирует дату в формате YYY-MM-DD
    • locale_number_month: отображает дату с месяцем в виде числа
    • year_week: форматирует дату в виде года и числа недели. Например: 2025-W1
  • leading_zeros: определяет, предшествуют ли однозначные цифры нулю.
  • true
  • false
DateTime: используйте формат datetime для значений метки времени, объединяющих дату и время.
  • type: date_time
  • date_format: определяет способ отображения даты
    • no_date: дата скрыта
    • locale_short_month: отображает дату с сокращенным месяцем
    • locale_long_month: отображает дату с полным именем месяца
    • year_month_day: форматирует дату в формате YYY-MM-DD
    • locale_number_month: отображает дату с месяцем в виде числа
    • year_week: форматирует дату в виде года и числа недели. Например: 2025-W1
  • time_format:
    • no_time: время скрыто
    • locale_hour_minute: отображает час и минуту
    • locale_hour_minute_second: отображает час, минуту и секунду
  • leading_zeros: определяет, предшествуют ли однозначные цифры нулю.
    • true
    • false

Note

При работе с типом date_time, по крайней мере одно значение из date_format или time_format должно отличаться от no_date и no_time.

Примеры форматирования даты и времени

Date

format:
  type: date
  date_format: year_month_day
  leading_zeros: true

DateTime

format:
  type: date_time
  date_format: year_month_day
  time_format: locale_hour_minute_second
  leading_zeros: false

Интеграция последующих инструментов

Семантические метаданные автоматически заполняют инструменты, которые обрабатывают представление метрик.

  • Панели мониторинга AI/BI: отображаемые имена и спецификации форматов автоматически заполняются в наборах данных и визуализациях, чтобы улучшить читабельность панелей.
  • Агенты Genie: Синонимы автоматически импортируются, чтобы помочь Genie лучше обнаруживать и понимать доступные поля и меры из представления метрик.

Полный пример

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

Сегменты клиентов определяются следующим образом:

  • Предприятие: заказы более $ 100 000
  • Средний рынок: заказы от $ 10000 до $ 100 000
  • Малый и средний бизнес: Заказы менее 10 000 долл. США

Метаданные поддерживают запросы естественного языка, такие как "показать мне общий объем продаж по сегменту клиента" или "что такое средний доход за заказ".

version: 1.1
source: samples.tpch.orders
comment: Comprehensive sales metrics with enhanced semantic metadata
fields:
  - name: order_date
    expr: o_orderdate
    comment: Date when the order was placed
    display_name: Order Date
    format:
      type: date
      date_format: year_month_day
      leading_zeros: true
    synonyms:
      - order time
      - date of order
  - name: customer_segment
    expr: |
      CASE
        WHEN o_totalprice > 100000 THEN 'Enterprise'
        WHEN o_totalprice > 10000 THEN 'Mid-market'
        ELSE 'SMB'
      END
    comment: Customer classification based on order value
    display_name: Customer Segment
    synonyms:
      - segment
      - customer tier
measures:
  - name: total_revenue
    expr: SUM(o_totalprice)
    comment: Total revenue from all orders
    display_name: Total Revenue
    format:
      type: currency
      currency_code: USD
      decimal_places:
        type: exact
        places: 2
      hide_group_separator: false
      abbreviation: compact
    synonyms:
      - revenue
      - total sales
      - sales amount
  - name: order_count
    expr: COUNT(1)
    comment: Total number of orders
    display_name: Order Count
    format:
      type: number
      decimal_places:
        type: all
      hide_group_separator: true
    synonyms:
      - count
      - number of orders
  - name: avg_order_value
    expr: SUM(o_totalprice) / COUNT(1)
    comment: Average revenue per order
    display_name: Average Order Value
    format:
      type: currency
      currency_code: USD
      decimal_places:
        type: exact
        places: 2
    synonyms:
      - aov
      - average revenue