Skip to content

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

DataRobot APIのリソース > APIリファレンスドキュメント > APIで予測を作成 > 予測APIリファレンス > 非構造化モデルデプロイでの予測

非構造化モデルデプロイでの予測

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

エンドポイント： /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つの方法がサポートされます。
  • 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 オプション。文字列型

デフォルト：application/octet-stream

提供されたコンテンツタイプはすべてモデルに渡されます。ただし、DRUMライブラリには、指定された文字セットを使用したtextコンテンツタイプのためのデコードメカニズムが組み込まれています。

詳しくは、非構造化カスタムモデルのアセンブルをご覧ください。
  • text/plain
  • text/csv
  • text/plain; charset=latin1
  • application/json; charset=UTF-8
  • custom/type
  • application/octet-stream
Content-Encoding オプション。文字列型

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

応答はモデルの出力によって定義されます。

引数のクエリ

現在、predictionsUnstructuredエンドポイントには対応していません。

本文

データ タイプ 例
カスタムモデルに渡すデータ Bytes
  • 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
  • {“data”: [{“some”: “json”}]}
  • Custom payload 123
  • <binary data>（画像データなど）

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を提供しました。
更新しました January 23, 2024