Skip to content

アプリケーション内で をクリックすると、お使いのDataRobotバージョンに関する全プラットフォームドキュメントにアクセスできます。

デプロイしたモデルによる予測

以下のエンドポイントを使用すると、特定のデプロイで予測値を計算するために必要なデータを提供できます。 非構造化カスタム推論モデルで予測を行う必要がある場合は、非構造化モデルデプロイでの予測を参照してください。

エンドポイント: /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つの方法がサポートされます。
  • Bearer認証
  • (使用非推奨)基本認証:User_emailおよびAPIトークン
  • (使用非推奨)APIトークン
  • Bearer認証方法の例:Bearer API_key-12345abcdb-xyz6789
  • (使用非推奨)User_emailおよびAPIトークン方法の例:Basic Auth_basic-12345abcdb-xyz6789
  • (使用非推奨)APIトークン方法の例:Token API_key-12345abcdb-xyz6789
Content-Type オプション。文字列型
  • text/plain; charset=UTF-8
  • text/csv
  • application/json
  • multipart/form-data (データを含むファイル、つまり.csv、.txtファイルの場合)
Content-Encoding オプション。文字列型

現在、デフォルトのデータ拡張を含むgzipエンコーディングだけがサポートされています。
gzip
Accept オプション。文字列型

応答スキーマの形状を制御します。 現在、JSON(デフォルト)とCSVがサポートされています。 例を参照してください。
  • application/json(デフォルト)
  • text/csv(CSV出力用)

Datarobot-key:このヘッダーはマネージドAIプラットフォームでのみ必須です。 これは、他の検証済みDataRobotユーザーからユーザーのデータを保護するための対策です。 キーはDataRobot APIに対する次のリクエストで取得することもできます。
GET <URL>/api/v2/modelDeployments/<deploymentId>

引数のクエリ

キー タイプ 説明
passthroughColumns 文字列のリスト (Optional) Controls which columns from a scoring dataset to expose (or copy over) in a prediction response.

リクエストには、1つ以上の列が含まれる場合、および列が含まれない場合があります。 (パスできる列名の数に制限はありません。 列の正確な名前を値として使用してください。
/v1.0/deployments/<deploymentId>/predictions?passthroughColumns=colA&passthroughColumns=colB
passthroughColumnsSet 文字列 (Optional) Controls which columns from a scoring dataset to expose (or to copy over) in a prediction response. 使用できる唯一のオプションはallです。このオプションが渡された場合、スコアリングデータベースのすべての列が返却されます。 /v1.0/deployments/deploymentId/predictions?passthroughColumnsSet=all
predictionWarningEnabled ブール (Optional) DataRobot monitors unusual or anomalous predictions in real-time and indicates when they are detected.

この引数がtrueに設定されている場合、信頼性チェックの結果を指定するために、新しいキーが各予測に追加されます。 それ以外の場合、予測応答に変化はありません。
/v1.0/deployments/deploymentId/predictions?predictionWarningEnabled=true

応答:

{ "data": [ { "predictionValues": [ { "value": 18.6948852, "label": "y" } ], "isOutlierPrediction": false, "rowId": 0, "prediction": 18.6948852 } ] }
decimalsNumber 整数 (Optional) Configures the float precision in prediction results by setting the number of digits after the decimal point.

ゼロを追加するのではなく、小数点以下の桁がない場合、浮動小数のプレシジョンはdecimalsNumberで設定された値よりも低くなります。
?decimalsNumber=15

備考

passthroughColumnsおよびpassthroughColumnsSetパラメーターは相互に排他的であり、両方を同じリクエストで渡すことはできません。 passthroughColumnsまた、クエリーパラメーターで渡すことのできる列名の数に制限はありませんが、HTTPリクエストラインの制限があります(現在の制限は8192バイト)。

本文

データ タイプ
予想するデータ
  • 元のテキスト
  • form-data
  • PassengerId,Pclass,Name,Sex,Age,SibSp,Parch,Ticket,Fare,Cabin,Embarked 892,3,"Kelly, Mr. James",male,34.5,0,0,330911,7.8292,,Q 893,3,"Wilkes, Mrs. James (Ellen Needs)",female,47,1,0,363272,7,,S 894,2,"Myles, Mr. Thomas Francis",male,62,0,0,240276,9.6875,,Q
  • キー:ファイル、値:file_with_data_to_predict.csv

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(削除されたデプロイ)が提供されました。

更新しました February 20, 2024
Back to top