mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-10 15:05:33 +00:00
6f46584380
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
145 lines
4.1 KiB
Plaintext
145 lines
4.1 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-apis]]
|
|
== Machine Learning APIs
|
|
|
|
You can use the following APIs to perform {ml} activities.
|
|
See <<ml-api-definitions, Definitions>> for the resource definitions used by the
|
|
machine learning APIs and in advanced job configuration options in Kibana.
|
|
|
|
[float]
|
|
[[ml-api-calendar-endpoint]]
|
|
=== Calendars
|
|
|
|
* <<ml-put-calendar,Create calendar>>, <<ml-delete-calendar,Delete calendar>>
|
|
* <<ml-put-calendar-job,Add job to calendar>>, <<ml-delete-calendar-job,Delete job from calendar>>
|
|
* <<ml-post-calendar-event,Add scheduled events to calendar>>, <<ml-delete-calendar-event,Delete scheduled events from calendar>>
|
|
* <<ml-get-calendar,Get calendars>>, <<ml-get-calendar-event,Get scheduled events>>
|
|
|
|
[float]
|
|
[[ml-api-filter-endpoint]]
|
|
=== Filters
|
|
|
|
* <<ml-put-filter,Create filter>>, <<ml-delete-filter,Delete filter>>
|
|
* <<ml-update-filter,Update filters>>
|
|
* <<ml-get-filter,Get filters>>
|
|
|
|
[float]
|
|
[[ml-api-datafeed-endpoint]]
|
|
=== {dfeeds-cap}
|
|
|
|
* <<ml-put-datafeed,Create {dfeed}>>, <<ml-delete-datafeed,Delete {dfeed}>>
|
|
* <<ml-start-datafeed,Start {dfeed}>>, <<ml-stop-datafeed,Stop {dfeed}>>
|
|
* <<ml-get-datafeed,Get {dfeed} info>>, <<ml-get-datafeed-stats,Get {dfeed} statistics>>
|
|
* <<ml-preview-datafeed,Preview {dfeed}>>
|
|
* <<ml-update-datafeed,Update {dfeed}>>
|
|
|
|
|
|
|
|
[float]
|
|
[[ml-api-job-endpoint]]
|
|
=== Jobs
|
|
|
|
//* <<ml-valid-detector,Validate detectors>>, <<ml-valid-job,Validate job>>
|
|
* <<ml-put-job,Create job>>, <<ml-delete-job,Delete job>>
|
|
* <<ml-put-calendar-job,Add job to calendar>>, <<ml-delete-calendar-job,Delete job from calendar>>
|
|
* <<ml-open-job,Open job>>, <<ml-close-job,Close job>>
|
|
* <<ml-get-job,Get job info>>, <<ml-get-job-stats,Get job statistics>>
|
|
* <<ml-flush-job,Flush job>>
|
|
* <<ml-post-data,Post data to job>>
|
|
* <<ml-update-job,Update job>>
|
|
* <<ml-forecast,Forecast job behavior>>, <<ml-delete-forecast,Delete forecasts>>
|
|
|
|
[float]
|
|
[[ml-api-snapshot-endpoint]]
|
|
=== Model Snapshots
|
|
|
|
* <<ml-delete-snapshot,Delete model snapshot>>
|
|
* <<ml-get-snapshot,Get model snapshot info>>
|
|
* <<ml-revert-snapshot,Revert model snapshot>>
|
|
* <<ml-update-snapshot,Update model snapshot>>
|
|
|
|
|
|
[float]
|
|
[[ml-api-result-endpoint]]
|
|
=== Results
|
|
|
|
* <<ml-get-bucket,Get buckets>>
|
|
* <<ml-get-overall-buckets,Get overall buckets>>
|
|
* <<ml-get-category,Get categories>>
|
|
* <<ml-get-influencer,Get influencers>>
|
|
* <<ml-get-record,Get records>>
|
|
|
|
[float]
|
|
[[ml-api-file-structure-endpoint]]
|
|
=== File Structure
|
|
|
|
* <<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[]
|
|
//CLOSE
|
|
include::close-job.asciidoc[]
|
|
//CREATE
|
|
include::put-calendar.asciidoc[]
|
|
include::put-datafeed.asciidoc[]
|
|
include::put-filter.asciidoc[]
|
|
include::put-job.asciidoc[]
|
|
//DELETE
|
|
include::delete-calendar.asciidoc[]
|
|
include::delete-datafeed.asciidoc[]
|
|
include::delete-calendar-event.asciidoc[]
|
|
include::delete-filter.asciidoc[]
|
|
include::delete-forecast.asciidoc[]
|
|
include::delete-job.asciidoc[]
|
|
include::delete-calendar-job.asciidoc[]
|
|
include::delete-snapshot.asciidoc[]
|
|
//FIND
|
|
include::find-file-structure.asciidoc[]
|
|
//FLUSH
|
|
include::flush-job.asciidoc[]
|
|
//FORECAST
|
|
include::forecast.asciidoc[]
|
|
//GET
|
|
include::get-calendar.asciidoc[]
|
|
include::get-bucket.asciidoc[]
|
|
include::get-overall-buckets.asciidoc[]
|
|
include::get-category.asciidoc[]
|
|
include::get-datafeed.asciidoc[]
|
|
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[]
|
|
include::get-record.asciidoc[]
|
|
//OPEN
|
|
include::open-job.asciidoc[]
|
|
//POST
|
|
include::post-data.asciidoc[]
|
|
//PREVIEW
|
|
include::preview-datafeed.asciidoc[]
|
|
//REVERT
|
|
include::revert-snapshot.asciidoc[]
|
|
//START/STOP
|
|
include::start-datafeed.asciidoc[]
|
|
include::stop-datafeed.asciidoc[]
|
|
//UPDATE
|
|
include::update-datafeed.asciidoc[]
|
|
include::update-filter.asciidoc[]
|
|
include::update-job.asciidoc[]
|
|
include::update-snapshot.asciidoc[]
|
|
//VALIDATE
|
|
//include::validate-detector.asciidoc[]
|
|
//include::validate-job.asciidoc[]
|
|
|