Skip to content

Commit

Permalink
[ML] Add docs for ML info endpoint (#35783)
Browse files Browse the repository at this point in the history
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 #35777
  • Loading branch information
droberts195 committed Nov 22, 2018
1 parent a37a681 commit 9821e1e
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
60 changes: 60 additions & 0 deletions docs/reference/ml/apis/get-ml-info.asciidoc
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
7 changes: 7 additions & 0 deletions docs/reference/ml/apis/ml-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,12 @@ machine learning APIs and in advanced job configuration options in Kibana.

* <<ml-find-file-structure,Find file structure>>

[float]
[[ml-api-ml-info-endpoint]]
=== Info

* <<get-ml-info,Machine learning info>>

//ADD
include::post-calendar-event.asciidoc[]
include::put-calendar-job.asciidoc[]
Expand Down Expand Up @@ -111,6 +117,7 @@ include::get-datafeed-stats.asciidoc[]
include::get-influencer.asciidoc[]
include::get-job.asciidoc[]
include::get-job-stats.asciidoc[]
include::get-ml-info.asciidoc[]
include::get-snapshot.asciidoc[]
include::get-calendar-event.asciidoc[]
include::get-filter.asciidoc[]
Expand Down

0 comments on commit 9821e1e

Please sign in to comment.