デプロイに対する予測

キャンセル
次の結果を表示 
次の代わりに検索 
もしかして: 

デプロイに対する予測

最新の情報は、製品マニュアルをご確認ください。閲覧するには、DataRobotにログインする必要があります。

(この記事の最終更新日:2020年4月7日)

DR_reference.png

 

エンドポイント:/deployments/<deploymentId>/predictions
このエンドポイントは、ユーザーが提供したデータに基づいて特定のデプロイの予測が計算されます。このエンドポイントは、デプロイ済みのモデルでのみ機能します。

リクエストモデル: POST

リクエストURL: デプロイ済みURL。例: https://your-company.orm.datarobot.com/predApi/v1.0

リクエストパラメーター  ヘッダー 

キー

説明

Datarobot-key

Managed AI Cloudユーザーに必須。ストリングタイプ


モデルがデプロイされたら、DataRobot UIのコードスニペット、 デプロイ>統合を表示します。

DR-key-12345abcdb-xyz6789

Authorization

必須。文字列


次の2つの方法がサポートされます:

  • User_emailおよびAPIトークン
  • APIトークン
  • User_emailおよびAPIトークンメソッドの例:
    Basic Auth_basic-12345abcdb-xyz6789
  • APIトークンメソッドの例:
    Token API_key-12345abcdb-xyz6789

Content-Type

オプション。文字列型

  • textplain; charset=UTF-8
  • text/csv
  • application/JSON
  • multipart/form-data(データを含むファイル。.csvや.txtファイルなど)

Content-Encoding

オプション。文字列型


現在、デフォルトのデータ拡張を含むgzipエンコーディングだけがサポートされています。

gzip

Datarobot-key: このヘッダーはManaged AI Cloudでのみ必要です。これは、他の検証済み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に設定した場合、新しいキーが各予測に追加され、Humble AIチェックの結果が指定されます。それ以外の場合、予測応答に変化はありません。

/v1.0/deployments/deploymentId/predictions?predictionWarningEnabled=true


応答:


{ "data": [ { "predictionValues": [ { "value": 18.6948852, "label": "y" } ], "isOutlierPrediction": false, "rowId": 0, "prediction": 18.6948852 } ] }

 
 
本文

データ

タイプ

予測するデータ

  • 元のテキスト
  • 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クラスのラベルが自動的に割り当てられます。これは、(「API」タブ)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(削除されたデプロイ)が提供されました。

422 UNPROCESSABLE ENTITY

{"message": "'predictionWarningEnabled': value can't be converted to Bool"}

predictionWarningEnabledパラメーターに無効な(非ブール型)値が提供されました。

 

ラベル(1)
バージョン履歴
最終更新:
‎04-29-2020 01:08 AM
更新者: