forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ML] Add docs for ML info endpoint (elastic#35783)
This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates elastic#35777
- Loading branch information
1 parent
43d6ec8
commit 6f46584
Showing
2 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
[role="xpack"] | ||
[testenv="platinum"] | ||
[[get-ml-info]] | ||
=== Get Machine Learning Info API | ||
++++ | ||
<titleabbrev>Get Machine Learning Info</titleabbrev> | ||
++++ | ||
|
||
Returns defaults and limits used by machine learning. | ||
|
||
==== Request | ||
|
||
`GET _xpack/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 _xpack/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 | ||
} | ||
}, | ||
"limits" : { } | ||
} | ||
---- | ||
// TESTRESPONSE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters