非構造化モデルデプロイでの予測¶
以下のエンドポイントを使用すると、特定の非構造化モデルデプロイで予測値を計算するために必要なデータを提供できます。 標準モデルで予測を行う必要がある場合は、デプロイでの予測を参照してください。
エンドポイント: /deployments/<deploymentId>/predictionsUnstructured
特定の非構造化モデルのデプロイで、ユーザー提供のデータに基づいて予測値を計算します。 このエンドポイントは、非構造化ターゲットタイプでデプロイされたカスタム推論モデルに対してのみ機能します。 詳しくは、非構造化カスタムモデルの構築をご覧ください。
このエンドポイントは次のことを行います。
-
ターゲットのカスタム推論モデルで
/predictUnstructuredルートを呼び出し、標準のDataRobot予測APIインターフェイスを逸脱する可能性があるカスタム要求および応答スキーマを使用できるようにします。 -
ペイロードとコンテンツタイプ(指定されていればMIMEタイプと文字セット)をモデルに渡します。
-
モデルから返されたペイロードを、コンテンツタイプ(指定されていればMIMEタイプと文字セット)とともに、呼び出し元に渡します。
DRUMライブラリでは、この呼び出しはscore_unstructured()フックによって処理されます。
備考
デプロイIDは、デプロイ > 予測 > 予測APIタブのサンプルコード出力(インターフェイスを「APIクライアント」に設定)で確認できます。
リクエストメソッド: POST
リクエストURL:デプロイ済みURL、例:https://your-company.orm.datarobot.com/predApi/v1.0
リクエストパラメーター¶
ヘッダー¶
| キー | 説明 | 例 |
|---|---|---|
| Datarobot-key | マネージドAIプラットフォームユーザーに必須です。文字列タイプ モデルがデプロイされたら、予測 > 予測APIで、DataRobot UIのコードスニペットを参照してください。 |
DR-key-12345abcdb-xyz6789 |
| Authorization | 必須。文字列 次の3つの方法がサポートされます。
|
|
| Content-Type | オプション。文字列型 デフォルト: application/octet-stream 提供されたコンテンツタイプはすべてモデルに渡されます。ただし、DRUMライブラリには、指定された文字セットを使用した textコンテンツタイプのためのデコードメカニズムが組み込まれています。 詳しくは、非構造化カスタムモデルの構築をご覧ください。 |
|
| Content-Encoding | オプション。文字列型 現在、デフォルトのデータ拡張を含むgzipエンコーディングだけがサポートされています。 |
gzip |
| Accept | オプション。文字列型 | */*(デフォルト)応答はモデルの出力によって定義されます。 |
引数のクエリ¶
現在、predictionsUnstructuredエンドポイントには対応していません。
本文¶
| データ | タイプ | 例 |
|---|---|---|
| カスタムモデルに渡すデータ | Bytes |
|
Response 200¶
HTTPレスポンスには、カスタムモデルの/predictUnstructuredルートによって返され、そのまま渡されるペイロードが含まれています。 Content-Typeヘッダーは、呼び出し元に渡されます。 Content-Typeヘッダーが提供されない場合、application/octet-streamのデフォルトが適用されます。
リクエストにDataRobotが認識したエラーがあった場合、application/jsonエラーメッセージが返されます。
DRUMライブラリでは、レスポンスペイロードとコンテンツタイプは score_unstructured()フックで生成されます。
エラーリスト¶
| HTTPコード | サンプルエラーメッセージ | リーズン |
|---|---|---|
| 400 BAD REQUEST | {"message":"Query parameters not accepted on this endpoint"} |
リクエストはエンドポイントにクエリーパラメーターを渡しました。 |
| 404 NOT FOUND | {"message": "Deployment :deploymentId cannot be found for user :userId"} |
リクエストは無効な:deploymentId(削除されたか存在しないデプロイ)を提供しました。 |
| 422 UNPROCESSABLE CONTENT | {"message": "Only unstructured custom models can be used with this endpoint. Use /predictions instead.} |
リクエストは、非構造化カスタム推論モデルではないデプロイの:deploymentIdを提供しました。 |