elasticsearch/docs/reference/ml/df-analytics/apis
Benjamin Trent b9dc522cb4
[7.x] [ML] adding new flag exclude_generated that removes generated fields in GET config APIs (#63899)(#63092) (#63177)
* [ML] adding for_export flag for ml plugin GET resource APIs (#63092)

This adds the new `for_export` flag to the following APIs:

- GET _ml/anomaly_detection/<job_id>
- GET _ml/datafeeds/<datafeed_id>
- GET _ml/data_frame/analytics/<analytics_id>

The flag is designed for cloning or exporting configuration objects to later be put into the same cluster or a separate cluster.

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 would effectively require changing to be of use (e.g. datafeed job_id)
- any field that is automatically set via another Elastic stack process (e.g. anomaly job custom_settings.created_by)

closes https://github.com/elastic/elasticsearch/issues/63055

* [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 12:42:52 -04:00
..
delete-dfanalytics.asciidoc [DOCS] Fix security links in machine learning APIs (#60098) (#60152) 2020-07-23 16:43:10 -07:00
delete-trained-models.asciidoc [DOCS] Updates trained models API docs titles. (#63165) 2020-10-02 10:16:19 -07:00
evaluate-dfanalytics.asciidoc [7.x][ML] Rename evaluation metric result fields to value (#63809) (#63921) 2020-10-20 14:16:44 +03:00
explain-dfanalytics.asciidoc [DOCS] Fix titles for ML APIs (#63152) (#63207) 2020-10-02 14:01:01 -07:00
get-dfanalytics-stats.asciidoc [DOCS] Adds inference phase to get DFA job stats. (#60737) 2020-08-05 16:26:02 +02:00
get-dfanalytics.asciidoc [7.x] [ML] adding new flag exclude_generated that removes generated fields in GET config APIs (#63899)(#63092) (#63177) 2020-10-20 12:42:52 -04:00
get-trained-models-stats.asciidoc [DOCS] Updates trained models API docs titles. (#63165) 2020-10-02 10:16:19 -07:00
get-trained-models.asciidoc [7.x] [ML] adding new flag exclude_generated that removes generated fields in GET config APIs (#63899)(#63092) (#63177) 2020-10-20 12:42:52 -04:00
index.asciidoc [7.x] [ML] renames */inference* apis to */trained_models* (#63097) (#63136) 2020-10-02 07:34:28 -04:00
ml-df-analytics-apis.asciidoc [7.x] [ML] renames */inference* apis to */trained_models* (#63097) (#63136) 2020-10-02 07:34:28 -04:00
put-dfanalytics.asciidoc [ML] Allow setting num_top_classes to a special value -1 (#63587) (#63601) 2020-10-13 14:00:12 +02:00
put-trained-models.asciidoc [DOCS] Updates trained models API docs titles. (#63165) 2020-10-02 10:16:19 -07:00
start-dfanalytics.asciidoc [DOCS] Fix security links in machine learning APIs (#60098) (#60152) 2020-07-23 16:43:10 -07:00
stop-dfanalytics.asciidoc [DOCS] Fix security links in machine learning APIs (#60098) (#60152) 2020-07-23 16:43:10 -07:00
update-dfanalytics.asciidoc [DOCS] Minor typo in ML API (#62414) 2020-09-15 13:20:55 -07:00