Skip to content

アプリケーション内で をクリックすると、お使いのDataRobotバージョンに関する全プラットフォームドキュメントにアクセスできます。

Webhookイベントのペイロード

イベントが発生すると、Webhookが配信する通知が生成されます。通知チャネルを設定するとき、通知を受信するイベントを選択できます。各イベントは、DataRobot内の一意のアクションに関連しています。すべてのイベントを選択して設定するか、特定のイベントを購読します。

このページでは、DataRobot Webhookで利用可能なイベントペイロード設定について詳しく説明します。各イベントカテゴリーには例が含まれています。

プロジェクトイベント

利用可能なプロジェクトイベントは次の4つです。

アクション ペイロード形式
プロジェクトの作成 project.created
プロジェクトの削除 project.deleted
プロジェクトの共有 project.shared
オートパイロットの完了 autopilot.complete

例: プロジェクト削除イベント

{
    "event": {
        "deleted_by": "123a456b7c8e9f",
        "deletion_time": 1581504952,
        "entity_id": "123a456b7c8e9f",
        "uid": "<User_ID>"
    },
    "event_type": "project.deleted",
    "project": {

        "active": 1,
        "default_dataset_id": "123a456b7c8e9f",
        "original_name": "https://s3.amazonaws.com/datarobot_public_datasets/DR_Demo_Store_Sales_Forecast_Train.xlsx",
        "project_id": "<project_ID>",
        "project_name": "DR_Demo_Store_Sales_Forecast_Train.xlsx",
        "stage": "modeling:"
    },
    "timestamp": 1581504953
}

例: オートコンプリート終了イベント

{
    "event": {
        "dataset_id": "123a456b7c8e9f",
        "entity_id": "123a456b7c8e9f",
        "uid": "<User_ID>"
    },
    "event_type": "autopilot.complete",
    "project": {
        "active": 1,
        "default_dataset_id": "123a456b7c8e9f",
        "original_name": "advanced_options.csv",
        "project_id": "<project_ID>",
        "project_name": "test-tvh-no-holdout-f2c6607d-544d-4e94-a488-c282b6aaa192",
        "stage": "modeling:"
    },
    "timestamp": 1581507975
}

Mongoフィールド:プロジェクトイベント

次の表に、プロジェクトイベントペイロードに含めることができるすべてのフィールドの詳細を示します。

Mongoのフィールド 必須 説明
UID N/A
作成 N/A
アクティブ プロジェクトがアクティブかどうかを示します。
default_dataset_id AIカタログ内のデータセットのオリジンを示します。
holdout_unlocks N/A
originalName DataRobotにアップロードされたときのファイル名が含まれます。
project_name プロジェクト名を識別します。
ステージ アクションが実行されたときのプロジェクトのステージを示します。
is_deleted N/A
dellation_time 削除時間を示します(通知の遅延のトラブルシューティングに役立ちます)。
deleted_by プロジェクトを削除したユーザーを示します。

データセットイベント

データセットイベントには、次の3つのタイプがあります。

アクション ペイロード形式
作成されたデータセット dataset.created
削除されたデータセット dataset.deleted
共有されたデータセット dataset.shared

例: データセット共有イベント

{
    "dataset": {
        "catalog_type": "non_materialized_dataset",
        "dataset_id": "123a456b7c8e9f",
        "latest_catalog_version_id": "123a456b7c8e9f",
        "original_name": "amazon_de_reviews_small_80.csv",
        "version": 1
    },
    "event": {
        "entity_id": "123a456b7c8e9f",
        "shared_uids": [
            "<Shared_user_ID>",
            "<Shared_user_ID>",
            "<Shared_user_ID>"
        ],
        "uid": "<User_ID>"
    },
    "event_type": "dataset.shared",
    "timestamp": 1581508736
}

Mongoフィールド:データセットイベント

次の表に、データセットイベントペイロードに含めることができるすべてのフィールドの詳細を示します。

Mongoのフィールド 必須 説明
UID N/A
created N/A
latest_catalog_version_id 使用されているデータセットのバージョンを示します。
originalName DataRobotにアップロードされたときのファイル名が含まれます。
last_moded N/A
last_modified_uid N/A
catalog_type AIカタログ情報に基づいてプロジェクトタイプを決定します。
version 使用されているデータセットのバージョンを示します。
is_deleted N/A
dellation_time 削除時間を示します(通知の遅延のトラブルシューティングに役立ちます)。
deleted_by プロジェクトを削除したユーザーを示します。

モデルデプロイイベント

利用可能なデプロイイベントは次の10個です。

アクション ペイロード形式
モデルデプロイの共有 model_deployments.deployment_sharing
モデルデプロイの置換 model_deployments.model_replacation
モデルデプロイの作成 model_deployments.deployment_creation
モデルデプロイの削除 model_deployments.deployment_delovation_delo
デプロイサービスの正常性の変化: 緑から黄色 model_deployments.service_health_from_green
デプロイサービスの正常性の変化: 赤 model_deployments.service_health_red
デプロイデータドリフトの変化: 緑から黄色 model_data_dreft_from_green
デプロイデータドリフトの変化: 赤 model_data_drift_red
デプロイ精度の正常性の変化: 緑から黄色 model_deployments.accuracy_from_green
デプロイ精度の正常性の変化: 赤 model_deployments.accuracy_red

例: デプロイ作成イベント

{
    "event": {
        "entity_id": "123a456b7c8e9f",
        "model_id": "123a456b7c8e9f",
        "performer_uid": "<Performer_ID>",
        "status": "active"
    },
    "event_type": "model_deployments.deployment_creation",
    “deployment": {
        "deployment_id": "123a456b7c8e9f",
        "model_id": "123a456b7c8e9f",
        "model_package_id": "123a456b7c8e9f",
        "project_id": "<project_ID>",
        "status": "active",
        "type": "dedicated",
        "user_id": "<User_ID>"
    },
    "timestamp": 1581505115
}

Mongoフィールド:デプロイイベント

次の表に、デプロイイベントペイロードに含めることができるすべてのフィールドの詳細を示します。

Mongoのフィールド 必須 説明
creat_at N/A
deployed N/A
description N/A
expect_target N/A
instance_id N/A
label N/A
model_id N/A
organization_id N/A
project_id N/A
service_id N/A
updated_at N/A
user_id N/A
deleted N/A

更新しました February 22, 2022
Back to top