使用非推奨のAPIルート¶
予測APIは時間の経過とともに大幅に変更され、多くの古いルートが蓄積されています。 これらのルートはすでに廃止されていますが、まだ新しいバージョンに移行していないユーザーもいるので、一部のインストールでは引き続き使用できます。
このページでは以下の内容について説明します。
- 廃止されたすべてのルート
- 完全な削除までの期限
- 古いエンドポイントの代わりに使用する必要がある新しいRESTエンドポイント
- 予測管理者がDataRobotを安全にアップグレードするために、組織内の廃止されたルートの使用状況をキャプチャする方法
特定の各ルートの詳細については、予測APIリファレンスドキュメントを参照してください。
廃止された予測APIルート¶
予測APIは、「プロジェクト/モデル」ルートから「デプロイ対応」ルートに移動しました。 この移行をサポートするために、次のルートが廃止されました。
注意
廃止されたルート（デプロイ対応モデルを使用していないもの）の可用性は、DataRobotの初期デプロイバージョンによって異なります。 詳細については、下の表を参照してください。 新しいAPIルートの移行に関するサポートが必要な場合は、DataRobotの担当者にお問い合わせください。
| デプロイのタイプ | インストールのタイムライン | ステータスとメモ |
|---|---|---|
| セルフマネージドAIプラットフォーム | v6.0以降の新機能 | 無効 |
| セルフマネージドAIプラットフォーム | v6.0またはv.6.1へのアップグレード | サポートされています |
| セルフマネージドAIプラットフォーム | v6.2アップグレード | 廃止されたすべてのルートがすべて削除されます |
| AIプラットフォーム | 個別に移行されます。 | 移行中です |
* 2020年5月以降の新規セルフマネージドAIプラットフォームアカウントからは新しいルートにのみアクセスできます。
廃止されたルートの完全なリスト¶
AutoML予測の作成¶
廃止されたルート： POST /predApi/v1.0/<projectId>/<modelId>/predict
新しいルート： POST /predApi/v1.0/deployments/<deploymentId>/predictions
時系列予測の作成¶
廃止されたルート：
POST /predApi/v1.0/<projectId>/<modelId>/timeSeriesPredict
POST /predApi/v1.0/deployments/<deploymentId>/timeSeriesPredictions
新しいルート： POST /predApi/v1.0/deployments/<deploymentId>/predictions
予測の説明¶
廃止されたルート：
POST /predApi/v1.0/<projectId>/<modelId>/reasonCodesPredictions
POST /predApi/v1.0/<projectId>/<modelId>/predictionExplanations
POST /predApi/v1.0/deployments/<deploymentId>/predictionExplanations
新しいルート： POST /predApi/v1.0/deployments/<deploymentId>/predictions
Ping¶
廃止されたルート： GET /api/v1/ping
新しいルート： GET /predApi/v1.0/ping
モデルの一覧¶
廃止されたルート： GET /api/v1/<projectId>/models
新しいルート：
パブリックV2 APIを使用してプロジェクト内のモデルのリストを取得
トークンの使用¶
廃止されたルート：
GET /api/v1/api_token
POST /api/v1/api_token
GET /predApi/v1.0/api_token
新しいルート：
APIトークンはAPIキーで置き換えられ、パブリックV2 APIによってのみ管理されます。 プラットフォームのドキュメントまたはパブリックV2 APIドキュメントの「アカウント」>「開発者ツール」セクションを参照してください。
レガシー予測APIルートのリクエスト例¶
このセクションでは、モデルのプロジェクトおよびモデルIDを指定することによって、廃止予定のレガシー予測APIルートをモデルで直接使用して予測を作成する方法を示す例を紹介します。
リリースステータスに基づく廃止タイムラインについては、上の表を参照してください。
分類および連続値プロジェクトの予測の生成:
curl -i -X POST "https://example.datarobot.com/predApi/v1.0/<projectId>/<modelId>/predict" \
-H "Authorization: Bearer <API key>" -F \
file=@~/.home/path/to/dataset.csv
時系列プロジェクトの予測の生成:
curl -i -X POST "https://example.datarobot.com/predApi/v1.0/<projectId>/<modelId>/timeSeriesPredict" \
-H "Authorization: Bearer <API key>" -F \
file=@~/.home/path/to/dataset.csv
予測の説明の生成:
curl -i -X POST "https://example.datarobot.com/predApi/v1.0/<projectId>/<modelId>/predictionExplanations" \
-H "Authorization: Bearer <API key>" -F \
file=@~/.home/path/to/dataset.csv
セルフマネージドAIプラットフォームを使用している場合、datarobot-keyをURL ヘッダーに含めます。-H "datarobot-key: xxxx.
廃止されたルートの使用状況の追跡¶
本機能の提供について
この機能は、マネージドAIプラットフォームユーザーは使用できません。 移行の処理に関する情報については、DataRobotの担当者にお問い合わせください。
備考
この特徴量は、v6.1でのみ使用できます。 v6.2では、この機能は廃止されたすべてのルートとともに削除されます。
予測管理者は、使用非推奨のすべてのルートの使用状況を1つのページから追跡できます。 この機能は、有効な「予測管理を有効化」権限を持つユーザーのみが利用できます。
予測管理者は、「予測の管理」ページから、この機能にアクセスできます。
廃止されたルートの統計にアクセスするには、右上隅のボタンをクリックします。
統計の表は次のようになります。
テーブルには以下の列があります。
- 最後の使用：このリクエストが最後に行われた時間（UTC）
- リクエスト：作成されたHTTPリクエスト。 クエリーパラメーターを含みます（存在する場合）
- ユーザー名：このリクエストを行ったDRユーザーの名前
- 総使用回数：v6.1以降にリクエストが行われた合計回数。
備考：
- テーブルは「最後の使用」を基準に降順にソートされるので、最新のリクエストが一番上に表示されます。
- 同じリクエストを行った2人の異なるユーザーは個別にカウントされます。
- 表示される最近のリクエストの数は100に制限されています。
- この表は、廃止されたルートへのリクエストのみを示しています。 新しいルートを使用したリクエストは表示されません。