次の方法で共有


メトリック ビューでセマンティック メタデータを使用する

Important

この機能は パブリック プレビュー段階です

このページでは、メトリック ビューでセマンティック メタデータを使用して、データの視覚化を強化し、大規模な言語モデル (LLM) の精度を向上させる方法について説明します。

Databricks Runtime 17.2 以降が必要です。 メトリック ビューの YAML 定義では、仕様バージョン 1.1 以降を使用する必要があります。 詳細については、 バージョン仕様の変更ログ を参照してください。

セマンティック メタデータとは

セマンティック メタデータには、追加のコンテキストを提供する表示名、書式指定、シノニムが含まれます。 このメタデータは、AI/BI ダッシュボードなどの視覚化ツールや、 Genie スペースなどの自然言語ツールで、データをより効果的に解釈して操作するのに役立ちます。 セマンティック メタデータは、メトリック ビューの YAML 定義で定義されます。

仕様バージョン 1.1 でメトリック ビューを作成または変更すると、YAML 定義内の 1 行のコメント ( #で示されます) は、定義の保存時に削除されます。 既存の YAML 定義をアップグレードするときのオプションと推奨事項については、「 YAML を 1.1 にアップグレードする」を参照してください。

表示名

表示名は、技術的な列名ではなく、視覚化ツールに人間が判読できるラベルとして表示されます。 表示名は 255 文字に制限されています。

次の例は、 order_date ディメンションと 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

類義語は、 AI/BI Genie などの LLM ツールで、代替名を指定してユーザー入力を通じてディメンションとメジャーを検出するのに役立ちます。 ブロック スタイルまたはフロー スタイル YAML を使用してシノニムを定義できます。 各ディメンションまたはメジャーには、最大 10 個のシノニムを含めることができます。 各シノニムは 255 文字に制限されています。

次の例は、 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']

書式の仕様

書式指定は、視覚化ツールでの値の表示方法を定義します。 次の表に、サポートされている形式の種類と例を示します。

数値形式

書式の種類 必須オプション 省略可能なオプション
数値: 省略可能な小数点以下の桁数と省略形のオプションを持つ一般的な数値には、プレーンな数値形式を使用します。 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

数値書式の例

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

日付と時刻の形式

次の表では、日付と時刻の形式を操作する方法について説明します。

書式の種類 必須オプション 省略可能なオプション
日付: さまざまな表示オプションを持つ日付値に日付形式を使用します。
  • type: date
  • date_format: 日付の表示方法を制御します。
    • locale_short_month: 月を省略して日付を表示します。
    • locale_long_month: 月の完全な名前を持つ日付を表示します
    • year_month_day: 日付を YYYY-MM-DD として書式設定します。
    • locale_number_month: 月の日付を数値として表示します。
    • year_week: 日付を年と週の数値として書式設定します。 たとえば、2025-W1 のように指定します。
  • leading_zeros: 1 桁の数字の前に 0 を付けたかどうかを制御します。
  • true
  • false
DateTime: 日付と時刻を組み合わせたタイムスタンプ値には datetime 形式を使用します。
  • type: date_time
  • date_format: 日付の表示方法を制御します。
    • no_date: 日付は非表示です
    • locale_short_month: 月を省略して日付を表示します。
    • locale_long_month: 月の完全な名前を持つ日付を表示します
    • year_month_day: 日付を YYYY-MM-DD として書式設定します。
    • locale_number_month: 月の日付を数値として表示します。
    • year_week: 日付を年と週の数値として書式設定します。 たとえば、2025-W1 のように指定します。
  • time_format:
    • no_time: 時間が非表示です
    • locale_hour_minute: 時間と分を表示します。
    • locale_hour_minute_second: 時間、分、秒を表示します。
  • leading_zeros: 1 桁の数字の前に 0 を付けたかどうかを制御します。
    • true
    • false

date_time型を使用する場合は、少なくとも 1 つのdate_formatまたはtime_formatで、no_dateまたはno_time以外の値を指定する必要があります。

Datetime の書式設定の例

日付
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

コード例全体

次の例は、すべてのセマンティック メタデータ型を含むメトリック ビュー定義を示しています。

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