DESCRIBE MODEL MONITOR

特定の モデルモニター に関する情報を表示します。このコマンドは、 SHOW MODEL MONITORS コマンドで表示されるすべての情報のほかに、追加情報を表示します。

DESCRIBE は DESC に短縮できます。

こちらもご参照ください。

CREATE MODEL MONITORALTER MODEL MONITORSHOW MODEL MONITORSDROP MODEL MONITOR

構文

{ DESCRIBE | DESC } MODEL MONITOR <monitor_name>
Copy

パラメーター

monitor_name

説明するモデルモニターの識別子を指定します。

識別子にスペースまたは特殊文字が含まれる場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

詳細については、 識別子の要件 をご参照ください。

出力

コマンド出力では、モデルモニターのプロパティとメタデータが以下の列で提供されます。

説明

created_on

モデルモニターが作成された日時。

name

モデルモニターの名前。

database_name

モデルモニターが格納されているデータベース。

schema_name

モデルモニターが格納されているスキーマ。

warehouse_name

モデルをモニターするために使用されるウェアハウス。

refresh_interval

モデルモニターのリフレッシュをトリガーするリフレッシュ間隔(ターゲットラグ)。

aggregation_window

メトリックを計算するための集計ウィンドウ。

model_task

モニター対象モデルのタスク。TABULAR_BINARY_CLASSIFICATION または TABULAR_REGRESSION のいずれか。

monitor_state

モデルモニターの状態。

  • ACTIVE: モデルモニターはアクティブで、正しく動作しています。

  • SUSPENDED: モデルのモニタリングを中断します。

  • PARTIALLY_SUSPENDED: 基になるテーブルの1つが期待される間隔でリフレッシュを停止したエラー状態。詳細については、 DESCRIBE をご参照ください。

  • UNKNOWN: 基になるテーブルの状態を識別できないエラー状態。

source

集計の基になる、ソーステーブルまたはビューの詳細を示す JSON オブジェクトの文字列表現。テーブルが存在しないかアクセスできない場合、値は空文字列となります。テーブル JSON オブジェクトの指定 をご参照ください。

baseline

JSON オブジェクトの文字列表現で、モニタリングに使用されるベースラインテーブルの詳細。このオブジェクトのクローンがモデルモニターのオブジェクトに組み込まれています。テーブル JSON オブジェクトの指定 をご参照ください。

model

JSON オブジェクトの文字列表現で、モニター対象のモデル固有の情報を含みます。モデル JSON オブジェクトの指定 をご参照ください。

comment

モデルモニターについてのコメント。

以下の列は、 SHOW との比較で DESCRIBE により表示される追加列です

aggregation_status

各動的テーブル型の集約ステータスを含む JSON オブジェクト。

キー:

  • SOURCE_AGGREGATED / ``ACCURACY_AGGREGATED``(非セグメント)

  • SOURCE_AGGREGATED_<segment_column> / ``ACCURACY_AGGREGATED_<segment_column>``(セグメント固有)

値: ACTIVE または SUSPENDED

aggregation_last_error

各動的テーブル型の最後のエラーを含む JSON オブジェクト。

キー: aggregation_status と同じ

値: エラーメッセージ、または成功した場合は空の文字列

aggregation_last_data_timestamp

各動的テーブル型の最終更新タイムスタンプを含む JSON オブジェクト。

キー: aggregation_status と同じ

値: 最終更新成功時のタイムスタンプ

columns

ソーステーブルで使用される列名を含む JSON オブジェクトの文字列表現。列 JSON オブジェクトの指定 をご参照ください。

テーブル JSON オブジェクトの指定

以下は、コマンド出力の sourcebaseline 列で使用される、テーブルの JSON 表現の形式です。

name

ソースまたはベースラインのテーブルまたはビューの名前。

database_name

テーブルまたはビューが格納されているデータベース。

schema_name

テーブルまたはビューが格納されているスキーマ。

status

テーブルのステータス。

  • ACTIVE: ユーザーがアクセスできるテーブルまたはビュー。

  • MASKED: 現在のユーザーは、テーブルまたはビューにアクセスできません。他のフィールドの値はマスキングされて表示されます(つまり、一連のアスタリスクとして)。

  • DELETED: テーブルまたはビューが削除されました。

  • NOT_SET: ステータスが設定されていません。

モデル JSON オブジェクトの指定

以下は、コマンド出力の model 列で使用される、モデルの JSON 表現の形式です。

フィールド

説明

model_name

モニター対象のモデル名。

version_name

モニター対象のモデルバージョンのバージョン名。

function_name

指定されたモデルバージョンでモニターされている特定の関数の名前。

database_name

モデルが格納されているデータベース。

schema_name

モデルが格納されているスキーマ。

model_status

モデルのステータス。ACTIVE、 MASKED、 DELETED のいずれか。MASKED は、ユーザーがそのモデルにアクセスできないことを示します。他のフィールドはアスタリスクで表示されます。

version_status

モデルバージョンのステータス。ACTIVE または DELETED。(MASKED はアクセス制御ができないため、モデルバージョンとしては有効なステータスではありません。)

列 JSON オブジェクトの指定

以下は、コマンド出力の columns 列で使用される、列の JSON 表現の形式です。

フィールド

説明

timestamp_column

データソースのタイムスタンプ列の名前。

id_columns

合わせてソースデータの各行を一意に識別する文字列名の配列。

prediction_class_columns

データソース内にあるすべての予測クラス列の名前を指定する文字列の配列。

prediction_score_columns

データソース内にあるすべての予測スコア列の名前を指定する文字列の配列。

actual_class_columns

データソース内にあるすべての実際クラス列の名前を指定する文字列の配列。

numerical_columns

モデルモニターがソーステーブルから使用する、すべての数値特徴量列の名前を指定する文字列の配列。

string_columns

モデルモニターがソーステーブルから使用する、すべての文字列(カテゴリ)特徴量列を指定する文字列の配列。

boolean_columns

モデルモニターがソーステーブルから使用する、すべてのブール(カテゴリ)特徴量列を指定する文字列の配列。

segment_columns

データソース内にあるすべてのセグメント列の名前を指定する文字列の配列。セグメントなしで作成された既存のモデルモニターの場合、このフィールドは空の配列になります。

アクセス制御の要件

この操作の実行に使用される ロール には、少なくとも次の 権限 が必要です。

権限

オブジェクト

注意

指定なし

モデルモニター

スキーマ内のオブジェクトに対して操作を実行するには、親データベースとスキーマに対する USAGE 権限が必要です。スキーマに対する任意の権限を付与されたロールは、そのロールがスキーマを解決できることに注意してください。たとえば、スキーマに対する CREATE 権限を付与されたロールは、そのスキーマにオブジェクトを作成できますが、そのスキーマに対する USAGE*も*付与されている必要はありません。

指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。

セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。

使用上の注意

  • このコマンドの出力を後処理するには、 パイプ演算子->>)または RESULT_SCAN 関数。どちらのコンストラクトも、出力を クエリできる結果セットとして扱います。

    For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

    When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

    You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.