デプロイの予測の説明

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

デプロイの予測の説明

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

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

DR_reference.png

エンドポイント:/deployments/<deploymentId>/predictionExplanations

デプロイの予測を作成し、説明を提供します。このエンドポイントを使用するには、特徴量のインパクトの計算に加えて、予測に対する特徴量の効果の質的な指標を提供する予測の説明の初期化が完了している必要があります。(予測の説明は、モデルで特定の予測が作成された理由を識別します。)

注)多クラス、異常検知、および時系列プロジェクトでは、予測の説明を生成できません。説明の操作に関する注意事項については、ここを参照してください。

リクエストモデル: 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つの方法がサポートされます:

  • Useremail + /apitoken呼び出しからのAPIトークン(ユーザー入力ではありません)
  • /api_token呼び出しによって生成されたトークンを提供します。
  • /api_tokenの例:Basic Auth_basic-12345abcdb-xyz6789
  • トークン方法の例: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>

追加パラメーター 

キー

説明

maxCodes

サーバーによって返される説明の数を


制限します。

?maxCodes=5

thresholdHigh

オプション。数値型


予測の説明の高いしきい値。PredictionExplanations(予測の説明)を計算するには、予測はこの値以上(またはthresholdLowの値以下)である必要があります。

?thresholdHigh=0.805

thresholdLow

オプション。数値型


予測の説明の低いしきい値。PredictionExplanations(予測の説明)を計算するには、予測はこの値以下(またはthresholdHighの値以上)である必要があります。

?thresholdLow=0.1396484375

excludeAdjustedPredictions



TRUE(デフォルト)の場合、予測はPredictionExplanationsSample応答に含まれます。

?excludeAdjustedPredictions=false

passthroughColumns

予測応答で公開(またはコピー)するスコアリングデータセットの列を制御します。




リクエストには、1つ以上の列が含まれる場合、および列が含まれない場合があります。(渡すことのできる列名の数に制限はありません。)列名はUTF-8バイトとして渡し、パーセントエンコードする必要があります(この要件に関するHTTP標準を参照してください)。列の実際の名前を値として使用してください。

/v1.0/deployments/:deploymentId/predictionExplanations?passthroughColumns=colA&passthroughColumns=colB

passthroughColumnsSet

予測応答で公開(またはコピー)するスコアリングデータセットの列を制御します。


使用できる唯一のオプションは「all」です。このオプションが渡された場合、スコアリングデータベースのすべての列が公開されます。

/v1.0/deployments/:deploymentId/predictionExplanations?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 

「qualitativeStrength」は、特徴量のインパクトの計算に基づいて現在の予測を作成したときに特徴量の有用性の度合をしめします。(詳細については、ここを参照してください。)


「qualitativeStrength」インジケーター 

インジケータ...

意味...

+++

絶対スコアが0.75以上で、特徴量にPositiveインパクトがあります。

---

絶対スコアが0.75以上で、特徴量にNegativeインパクトがあります。

++

絶対スコアは(0.25, 0.75)の間で、特徴量にPositiveインパクトがあります。

--

絶対スコアは(0.25, 0.75)の間で、特徴量にNegativeインパクトがあります。

+

絶対スコアは(0.001, 0.25)の間で、特徴量にPositiveインパクトがあります。

-

絶対スコアは(0.001, 0.25)の間で、特徴量にNegativeインパクトがあります。

<+

絶対スコアは(0, 0.001)の間で、特徴量にPositiveインパクトがあります。

<-

絶対スコアは(0, 0.001)の間で、特徴量にNegativeインパクトがあります。


二値予測の例

{
    "data": [
        {
            "predictionValues": [
                {
                    "value": 0.07836511,
                    "label": 1
                },
                {
                    "value": 0.92163489,
                    "label": 0
                }
            ],
            "predictionThreshold": 0.5,
            "prediction": 0,
            "rowId": 0,
            "predictionExplanations": [
                {
                    "featureValue": "male",
                    "strength": -0.6706725349,
                    "feature": "Sex",
                    "qualitativeStrength": "---",
                    "label": 1
                },
                {
                    "featureValue": 62,
                    "strength": -0.6325465255,
                    "feature": "Age",
                    "qualitativeStrength": "---",
                    "label": 1
                },
                {
                    "featureValue": 9.6875,
                    "strength": -0.353000328,
                    "feature": "Fare",
                    "qualitativeStrength": "--",
                    "label": 1
                }
            ]
        }
    ]
}

 

エラーリスト 

HTTPコード

サンプルエラーメッセージ

リーズン

404 NOT FOUND

{"message": "Not found"}

無効なdeploymentId(削除されたデプロイ)が提供されました。

404 NOT FOUND

{"message": "Bad request"}

deploymentIdの形式が正しくありません。

422 UNPROCESSABLE ENTITY

{"message": "{'max_codes': DataError(value can't be converted to int)}"}

サポートされていないデータ型で「maxCodes」パラメーターが提供されました(非整数値)。

422 UNPROCESSABLE ENTITY

{"message": "{'threshold_high': DataError(value can't be converted to float)}"}

サポートされていないデータ型で「thresholdhigh」パラメーターが提供されました(非整数値)。

422 UNPROCESSABLE ENTITY

{"message": "{'threshold_low': DataError(value can't be converted to float)}"}

サポートされていないデータ型で「thresholdlow」パラメーターが提供されました(非整数値)。

422 UNPROCESSABLE ENTITY

{"message": "Multiclass models cannot be used for Prediction Explanations"}

このプロジェクトでサポートされていない多クラス分類問題のデータセットが提供されました。

422 UNPROCESSABLE ENTITY

{"message": "This endpoint does not support predictions on time series models. Please use the timeSeriesPredictions route instead."}

このプロジェクトでサポートされていない時系列プロジェクトのデプロイが提供されました。

422 UNPROCESSABLE ENTITY

{"message": "{'exclude_adjusted_predictions': DataError(value can't be converted to Bool)}"}

空の値または非ブール値が'excludeAdjustedPredictions'パラメーターで送信されました。

422 UNPROCESSABLE ENTITY

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

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



バージョン履歴
最終更新:
‎04-27-2020 06:45 PM
更新者: