|
|
@@ -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
|