Files
OpenSearch-Docs-Cn/_ml-commons-plugin/api/tasks-apis/delete-task.md
T
kolchfa-awsandMelissa Vagi 826e6771ed Refactor ML section - local and remote models (#5609)
* Refactor ML section - local and remote models

Signed-off-by: Fanit Kolchina <[email protected]>

* Added command to calculate checksum

Signed-off-by: Fanit Kolchina <[email protected]>

* Add ONNX format to register API

Signed-off-by: Fanit Kolchina <[email protected]>

* Add sparse encoding predict example

Signed-off-by: Fanit Kolchina <[email protected]>

* Add API section

Signed-off-by: Fanit Kolchina <[email protected]>

* Refactor the API section

Signed-off-by: Fanit Kolchina <[email protected]>

* Typo

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented Vale comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Add get connector API

Signed-off-by: Fanit Kolchina <[email protected]>

* Reword heading

Signed-off-by: Fanit Kolchina <[email protected]>

* Addressed tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
2023-11-17 15:59:27 -05:00

45 lines
885 B
Markdown

---
layout: default
title: Delete task
parent: Tasks APIs
grand_parent: ML Commons API
nav_order: 20
---
# Delete a task
Deletes a task based on the `task_id`.
ML Commons does not check the task status when running the delete request. There is a risk that a currently running task could be deleted before the task completes. To check the status of a task, run `GET /_plugins/_ml/tasks/<task_id>` before task deletion.
{: .note}
### Path and HTTP methods
```json
DELETE /_plugins/_ml/tasks/<task_id>
```
#### Example request
```json
DELETE /_plugins/_ml/tasks/xQRYLX8BydmmU1x6nuD3
```
{% include copy-curl.html %}
#### Example response
```json
{
"_index" : ".plugins-ml-task",
"_id" : "xQRYLX8BydmmU1x6nuD3",
"_version" : 4,
"result" : "deleted",
"_shards" : {
"total" : 2,
"successful" : 2,
"failed" : 0
},
"_seq_no" : 42,
"_primary_term" : 7
}
```