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

備考

プレビュー

メトリクスビューのセマンティックメタデータは、メトリクスビューを操作する際のデータ視覚化を強化し、大規模言語モデル ( LLM ) の精度を向上させる追加のコンテキストと情報を提供します。メタデータには、 AI/BIダッシュボードなどの視覚化ツールやGenie spacesなどの自然言語AIツールがデータをより効果的に理解して操作するのに役立つ表示名、形式の仕様、同義語が含まれます。

注記

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

セマンティックメタデータとは何ですか?

セマンティックメタデータは、メトリクスビューのディメンションとメジャーに関する追加のコンテキストと情報を提供します。これは、メトリクスビューの YAML 定義で定義されます。含めることができるメタデータの種類は次のとおりです。

注記

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

表示名

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

次の例は、 order_dateディメンションとtotal_revenueメジャーで定義された表示名を示しています。

YAML
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'

同義語

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

次の例は、 order_dateディメンションで定義された同義語を示しています。

YAML
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
Currency
Percentage

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

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

YAML
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桁の数字の前にゼロを付けるかどうかを制御します `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桁の数字の前にゼロを付けるかどうかを制御します `true` `false`

注記

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

日付時刻の書式設定の例

Date
DateTime

YAML
format:
  type: date
  date_format: year_month_day
  leading_zeros: true

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

完全な例

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

YAML
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

セマンティック メタデータとは何ですか?​

表示名​

同義語​

フォーマット仕様​

数値形式​

数値の書式設定の例​

日付と時刻の形式​

日付時刻の書式設定の例​

完全な例​