REST APIリファレンス > モデルサーバー REST API > モデルデプロイメント

モデルデプロイメント

APIリソースを使用して、機械学習モデルのモデルデプロイメントの作成、デプロイメントの編集、組織内のデプロイメントの監視を行います。

モデルデプロイメントの作成

ドキュメントリソースを使用して、モデルデプロイメントを作成します。

POST要求

モデルデプロイメントを作成するには、URIにプロジェクトまたはフォルダIDを含めます。次のURIを使用します。

/frs/v1/Projects('<project ID>')/Documents

要求に次のフィールドを含めます。

フィールド	タイプ	説明
name	String	モデルデプロイメント名。
description	String	オプション。モデルデプロイメントの説明。
documentType	String	MLOPS_DEPLOYMENTを使用します。
documentState	String	空の文字列を使用します。
nativeData	オブジェクト	モデルデプロイメントを定義するBLOBオブジェクト。

次のフィールドをnativeDataオブジェクトに含めます。

フィールド	タイプ	説明
name	String	モデルデプロイメント名。
modelId	String	このデプロイメントに関連付ける機械学習モデルのID。
computeUnits	Integer	モデルデプロイメントで使用するコンピューティングユニットの最大数。4-40の4の倍数の整数を入力します。

POST応答

モデルデプロイメントの概要を返します。

モデルデプロイメントの編集

ドキュメントリソースを使用して、モデルデプロイメントを編集します。

PATCH要求

モデルデプロイメントを編集するには、URIにデプロイメントIDを含めます。次のURIを使用します。

/frs/v1/Documents('<deployment ID>')

応答からデプロイメントIDを取得して、モデルデプロイメントを作成するか、モデルデプロイメントを監視します。

要求に次のフィールドを含めます。

フィールド	タイプ	説明
name	String	モデルデプロイメント名。
description	String	オプション。モデルデプロイメントの説明。
documentType	String	MLOPS_DEPLOYMENTを使用します。
nativeData	オブジェクト	モデルデプロイメントを定義するBLOBオブジェクト。

次のフィールドをnativeDataオブジェクトに含めます。

フィールド	タイプ	説明
name	String	モデルデプロイメント名。
modelId	String	このデプロイメントに関連付ける機械学習モデルのID。
computeUnits	整数	モデルデプロイメントで使用するコンピューティングユニットの最大数。4-40の4の倍数の整数を入力します。

POST応答

モデルデプロイメントの概要を返します。

モデルデプロイメントの監視

デプロイメントリソースを使用して、モデルデプロイメントのステータスを監視します。

GET要求

組織内のすべてのデプロイメントのステータス、または特定のデプロイメントのステータスを要求できます。

組織内のすべてのデプロイメントのステータス: 組織内のすべてのデプロイメントのステータスを取得するには、次のURIを使用します。
特定のデプロイメントのステータス: 特定のデプロイメントのステータスを取得するには、URIにデプロイメントIDを含めます。次のURIを使用します。

GET応答

クエリパラメータ内のすべてのデプロイメントの結果とデプロイメントステータスオブジェクトに関する詳細を返します。特定のデプロイメントの詳細を要求した場合は、デプロイメントステータスオブジェクトのみを返します。

次の表に、デプロイメントステータスオブジェクトのフィールドを示します。

フィールド	説明
count	この応答で返されたデプロイメントの数。
offset	応答で使用されるオフセット。注: 要求された値が範囲外の場合、要求内のオフセットとは異なる値が使用される可能性があります。
limit	応答で使用される制限。注: 要求された値が範囲外の場合、要求の制限とは異なる値が使用される可能性があります。
デプロイメント	各デプロイメントの説明を示すオブジェクト。
deploymentID	モデルデプロイメントのID。
deploymentName	モデルデプロイメントの名前。
state	要求されたデプロイメントの状態。デプロイメントを開始または再開すると、状態はENABLEDになります。デプロイメントを停止すると、状態はDISABLEDになります。
ステータス	デプロイメントの内部ステータス。
statusLabel	現在の状態とステータスの外部ステータスラベル。
message	警告またはエラーメッセージの文字列。警告またはエラーが発生した場合にのみ適用されます。
locationID	デプロイメントを保存するフォルダのID。
locationName	デプロイメントを保存するフォルダの名前。
startedByUserID	最後にデプロイメントを開始したユーザーのID。
startedbyUserName	最後にデプロイメントを開始したユーザーの名前。
startTime	デプロイメントを開始した時刻（UNIXエポック（1970年1月1日00:00:00 UTC）からの経過秒数）。
stopTime	デプロイメントを停止した時刻（UNIXエポックからの経過秒数）。デプロイメントを停止した場合にのみ適用されます。
duration	デプロイメントの実行が開始されてから経過した時間（ミリ秒）。
updateTime	デプロイメントステータスを最後に更新した時刻（UNIXエポックからの経過秒数）。
monitorTime	デプロイメントステータスがチェックされた時刻（UNIXエポックから経過した時間（ミリ秒単位））。
agentSaasid	ジョブをデプロイするエージェントのID。
communicationMode	REST APIへの通信モード。通信モードは、channelです。
predictUrl	モデルから予測を生成するために使用するエンドポイントURL。
フレームワーク	機械学習モデルの作成に使用するフレームワーク。
frameworkType	機械学習モデルの登録に使用するフレームワークのタイプ。