バッチ予測ジョブの定義¶
作業中のバッチ予測ジョブを送信するには、必要な予測のタイプに基づいてPOST
リクエストペイロードにさまざまな要素を入力する必要があります。 さらに、特定のジョブに使用される入力および出力アダプターのタイプを考慮する必要があります。
バッチ予測REST APIルートの詳細については、 DataRobot REST APIリファレンスドキュメントをご覧ください。
バッチ予測を行うたびに、予測情報はDataRobotの外部に保存され、予測リクエストごとに再送信されます。詳しくは、 サンプルユースケースのセクションを参照してください。 そのようなリクエストの1つとして、次のようなものがあります。
POST https://app.datarobot.com/api/v2/batchPredictions
{
"deploymentId": "<deployment_id>",
"intakeSettings": {
"type": "dataset",
"datasetId": "<dataset_ud>"
},
"outputSettings": {
"type": "jdbc",
"statementType": "insert",
"credentialId": "<credential_id>",
"dataStoreId": "<data_store_id>",
"schema": "public",
"table": "example_table",
"createTableIfNotExists": false
},
"includeProbabilities": true,
"includePredictionStatus": true,
"passthroughColumnsSet": "all"
}
ジョブ定義API¶
ユースケースで同じ、またはほぼ同じタイプの予測を複数回実行する必要がある場合、バッチ予測ジョブのジョブ定義を作成し、将来的な使用に向けてそれをDataRobot内に保存しておくことができます。
ジョブ定義のAPIは既存の/batchPredictions/
エンドポイントと同じであり、POST
エンドポイントを/batchPredictionJobDefinitions
に変更することで互換的に使用できます。
POST https://app.datarobot.com/api/v2/batchPredictionJobDefinitions
{
"deploymentId": "<deployment_id>",
"intakeSettings": {
"type": "dataset",
"datasetId": "<dataset_ud>"
},
"outputSettings": {
"type": "jdbc",
"statementType": "insert",
"credentialId": "<credential_id>",
"dataStoreId": "<data_store_id>",
"schema": "public",
"table": "example_table",
"createTableIfNotExists": false
},
"includeProbabilities": true,
"includePredictionStatus": true,
"passthroughColumnsSet": "all"
}
この定義エンドポイントは、DataRobotに定義が正常に保存されたことを確認する、受け入れられたペイロードを返します。
(オプション)name
パラメーターを入力して識別を容易にすることができます。 入力しなければ、DataRobotが代わりに作成します。
注意
name
パラメーターは組織全体で一意である必要があります。 同じ名前で複数の定義を作成しようとすると、リクエストは失敗します。 名前を解放する場合、削除する既存のジョブ定義IDを持つDELETE
リクエストを最初に送信する必要があります。
ジョブ定義を実行する¶
スコアリングのために保存されたジョブ定義を送信する場合、 こちらに示すようにスケジュールに基づいて送信するか、次のようにして、ペイロードとしての定義IDを持つエンドポイント/batchPredictions/fromJobDefinition
へ定義IDを手動で送信することができます。
POST https://app.datarobot.com/api/v2/batchPredictions/fromJobDefinition
{
"jobDefinitionId": "<job_definition_id>"
}
エンドポイントは通常のCRUD操作、GET
、POST
、DELETE
およびPATCH
をサポートします。