OpenSearch/docs/java-rest/high-level/ml
Dimitris Athanasiou 126c2fd2d5
[7.x][ML] Machine learning data frame analytics (#43544) (#43592)
This merges the initial work that adds a framework for performing
machine learning analytics on data frames. The feature is currently experimental
and requires a platinum license. Note that the original commits can be
found in the `feature-ml-data-frame-analytics` branch.

A new set of APIs is added which allows the creation of data frame analytics
jobs. Configuration allows specifying different types of analysis to be performed
on a data frame. At first there is support for outlier detection.

The APIs are:

- PUT _ml/data_frame/analysis/{id}
- GET _ml/data_frame/analysis/{id}
- GET _ml/data_frame/analysis/{id}/_stats
- POST _ml/data_frame/analysis/{id}/_start
- POST _ml/data_frame/analysis/{id}/_stop
- DELETE _ml/data_frame/analysis/{id}

When a data frame analytics job is started a persistent task is created and started.
The main steps of the task are:

1. reindex the source index into the dest index
2. analyze the data through the data_frame_analyzer c++ process
3. merge the results of the process back into the destination index

In addition, an evaluation API is added which packages commonly used metrics
that provide evaluation of various analysis:

- POST _ml/data_frame/_evaluate
2019-06-25 20:29:11 +03:00
..
close-job.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
delete-calendar-event.asciidoc HLRC: ML Delete event from Calendar (#35760) 2018-11-21 16:22:04 -06:00
delete-calendar-job.asciidoc HLRC: ML Delete event from Calendar (#35760) 2018-11-21 16:22:04 -06:00
delete-calendar.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
delete-data-frame-analytics.asciidoc [7.x][ML] Machine learning data frame analytics (#43544) (#43592) 2019-06-25 20:29:11 +03:00
delete-datafeed.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
delete-expired-data.asciidoc [HLRC][ML] Add delete expired data API (#35906) 2018-11-26 16:15:54 +00:00
delete-filter.asciidoc HLRC: Add ML delete filter action (#35382) 2018-11-19 11:25:35 +01:00
delete-forecast.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
delete-job.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
delete-model-snapshot.asciidoc [HLRC][ML] Add ML delete model snapshot API (#35537) 2018-11-15 14:57:17 +00:00
evaluate-data-frame.asciidoc [7.x][ML] Machine learning data frame analytics (#43544) (#43592) 2019-06-25 20:29:11 +03:00
find-file-structure.asciidoc [HLRC][ML] Add ML find file structure API (#35833) 2018-11-23 06:58:05 +00:00
flush-job.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
forecast-job.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-buckets.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-calendar-events.asciidoc HLRC: ML Get Calendar Events (#35747) 2018-11-20 16:40:31 -06:00
get-calendars.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-categories.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-data-frame-analytics-stats.asciidoc [7.x][ML] Machine learning data frame analytics (#43544) (#43592) 2019-06-25 20:29:11 +03:00
get-data-frame-analytics.asciidoc [7.x][ML] Machine learning data frame analytics (#43544) (#43592) 2019-06-25 20:29:11 +03:00
get-datafeed-stats.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-datafeed.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-filters.asciidoc HLRC: Adding ml get filters api (#35502) 2018-11-13 14:53:32 -06:00
get-influencers.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-info.asciidoc [HLRC] XPack ML info action (#35777) 2018-11-28 10:58:20 +00:00
get-job-stats.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-job.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-model-snapshots.asciidoc [HLRC][ML] Add ML get model snapshots API (#35487) 2018-11-14 13:03:04 +00:00
get-overall-buckets.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
get-records.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
open-job.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
post-calendar-event.asciidoc HLRC ML Add Event To Calendar API (#35704) 2018-11-20 08:15:21 -06:00
post-data.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
preview-datafeed.asciidoc HLRC: ML Add preview datafeed api (#34284) 2018-10-04 11:28:44 -07:00
put-calendar-job.asciidoc HLRC: ML Add Job to Calendar API (#35666) 2018-11-19 11:41:49 -06:00
put-calendar.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
put-data-frame-analytics.asciidoc [7.x][ML] Machine learning data frame analytics (#43544) (#43592) 2019-06-25 20:29:11 +03:00
put-datafeed.asciidoc ML: changing automatic check_window calculation (#35643) 2018-11-19 08:03:34 -06:00
put-filter.asciidoc HLRC: Add ML API PUT filter (#35175) 2018-11-05 08:56:53 -06:00
put-job.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
revert-model-snapshot.asciidoc [HLRC][ML] Add ML revert model snapshot API (#35750) 2018-11-21 09:10:37 +00:00
set-upgrade-mode.asciidoc ML: Add upgrade mode docs, hlrc, and fix bug (#37942) 2019-01-30 06:51:11 -06:00
start-data-frame-analytics.asciidoc [7.x][ML] Machine learning data frame analytics (#43544) (#43592) 2019-06-25 20:29:11 +03:00
start-datafeed.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
stop-data-frame-analytics.asciidoc [7.x][ML] Machine learning data frame analytics (#43544) (#43592) 2019-06-25 20:29:11 +03:00
stop-datafeed.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
update-datafeed.asciidoc HLRC: Adding Update datafeed API (#34882) 2018-10-26 16:44:12 -05:00
update-filter.asciidoc HLRC: Adding ML Update Filter API (#35522) 2018-11-14 11:13:11 -06:00
update-job.asciidoc Feature/hlrc ml docs cleanup (#34316) 2018-10-05 08:45:46 -07:00
update-model-snapshot.asciidoc [HLRC][ML] Add ML update model snapshot API (#35537) (#35694) 2018-11-20 12:18:29 +00:00