Files
OpenSearch-Docs-Cn/_ml-commons-plugin/api/model-apis/undeploy-model.md
T
3f7468b504 Add agent framework/throttling/hidden model/OS assistant and update conversational search documentation (#6354)
* Add agent framework documentation

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

* Add hidden model and API updates

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

* Vale error

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

* Updated field names

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

* Add updating credentials

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

* Added tools table

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

* Add OpenSearch forum thread for OS Assistant

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

* Add tech review for conv search

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

* Fix links

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

* Add tools

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

* Add links to tools

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

* More info about tools

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

* Tool parameters

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

* Update cat-index-tool.md

Signed-off-by: kolchfa-aws <[email protected]>

* Parameter clarification

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

* Tech review feedback

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

* Typo fix

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

* More tech review feedback: RAG tool

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

* Tech review feedback: memory APis

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

* Update _ml-commons-plugin/agents-tools/index.md

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

* Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md

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

* Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md

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

* Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md

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

* Update _ml-commons-plugin/opensearch-assistant.md

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

* Update _ml-commons-plugin/agents-tools/tools/ppl-tool.md

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

* Apply suggestions from code review

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

* Separated search and get APIs and add conversational flow agent

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

* More parameters for PPL tool

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

* Added more parameters

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

* Tech review feedback: PPL tool

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

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Rename to automating configurations

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

* Editorial comments on the new text

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

* Add parameter to PPl tool

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

* Changed link to configurations

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

* Rate limiter feedback and added warning

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

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2024-02-20 12:09:31 -05:00

59 lines
1.1 KiB
Markdown

---
layout: default
title: Undeploy model
parent: Model APIs
grand_parent: ML Commons APIs
nav_order: 45
---
# Undeploy a model
To undeploy a model from memory, use the undeploy operation.
For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations).
### Path and HTTP methods
```json
POST /_plugins/_ml/models/<model_id>/_undeploy
```
#### Example request: Undeploying a model from all ML nodes
```json
POST /_plugins/_ml/models/MGqJhYMBbbh0ushjm8p_/_undeploy
```
{% include copy-curl.html %}
#### Example request: Undeploying specific models from specific nodes
```json
POST /_plugins/_ml/models/_undeploy
{
"node_ids": ["sv7-3CbwQW-4PiIsDOfLxQ"],
"model_ids": ["KDo2ZYQB-v9VEDwdjkZ4"]
}
```
{% include copy-curl.html %}
#### Example request: Undeploying specific models from all nodes
```json
{
"model_ids": ["KDo2ZYQB-v9VEDwdjkZ4"]
}
```
{% include copy-curl.html %}
#### Example response
```json
{
"sv7-3CbwQW-4PiIsDOfLxQ" : {
"stats" : {
"KDo2ZYQB-v9VEDwdjkZ4" : "UNDEPLOYED"
}
}
}
```