Używanie metadanych semantycznych w widokach metryk

Na tej stronie wyjaśniono, jak używać metadanych semantycznych w widokach metryk w celu ulepszenia wizualizacji danych i zwiększenia dokładności dużego modelu językowego (LLM).

Co to są metadane semantyczne?

Metadane semantyczne zawierają nazwy wyświetlane, specyfikacje formatu i synonimy, które zapewniają dodatkowy kontekst. Te metadane pomagają narzędziom do wizualizacji, takim jak pulpity nawigacyjne sztucznej inteligencji/analizy biznesowej, oraz narzędziom języka naturalnego, takim jak przestrzenie Genie, efektywniej interpretować dane i pracować z nimi. Metadane semantyczne definiuje się w definicji YAML dla widoku metryki.

Nazwy wyświetlane

Nazwy wyświetlane zapewniają czytelne dla człowieka etykiety, które są wyświetlane w narzędziach wizualizacji zamiast nazw kolumn technicznych. Nazwy wyświetlane są ograniczone do 255 znaków.

W poniższym przykładzie przedstawiono nazwy wyświetlane zdefiniowane dla wymiaru order_date i miary total_revenue.

version: 1.1
source: samples.tpch.orders

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

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

Synonyms

Synonimy pomagają narzędziom LLM, takim jak AI/BI Genie, odkrywać wymiary i miary dzięki wejściom użytkownika, oferując alternatywne nazwy. Synonimy można definiować przy użyciu stylu bloku lub stylu przepływu YAML. Każdy wymiar lub miara może mieć maksymalnie 10 synonimów. Każdy synonim jest ograniczony do 255 znaków.

Poniższy przykład pokazuje synonimy zdefiniowane w wymiarze order_date:

version: 1.1
source: samples.tpch.orders

dimensions:
  - 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']

Specyfikacje formatu

Specyfikacje formatu definiują sposób wyświetlania wartości w narzędziach do wizualizacji. W poniższych tabelach znajdują się obsługiwane typy formatów i przykłady.

Formaty liczbowe

Przykłady formatowania liczbowego

Number

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

Waluta

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

Procent

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

Formaty daty i godziny

W poniższej tabeli wyjaśniono, jak pracować z formatami daty i godziny.

Przykłady formatowania daty/godziny

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

Kompletny przykład

W poniższym przykładzie przedstawiono definicję widoku metryki, która zawiera wszystkie typy metadanych semantycznych:

version: 1.1
source: samples.tpch.orders
comment: Comprehensive sales metrics with enhanced semantic metadata
dimensions:
  - 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