デプロイに対する予測¶
エンドポイント: /deployments/
ユーザーが提供したデータに基づいて特定のデプロイに対する予測を計算します。このエンドポイントは、デプロイ済みのモデルでのみ機能します。
備考
デプロイIDは、デプロイ > 予測 > 予測APIタブのサンプルコード出力(インターフェイスを「APIクライアント」に設定)で確認できます。
リクエストメソッド: POST
リクエストURL: デプロイ済みURL。例: https://your-company.orm.datarobot.com/predApi/v1.0
リクエストパラメーター¶
ヘッダー¶
キー | 説明 | 例 |
---|---|---|
Datarobot-key | マネージドAIクラウドユーザーに必須。文字列型 モデルがデプロイされた後、DataRobot UI(予測 > 予測API)でコードスニペットを表示します。 |
DR-key-12345abcdb-xyz6789 |
認証 | 必須。文字列 次の3つの方法がサポートされます:
|
|
Content-Type | オプション。文字列型 |
|
コンテンツエンコーディング | オプション。文字列型 現在、デフォルトのデータ拡張を含むgzipエンコーディングだけがサポートされています。 |
gzip |
Datarobot-key: このヘッダーはマネージドAIクラウドでのみ必要です。 これは、他の検証済みDataRobotユーザーからユーザーのデータを保護するための対策です。キーはDataRobot APIに対する次のリクエストで取得することもできます。 GET <URL>/api/v2/modelDeployments/<deploymentId>
追加パラメーター¶
キー | 説明 | 例 |
---|---|---|
passthroughColumns | オプション。文字列型 予測応答で公開(またはコピー)するスコアリングデータセットの列を制御します。 リクエストには、1つ以上の列が含まれる場合、および列が含まれない場合があります。(渡すことのできる列名の数に制限はありません。) 列名はUTF-8バイトとして渡し、パーセントエンコードする必要があります(この要件に関するHTTP標準を参照してください)。 列の実際の名前を値として使用してください。 |
/v1.0/deployments/deploymentId/predictions?passthroughColumns=colA&passthroughColumns=colB |
passthroughColumnsSet | オプション。文字列型 予測応答で公開(またはコピー)するスコアリングデータセットの列を制御します。使用できる唯一のオプションは「all」です。このオプションが渡された場合、スコアリングデータベースのすべての列が公開されます。 |
/v1.0/deployments/deploymentId/predictions?passthroughColumnsSet=all |
predictionWarningEnabled | オプション。ブール型 有効にした場合、実世界で通常とは異なる予測や異常な予測がモニターされ、検知された場合にその旨が表示されます。 TRUEに設定した場合、新しいキーが各予測に追加され、信頼性チェックの結果が指定されます。それ以外の場合、予測応答に変化はありません。 |
/v1.0/deployments/deploymentId/predictions?predictionWarningEnabled=true 応答: { "data": [ { "predictionValues": [ { "value": 18.6948852, "label": "y" } ], "isOutlierPrediction": false, "rowId": 0, "prediction": 18.6948852 } ] } |
本文¶
データ | タイプ | 例 |
---|---|---|
予想するデータ |
|
|
Response 200¶
二値予測¶
ラベル: 連続値および二値分類のタスクでは、DataRobot APIはPositiveクラスには1を、Negativeクラスには0を常に返します。 クラスの実測値は提供したデータ("yes"/"no"など)に応じて異なることがありますが、DataRobot APIは常に1/0を返します。 多クラス分類の場合、DataRobot APIは値そのものを返します。
値: イベントが発生する可能性を示します(0と1は、それぞれ最小と最大の可能性を表します)。ユーザーは、値を予測ラベルにリンクするしきい値を調整できます。
PredictionThreshold (二値分類プロジェクトにのみ適用されます): しきい値とは、予測値のクラス境界線を設定する点です。モデルは、しきい値を下回る予測値をFALSEとして分類し、しきい値を上回る予測値をTRUEとして分類します。したがって、DataRobotでは、しきい値を超える予測にPositiveクラスのラベルが自動的に割り当てられます。これは、(デプロイ タブ)UIページを介して、またはDataRobot API(PATCH /api/v2/projects/(projectId)/models/(modelId)
ルートなど)を介して手動で設定できます。
実際の応答は分類タスク(連続値、二値分類、または多クラスタスク)に応じて異なります。
二値分類の例¶
{
"data": [
{
"predictionValues": [
{
"value": 0.2789450715,
"label": 1
},
{
"value": 0.7210549285,
"label": 0
}
],
"predictionThreshold": 0.5,
"prediction": 0,
"rowId": 0
}
]
}
連続値予測の例¶
{
"data": [
{
"predictionValues": [
{
"value": 6754486.5,
"label": "revenue"
}
],
"prediction": 6754486.5,
"rowId": 0
}
]
}
多クラス分類予測の例¶
{
"data": [
{
"predictionValues": [
{
"value": 0.9999997616,
"label": "setosa"
},
{
"value": 2.433e-7,
"label": "versicolor"
},
{
"value": 1.997631915e-16,
"label": "virginica"
}
],
"prediction": "setosa",
"rowId": 0
}
]
}
エラーリスト¶
HTTPコード | サンプルエラーメッセージ | リーズン |
---|---|---|
400 BAD REQUEST | {"message": "Bad request"} |
サポートされていない外部デプロイが追加されました。 |
404 NOT FOUND | {"message": "Deployment :deploymentId cannot be found for user :userId"} |
無効なdeploymentId(削除されたデプロイ)が提供されました。 |