Metadata agen dalam tampilan metrik

Metadata agen (juga dikenal sebagai metadata semantik) meningkatkan visualisasi data dan meningkatkan akurasi model bahasa besar (LLM) dengan memberikan nama tampilan, spesifikasi format, dan sinonim yang memberikan konteks bisnis untuk metrik Anda. Metadata ini membantu alat visualisasi dan alat bahasa alami seperti Genie Spaces menafsirkan dan bekerja dengan data Anda secara lebih efektif.

Nota

Memerlukan Databricks Runtime 17.3 dan YAML versi 1.1. Lihat persyaratan versi.

Apa itu metadata agen?

Metadata agen mencakup nama tampilan, spesifikasi format, dan sinonim yang menyediakan konteks tambahan. Metadata ini membantu alat visualisasi, seperti dasbor AI/BI, dan alat bahasa alami, seperti Genie Spaces, menafsirkan dan bekerja dengan data Anda secara lebih efektif. Metadata agen didefinisikan dalam definisi YAML tampilan metrik.

Nota

Saat Anda membuat atau mengubah tampilan metrik dengan spesifikasi versi 1.1, komentar baris tunggal apa pun (ditandai dengan #) dalam definisi YAML dihapus saat definisi disimpan. Lihat Meningkatkan ke YAML 1.1 untuk opsi dan rekomendasi saat meningkatkan definisi YAML yang ada.

Contoh di halaman ini menggunakan himpunan data sampel TPC-H (samples.tpch.orders), yang tersedia secara default di himpunan data Unity Catalog. Himpunan data TPC-H memodelkan rantai pasokan grosir dengan tabel untuk pesanan, pelanggan, pemasok, dan bagian. Nama kolom dalam orders tabel menggunakan awalan o_ (misalnya, o_orderdate untuk tanggal pesanan, o_totalprice untuk harga total). Untuk detail tentang skema TPC-H dan model data, lihat Tutorial: Membuat tampilan metrik lengkap dengan gabungan.

Nama tampilan

Nama tampilan menyediakan label yang dapat dibaca manusia yang muncul di alat visualisasi alih-alih nama kolom teknis. Nama tampilan dibatasi hingga 255 karakter.

Contoh berikut menunjukkan nama tampilan yang ditentukan pada order_date dimensi (pelacakan saat pesanan ditempatkan) dan total_revenue ukuran (menghitung jumlah semua harga pesanan).

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

Sinonim membantu alat LLM, seperti Genie, menemukan dimensi dan pengukuran melalui input pengguna dengan memberikan nama alternatif. Anda dapat menentukan sinonim menggunakan GAYA blok atau gaya alur YAML. Setiap dimensi atau ukuran dapat memiliki hingga 10 sinonim. Setiap sinonim dibatasi hingga 255 karakter.

Contoh berikut menunjukkan sinonim yang ditentukan pada dimensi order_date (saat pesanan dipasang) dan ukuran total_revenue (jumlah semua harga pesanan). Sinonim memungkinkan pengguna untuk mengajukan pertanyaan menggunakan bahasa alami seperti "tunjukkan pendapatan menurut waktu pesanan" atau "apa itu total penjualan berdasarkan tanggal pesanan":

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

Spesifikasi format

Spesifikasi format menentukan bagaimana nilai harus ditampilkan dalam alat visualisasi. Tabel berikut ini menyertakan jenis format dan contoh yang didukung.

Format numerik

Jenis Format Opsi yang Diperlukan Pilihan Opsional
Angka: Gunakan format angka biasa untuk nilai numerik umum dengan kontrol tempat desimal opsional dan opsi singkatan. type: number
  • decimal_places: Mengontrol jumlah tempat yang ditampilkan setelah desimal.
    • type: (Diperlukan jika decimal_places ditentukan)
      • max
      • exact
      • all
    • places: Nilai bilangan bulat dari 0-10 (diperlukan jika jenis adalah max atau exact)
  • hide_group_separator: Jika diatur ke true, menghapus pemisah pengelompokan angka yang sesuai, seperti ,.
    • true
    • false
  • abbreviation:
    • none
    • compact
    • scientific
Mata Uang: Gunakan format mata uang untuk nilai moneter dengan kode mata uang ISO-4217. type: currency
  • currency_code: Kode ISO-4217 (diperlukan). Misalnya, kode berikut menyisipkan simbol untuk dolar AS, Euro, dan Yen, masing-masing.
    • USD
    • EUR
    • JPY
  • decimal_places: Mengontrol jumlah tempat yang ditampilkan setelah desimal.
    • type: (Diperlukan jika decimal_places ditentukan)
      • max
      • exact
      • all
  • hide_group_separator: Jika diatur ke true, menghapus pemisah pengelompokan angka yang berlaku.
    • true
    • false
  • abbreviation:
    • none
    • compact
    • scientific
Persentase: Gunakan format persentase untuk nilai rasio yang dinyatakan sebagai persentase. type: percentage
  • decimal_places: Mengontrol jumlah tempat yang ditampilkan setelah desimal.
    • type: (Diperlukan jika decimal_places ditentukan)
      • max
      • exact
      • all
  • hide_group_separator: Jika diatur ke true, menghapus pemisah pengelompokan angka yang berlaku.
    • true
    • false
Byte: Gunakan format byte untuk nilai ukuran data yang ditampilkan dengan unit byte yang sesuai (KB, MB, GB, dll.). type: byte
  • decimal_places: Mengontrol jumlah tempat yang ditampilkan setelah desimal.
    • type: (Diperlukan jika decimal_places ditentukan)
      • max
      • exact
      • all
    • places: Nilai bilangan bulat dari 0-10 (diperlukan jika jenis adalah max atau exact)
  • hide_group_separator: Jika diatur ke true, menghapus pemisah pengelompokan angka yang berlaku.
    • true
    • false

Contoh pemformatan numerik

Angka

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

Mata Uang

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

Persentase

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

Format tanggal dan waktu

Tabel berikut menjelaskan cara bekerja dengan format tanggal dan waktu.

Jenis Format Opsi yang Diperlukan Pilihan Opsional
Tanggal: Gunakan format tanggal untuk nilai tanggal dengan berbagai opsi tampilan.
  • type: date
  • date_format: Mengontrol cara tanggal ditampilkan
    • locale_short_month: Menampilkan tanggal dengan bulan yang disingkat
    • locale_long_month: Menampilkan tanggal dengan nama lengkap bulan
    • year_month_day: Memformat tanggal sebagai YYYY-MM-DD
    • locale_number_month: Menampilkan tanggal dengan bulan sebagai angka
    • year_week: Memformat tanggal sebagai tahun dan nomor minggu. Misalnya: 2025-W1
  • leading_zeros: Mengontrol apakah angka digit tunggal didahului dengan nol
  • true
  • false
DateTime: Gunakan format tanggal dan waktu untuk nilai cap waktu yang menggabungkan tanggal dan waktu.
  • type: date_time
  • date_format: Mengontrol cara tanggal ditampilkan
    • no_date: Tanggal disembunyikan
    • locale_short_month: Menampilkan tanggal dengan bulan yang disingkat
    • locale_long_month: Menampilkan tanggal dengan nama lengkap bulan
    • year_month_day: Memformat tanggal sebagai YYYY-MM-DD
    • locale_number_month: Menampilkan tanggal dengan bulan sebagai angka
    • year_week: Memformat tanggal sebagai tahun dan nomor minggu. Misalnya: 2025-W1
  • time_format:
    • no_time: Waktu disembunyikan
    • locale_hour_minute: Menampilkan jam dan menit
    • locale_hour_minute_second: Menampilkan jam, menit, dan detik
  • leading_zeros: Mengontrol apakah angka digit tunggal didahului dengan nol
    • true
    • false

Nota

Saat bekerja dengan date_time tipe, setidaknya salah satu dari date_format atau time_format harus menetapkan nilai yang berbeda dari no_date atau no_time.

Contoh pemformatan tanggalwaktu

Tanggal

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

Integrasi alat-alat hilir

Metadata semantik secara otomatis mengisi alat hilir yang menggunakan tampilan metrik:

  • Dasbor AI/BI: Nama tampilan dan spesifikasi format secara otomatis diisi dalam himpunan data dasbor dan visualisasi untuk meningkatkan keterbacaan dasbor.
  • Genie Spaces: Sinonim secara otomatis diimpor untuk membantu Genie menemukan dan memahami dimensi dan ukuran yang tersedia dengan lebih baik dari tampilan metrik.

Contoh lengkap

Contoh berikut menunjukkan definisi tampilan metrik yang melacak performa penjualan dan menyertakan semua jenis metadata agen. Tampilan metrik menganalisis data pesanan untuk menghitung metrik pendapatan, mengesegmentasi pelanggan berdasarkan nilai pesanan, dan melacak volume pesanan.

Segmen pelanggan didefinisikan sebagai berikut:

  • Perusahaan: Pesanan lebih dari $100.000
  • Pasar menengah: Pesanan antara $10.000 dan $100.000
  • Bisnis kecil dan menengah: Pesanan di bawah $10.000

Metadata mendukung kueri bahasa alami seperti "tunjukkan total penjualan menurut segmen pelanggan" atau "berapa pendapatan rata-rata per pesanan."

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
  • Last updated on