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
有効 プロジェクトがアクティブかどうかを示します。
デフォルト_データセット_ID AIカタログ内のデータセットが元あった場所を示します。
ホールドアウト_ロック解除済み N/A
originalName DataRobotにアップロードされたときのファイル名が含まれます。
プロジェクト_名 プロジェクト名を識別します。
ステージ アクションが実行されたときのプロジェクトのステージを示します。
is_削除 N/A
削除_時間 削除時間を示します(通知の遅延のトラブルシューティングに役立ちます)。
_削除したユーザー プロジェクトを削除したユーザーを示します。

データセットイベント

データセットイベントには、次の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
作成 N/A
最新_カタログ_バージョン_ID 使用されているデータセットのバージョンを示します。
originalName DataRobotにアップロードされたときのファイル名が含まれます。
最終_変更 N/A
最終_変更_UID N/A
カタログ_タイプ AIカタログの情報に基づいてプロジェクトタイプを決定します。
バージョン 使用されているデータセットのバージョンを示します。
is_削除 N/A
削除_時間 削除時間を示します(通知の遅延のトラブルシューティングに役立ちます)。
_削除したユーザー プロジェクトを削除したユーザーを示します。

モデルデプロイイベント

デプロイイベントには、次の10のタイプがあります。

アクション ペイロード形式
モデルデプロイの共有 モデル_deployments.deployment_共有
モデルデプロイの置換 モデル_deployments.model_置換
モデルデプロイの作成 モデル_deployments.deployment_作成
モデルデプロイの削除 モデル_deployments.deployment_削除
デプロイのサービス正常性の変化: 緑から黄色 モデル_deployments.service_ヘルス_黄_から_緑色
デプロイのサービス正常性の変化: 赤 モデル_deployments.service_ヘルス_赤
デプロイのデータドリフトの変化: 緑から黄色 モデル_deployments.data_ドリフト_黄_から_緑色
デプロイのデータドリフトの変化: 赤 モデル_deployments.data_ドリフト_赤
デプロイの精度の正常性の変化: 緑から黄色 モデル_deployments.accuracy_黄_から_緑色
デプロイの精度の正常性の変化: 赤 モデル_deployments.accuracy_赤

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

{
    "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のフィールド 必須 説明
作成時刻_ N/A
デプロイ済み N/A
説明 N/A
エクスポート_ターゲット N/A
インスタンス_ID N/A
ラベル N/A
モデル_ID N/A
組織_ID N/A
プロジェクト_ID N/A
サービス_ID N/A
更新時間_ N/A
ユーザー_ID N/A
削除済み N/A

更新しました December 21, 2022
Back to top