mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-09 06:25:07 +00:00
92756288b4
the get-ml-info API documentation tested that the response show that ML's `upgrade_mode` was false. For reasons that may be true due to other tests running in parallel or not cleaning themselves up, this may not be guaranteed. Since the actual value here is not of importance, this commit relaxes the requirement that upgrade_mode be static.
62 lines
1.4 KiB
Plaintext
62 lines
1.4 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[get-ml-info]]
|
|
=== Get machine learning info API
|
|
++++
|
|
<titleabbrev>Get {ml} info</titleabbrev>
|
|
++++
|
|
|
|
Returns defaults and limits used by machine learning.
|
|
|
|
==== Request
|
|
|
|
`GET _ml/info`
|
|
|
|
==== Description
|
|
|
|
This endpoint is designed to be used by a user interface that needs to fully
|
|
understand machine learning configurations where some options are not specified,
|
|
meaning that the defaults should be used. This endpoint may be used to find out
|
|
what those defaults are.
|
|
|
|
|
|
==== Authorization
|
|
|
|
You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
|
|
privileges to use this API. The `machine_learning_admin` and `machine_learning_user`
|
|
roles provide these privileges. For more information, see
|
|
{stack-ov}/security-privileges.html[Security Privileges] and
|
|
{stack-ov}/built-in-roles.html[Built-in Roles].
|
|
|
|
|
|
==== Examples
|
|
|
|
The endpoint takes no arguments:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET _ml/info
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST
|
|
|
|
This is a possible response:
|
|
[source,js]
|
|
----
|
|
{
|
|
"defaults" : {
|
|
"anomaly_detectors" : {
|
|
"model_memory_limit" : "1gb",
|
|
"categorization_examples_limit" : 4,
|
|
"model_snapshot_retention_days" : 1
|
|
},
|
|
"datafeeds" : {
|
|
"scroll_size" : 1000
|
|
}
|
|
},
|
|
"upgrade_mode": false,
|
|
"limits" : { }
|
|
}
|
|
----
|
|
// TESTRESPONSE[s/"upgrade_mode": false/"upgrade_mode": $body.upgrade_mode/]
|