機械学習トレーニングモデルAPI - トレーニングモデルデプロイメントを停止（Stop trained model deployment）

トレーニング済みモデルデプロイメントAPIの停止

トレーニング済みモデルのデプロイメントを停止します。

POST _ml/trained_models/<deployment_id>/deployment/_stop

manage_ml クラスター権限が必要です。この権限は machine_learning_admin ビルトインロールに含まれています。

デプロイメントは、PyTorch model_type を持つトレーニング済みモデルにのみ必要です。

allow_no_match
(オプション、ブール値) リクエスト時の動作を指定します:
- ワイルドカード式を含み、一致するデプロイメントがない場合。
- _all 文字列を含むか、識別子がない場合で、一致がない場合。
- ワイルドカード式を含み、部分一致のみがある場合。
  デフォルト値は true で、一致がない場合は空の配列を返し、部分一致がある場合は結果のサブセットを返します。このパラメータが false の場合、リクエストは一致がない場合または部分一致のみの場合に 404 ステータスコードを返します。
force
(オプション、ブール値) true の場合、デプロイメントは停止されます。たとえそれまたはそのモデルエイリアスのいずれかがインジェストパイプラインによって参照されていてもです。モデルデプロイメントを再起動するまで、これらのパイプラインは使用できません。
finish_pending_work
(オプション、ブール値) true の場合、デプロイメントはキューに入れられた作業が完了した後に停止されます。デフォルトは false です。

以下の例は my_model_for_search デプロイメントを停止します:

resp = client.ml.stop_trained_model_deployment(
   model_id="my_model_for_search",
)
print(resp)

response = client.ml.stop_trained_model_deployment(
  model_id: 'my_model_for_search'
)
puts response

const response = await client.ml.stopTrainedModelDeployment({
  model_id: "my_model_for_search",
});
console.log(response);

POST _ml/trained_models/my_model_for_search/deployment/_stop