opensearch-docs-cn/_ml-commons-plugin/api/model-group-apis/delete-model-group.md

1.2 KiB

layout title parent grand_parent nav_order
default Delete model group Model group APIs ML Commons APIs 40

Delete a model group

You can only delete a model group if it does not contain any model versions. {: .important}

If model access control is enabled on your cluster, only the owner or users with matching backend roles can delete the model group. Any users can delete any public model group.

If model access control is disabled on your cluster, users with the delete model group API permission can delete any model group.

Admin users can delete any model group. {: .note}

When you delete the last model version in a model group, that model group is automatically deleted from the index. {: .important}

For more information, see Model access control.

Example request

DELETE _plugins/_ml/model_groups/<model_group_id>

{% include copy-curl.html %}

Example response

{
  "_index": ".plugins-ml-model-group",
  "_id": "l8nnQogByXnLJ-QNpEk2",
  "_version": 5,
  "result": "deleted",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 70,
  "_primary_term": 23
}