update ML-commons profile API's path parameters documentation (#5906)

* Update profile.md

Signed-off-by: Kalyan <kalyan.ben10@live.com>

* Update profile.md

Signed-off-by: Kalyan <kalyan.ben10@live.com>

* Update _ml-commons-plugin/api/profile.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Kalyan <kalyan.ben10@live.com>

* Update _ml-commons-plugin/api/profile.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Kalyan <kalyan.ben10@live.com>

* Update profile.md

Signed-off-by: Kalyan <kalyan.ben10@live.com>

---------

Signed-off-by: Kalyan <kalyan.ben10@live.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
This commit is contained in:
Kalyan 2023-12-18 22:38:15 +05:30 committed by GitHub
parent e845866e8e
commit 05df3b5d5d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions

View File

@ -29,15 +29,17 @@ To clear all monitoring requests, set `plugins.ml_commons.monitoring_request_cou
```json
GET /_plugins/_ml/profile
GET /_plugins/_ml/profile/models
GET /_plugins/_ml/profile/models/<model_id>
GET /_plugins/_ml/profile/tasks
GET /_plugins/_ml/profile/tasks/<task_id>
```
## Path parameters
Parameter | Data type | Description
:--- | :--- | :---
`model_id` | String | Returns runtime data for a specific model. You can string together multiple `model_id`s to return multiple model profiles.
`tasks`| String | Returns runtime data for a specific task. You can string together multiple `task_id`s to return multiple task profiles.
`model_id` | String | Returns runtime data for a specific model. You can provide multiple model IDs as comma-separated values to retrieve multiple model profiles.
`task_id`| String | Returns runtime data for a specific task. You can provide multiple task IDs as comma-separated values to retrieve multiple task profiles.
### Request fields
@ -101,4 +103,4 @@ GET /_plugins/_ml/profile
...
}
}
```
```