Webhookイベントのペイロード¶
イベントが発生すると、Webhookが配信する通知が生成されます。 通知チャネルを設定するとき、通知を受信するイベントを選択できます。 各イベントは、DataRobot内の一意のアクションに関連しています。 すべてのイベントを選択して設定するか、特定のイベントをサブスクライブします。
このページでは、DataRobotのWebhookで可能なイベントペイロードの設定について説明します。 各イベントカテゴリーには例が含まれています。
Before proceeding, review the considerations.
プロジェクトイベント¶
プロジェクトイベントには、次の4つのタイプがあります。
アクション | ペイロード形式 |
---|---|
プロジェクトの作成 | project.created |
プロジェクトの削除 | project.deleted |
プロジェクトの共有 | project.shared |
オートパイロットの完了 | autopilot.complete |
例: プロジェクト削除イベント¶
``` json { "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 } ```
例: オートコンプリート終了イベント¶
``` json { "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 | |
created | N/A | |
active | ✔ | プロジェクトがアクティブかどうかを示します。 |
default_dataset_id | ✔ | AIカタログ内のデータセットが元あった場所を示します。 |
holdout_unlocked | N/A | |
originalName | ✔ | DataRobotにアップロードされたときのファイル名が含まれます。 |
project_name | ✔ | プロジェクト名を識別します。 |
stage | ✔ | アクションが実行されたときのプロジェクトのステージを示します。 |
is_deleted | N/A | |
deletion_time | ✔ | 削除時間を示します(通知の遅延のトラブルシューティングに役立ちます)。 |
deleted_by | ✔ | プロジェクトを削除したユーザーを示します。 |
データセットイベント¶
データセットイベントには、次の3つのタイプがあります。
アクション | ペイロード形式 |
---|---|
データセットの作成 | dataset.created |
データセットの削除 | dataset.deleted |
データセットの共有 | dataset.shared |
例: データセット共有イベント¶
``` json { "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_modified | N/A | |
last_modified_uid | N/A | |
catalog_type | ✔ | AIカタログの情報に基づいてプロジェクトタイプを決定します。 |
version | ✔ | 使用されているデータセットのバージョンを示します。 |
is_deleted | N/A | |
deletion_time | ✔ | 削除時間を示します(通知の遅延のトラブルシューティングに役立ちます)。 |
deleted_by | ✔ | プロジェクトを削除したユーザーを示します。 |
モデルデプロイイベント¶
デプロイイベントには、次の10のタイプがあります。
アクション | ペイロード形式 |
---|---|
モデルデプロイの共有 | model_deployments.deployment_sharing |
モデルデプロイの置換 | model_deployments.model_replacement |
モデルデプロイの作成 | model_deployments.deployment_creation |
モデルデプロイの削除 | model_deployments.deployment_deletion |
デプロイのサービス正常性の変化: 緑から黄色 | model_deployments.service_health_yellow_from_green |
デプロイのサービス正常性の変化: 赤 | model_deployments.service_health_red |
デプロイのデータドリフトの変化: 緑から黄色 | model_deployments.data_drift_yellow_from_green |
デプロイのデータドリフトの変化: 赤 | model_deployments.data_drift_red |
デプロイの精度の正常性の変化: 緑から黄色 | model_deployments.accuracy_yellow_from_green |
デプロイの精度の正常性の変化: 赤 | model_deployments.accuracy_red |
例: デプロイ作成イベント¶
``` json { "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のフィールド | 必須 | 説明 |
---|---|---|
created_at | N/A | |
deployed | N/A | |
description | N/A | |
export_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 |
更新しました 2025年3月14日
このページは役に立ちましたか?
ありがとうございます。どのような点が役に立ちましたか?
より良いコンテンツを提供するには、どうすればよいでしょうか?
アンケートにご協力いただき、ありがとうございました。