デプロイしたモデルによる予測¶
以下のエンドポイントを使用すると、特定のデプロイで予測値を計算するために必要なデータを提供できます。 非構造化カスタム推論モデルで予測を行う必要がある場合は、非構造化モデルデプロイでの予測を参照してください。
エンドポイント: /deployments/<deploymentId>/predictions
このエンドポイントは、ユーザーが提供したデータに基づいて特定のデプロイの予測が計算されます。 このエンドポイントは、デプロイ済みのモデルでのみ機能します。
備考
デプロイIDは、デプロイ > 予測 > 予測APIタブのサンプルコード出力(インターフェイスを「APIクライアント」に設定)で確認できます。
リクエストメソッド: POST
リクエストURL:デプロイ済みURL、例:https://your-company.orm.datarobot.com/predApi/v1.0
リクエストパラメーター¶
ヘッダー¶
キー | 説明 | 例 |
---|---|---|
Datarobot-key | 予測サーバーの追加認証要素として使用される、組織ごとのシークレット。 /api/v2/predictionServers/ エンドポイントにアクセスして、datarobot-key をプログラムで取得する。 エンドポイントは、予測サーバーのURLと対応するdatarobot-key を返します。 マネージドAIプラットフォームユーザーに必須です。文字列タイプ モデルがデプロイされたら、予測 > 予測APIで、DataRobot UIのコードスニペットを参照してください。 |
DR-key-12345abcdb-xyz6789 |
Authorization | 必須。文字列 次の3つの方法がサポートされます。
|
|
Content-Type | オプション。文字列型 |
|
Content-Encoding | オプション。文字列型 現在、デフォルトのデータ拡張を含むgzipエンコーディングだけがサポートされています。 |
gzip |
Accept | オプション。文字列型 応答スキーマの形状を制御します。 現在、JSON(デフォルト)とCSVがサポートされています。 例を参照してください。 |
|
Datarobot-key:このヘッダーはマネージドAIプラットフォームでのみ必須です。 これは、他の検証済みDataRobotユーザーからユーザーのデータを保護するための対策です。 キーはDataRobot APIに対する次のリクエストで取得することもできます。GET <URL>/api/v2/modelDeployments/<deploymentId>
引数のクエリ¶
キー | タイプ | 説明 | 例 |
---|---|---|---|
passthroughColumns | 文字列のリスト | (オプション)予測応答で公開(またはコピー)するスコアリングデータセットの列を制御します。 リクエストには、1つ以上の列が含まれる場合、および列が含まれない場合があります。 (パスできる列名の数に制限はありません。 列の正確な名前を値として使用してください。 |
/v1.0/deployments/<deploymentId>/predictions?passthroughColumns=colA&passthroughColumns=colB |
passthroughColumnsSet | 文字列 | (オプション)予想応答で公開(またはコピー)するスコアリングデータセットの列を制御します。 使用できる唯一のオプションはall です。このオプションが渡された場合、スコアリングデータベースのすべての列が返却されます。 |
/v1.0/deployments/deploymentId/predictions?passthroughColumnsSet=all |
predictionWarningEnabled | ブール | (オプション)DataRobotは、異常または異常な予測をリアルタイムで監視し、それらがいつ検出されたかを示します。 この引数がtrueに設定されている場合、信頼性チェックの結果を指定するために、新しいキーが各予測に追加されます。 それ以外の場合、予測応答に変化はありません。 |
/v1.0/deployments/deploymentId/predictions?predictionWarningEnabled=true Response: { "data": [ { "predictionValues": [ { "value": 18.6948852, "label": "y" } ], "isOutlierPrediction": false, "rowId": 0, "prediction": 18.6948852 } ] } |
decimalsNumber | 整数 | (オプション)小数点以下の桁数を設定して、予測結果の浮動小数点のプレシジョンを設定します。 ゼロを追加するのではなく、小数点以下の桁がない場合、浮動小数のプレシジョンは decimalsNumber で設定された値よりも低くなります。 |
?decimalsNumber=15 |
備考
passthroughColumns
およびpassthroughColumnsSet
パラメーターは相互に排他的であり、両方を同じリクエストで渡すことはできません。 passthroughColumns
また、クエリーパラメーターで渡すことのできる列名の数に制限はありませんが、HTTPリクエストラインの制限があります(現在の制限は8192バイト)。
本文¶
データ | タイプ | 例 |
---|---|---|
予想するデータ |
|
|
Response 200¶
二値予測¶
ラベル:連続値タスクおよび二値分類タスクの場合、DataRobot APIは、Positiveクラスに1を返し、Negativeクラスに0を返します。 クラスの実測値は提供したデータ("yes"/"no"など)に応じて異なることがありますが、DataRobot APIは常に1/0を返します。多クラス分類の場合、DataRobot APIは値そのものを返します。
値:イベントが発生する可能性を示します(0と1は、それぞれ最小と最大の可能性を表します)。 ユーザーは、値を予測ラベルにリンクするしきい値を調整できます。
予測に対して使用されるしきい値(二値分類プロジェクトのみ)。しきい値とは、予測値のクラス境界線を設定する点です。 モデルは、しきい値を下回る観測値を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(削除されたデプロイ)が提供されました。 |