elasticsearch/docs/reference/ml/df-analytics/apis
Benjamin Trent c1de07fa83
[ML] adding new flag exclude_generated that removes generated fields in GET config APIs (#63899)
When exporting and cloning ml configurations in a cluster it can be
frustrating to remove all the fields that were generated by
the plugin. Especially as the number of these fields change
from version to version.

This flag, exclude_generated, allows the GET config APIs to return
configurations with these generated fields removed.

APIs supporting this flag: 
- GET _ml/anomaly_detection/<job_id>
- GET _ml/datafeeds/<datafeed_id>
- GET _ml/data_frame/analytics/<analytics_id>

The following fields are not returned in the objects:

- any field that is not user settable (e.g. version, create_time)
- any field that is a calculated default value (e.g. datafeed chunking_config)
- any field that is automatically set via another Elastic stack process (e.g. anomaly job custom_settings.created_by)

relates to #63055
2020-10-20 11:28:29 -04:00
..
delete-dfanalytics.asciidoc
delete-trained-models.asciidoc [DOCS] Updates trained models API docs titles. (#63165) 2020-10-02 10:15:14 -07:00
evaluate-dfanalytics.asciidoc [ML] Rename evaluation metric result fields to value (#63809) 2020-10-20 10:30:50 +03:00
explain-dfanalytics.asciidoc [DOCS] Fix titles for ML APIs (#63152) 2020-10-02 11:53:49 -07:00
get-dfanalytics-stats.asciidoc
get-dfanalytics.asciidoc [ML] adding new flag exclude_generated that removes generated fields in GET config APIs (#63899) 2020-10-20 11:28:29 -04:00
get-trained-models-stats.asciidoc [DOCS] Updates trained models API docs titles. (#63165) 2020-10-02 10:15:14 -07:00
get-trained-models.asciidoc [ML] adding new flag exclude_generated that removes generated fields in GET config APIs (#63899) 2020-10-20 11:28:29 -04:00
index.asciidoc
ml-df-analytics-apis.asciidoc
put-dfanalytics.asciidoc [ML] Allow setting num_top_classes to a special value -1 (#63587) 2020-10-13 13:14:17 +02:00
put-trained-models.asciidoc [DOCS] Updates trained models API docs titles. (#63165) 2020-10-02 10:15:14 -07:00
start-dfanalytics.asciidoc
stop-dfanalytics.asciidoc
update-dfanalytics.asciidoc