diff --git a/docs/en/stack/index.asciidoc b/docs/en/stack/index.asciidoc index 2166d7f86..4392f696b 100644 --- a/docs/en/stack/index.asciidoc +++ b/docs/en/stack/index.asciidoc @@ -13,6 +13,7 @@ :kib-repo-dir: {docdir}/../../../../kibana/docs :xes-repo-dir: {docdir}/../../../../elasticsearch/x-pack/docs/en +:es-repo-dir: {docdir}/../../../../elasticsearch/docs/reference include::{asciidoc-dir}/../../shared/versions.asciidoc[] include::{asciidoc-dir}/../../shared/attributes.asciidoc[] diff --git a/docs/en/stack/ml/api-quickref.asciidoc b/docs/en/stack/ml/api-quickref.asciidoc new file mode 100644 index 000000000..be7416786 --- /dev/null +++ b/docs/en/stack/ml/api-quickref.asciidoc @@ -0,0 +1,102 @@ +[role="xpack"] +[[ml-api-quickref]] +== API quick reference + +All {ml} endpoints have the following base: + +[source,js] +---- +/_xpack/ml/ +---- +// NOTCONSOLE + +The main {ml} resources can be accessed with a variety of endpoints: + +* <>: Create and manage {ml} jobs +* <>: Select data from {es} to be analyzed +* <>: Access the results of a {ml} job +* <>: Manage model snapshots +//* <>: Validate subsections of job configurations + +[float] +[[ml-api-jobs]] +=== /anomaly_detectors/ + +* {ref}/ml-put-job.html[PUT /anomaly_detectors/+++]: Create a job +* {ref}/ml-open-job.html[POST /anomaly_detectors//_open]: Open a job +* {ref}/ml-post-data.html[POST /anomaly_detectors//_data]: Send data to a job +* {ref}/ml-get-job.html[GET /anomaly_detectors]: List jobs +* {ref}/ml-get-job.html[GET /anomaly_detectors/+++]: Get job details +* {ref}/ml-get-job-stats.html[GET /anomaly_detectors//_stats]: Get job statistics +* {ref}/ml-update-job.html[POST /anomaly_detectors//_update]: Update certain properties of the job configuration +* {ref}/ml-flush-job.html[POST anomaly_detectors//_flush]: Force a job to analyze buffered data +* {ref}/ml-forecast.html[POST anomaly_detectors//_forecast]: Forecast future job behavior +* {ref}/ml-close-job.html[POST /anomaly_detectors//_close]: Close a job +* {ref}/ml-delete-job.html[DELETE /anomaly_detectors/+++]: Delete a job + +[float] +[[ml-api-calendars]] +=== /calendars/ + +* {ref}/ml-put-calendar.html[PUT /calendars/+++]: Create a calendar +* {ref}/ml-post-calendar-event.html[POST /calendars/+++/events]: Add a scheduled event to a calendar +* {ref}/ml-put-calendar-job.html[PUT /calendars/+++/jobs/+++]: Associate a job with a calendar +* {ref}/ml-get-calendar.html[GET /calendars/+++]: Get calendar details +* {ref}/ml-get-calendar-event.html[GET /calendars/+++/events]: Get scheduled event details +* {ref}/ml-delete-calendar-event.html[DELETE /calendars/+++/events/+++]: Remove a scheduled event from a calendar +* {ref}/ml-delete-calendar-job.html[DELETE /calendars/+++/jobs/+++]: Disassociate a job from a calendar +* {ref}/ml-delete-calendar.html[DELETE /calendars/+++]: Delete a calendar + +[float] +[[ml-api-filters]] +=== /filters/ + +* {ref}/ml-put-filter.html[PUT /filters/+++]: Create a filter +* {ref}/ml-update-filter.html[POST /filters/+++/_update]: Update a filter +* {ref}/ml-get-filter.html[GET /filters/+++]: List filters +* {ref}/ml-delete-filter.html[DELETE /filter/+++]: Delete a filter + +[float] +[[ml-api-datafeeds]] +=== /datafeeds/ + +* {ref}/ml-put-datafeed.html[PUT /datafeeds/+++]: Create a {dfeed} +* {ref}/ml-start-datafeed.html[POST /datafeeds//_start]: Start a {dfeed} +* {ref}/ml-get-datafeed.html[GET /datafeeds]: List {dfeeds} +* {ref}/ml-get-datafeed.html[GET /datafeeds/+++]: Get {dfeed} details +* {ref}/ml-get-datafeed-stats.html[GET /datafeeds//_stats]: Get statistical information for {dfeeds} +* {ref}/ml-preview-datafeed.html[GET /datafeeds//_preview]: Get a preview of a {dfeed} +* {ref}/ml-update-datafeed.html[POST /datafeeds//_update]: Update certain settings for a {dfeed} +* {ref}/ml-stop-datafeed.html[POST /datafeeds//_stop]: Stop a {dfeed} +* {ref}/ml-delete-datafeed.html[DELETE /datafeeds/+++]: Delete {dfeed} + +[float] +[[ml-api-results]] +=== /results/ + +* {ref}/ml-get-bucket.html[GET /results/buckets]: List the buckets in the results +* {ref}/ml-get-bucket.html[GET /results/buckets/+++]: Get bucket details +* {ref}/ml-get-overall-buckets.html[GET /results/overall_buckets]: Get overall bucket results for multiple jobs +* {ref}/ml-get-category.html[GET /results/categories]: List the categories in the results +* {ref}/ml-get-category.html[GET /results/categories/+++]: Get category details +* {ref}/ml-get-influencer.html[GET /results/influencers]: Get influencer details +* {ref}/ml-get-record.html[GET /results/records]: Get records from the results + +[float] +[[ml-api-snapshots]] +=== /model_snapshots/ + +* {ref}/ml-get-snapshot.html[GET /model_snapshots]: List model snapshots +* {ref}/ml-get-snapshot.html[GET /model_snapshots/+++]: Get model snapshot details +* {ref}/ml-revert-snapshot.html[POST /model_snapshots//_revert]: Revert a model snapshot +* {ref}/ml-update-snapshot.html[POST /model_snapshots//_update]: Update certain settings for a model snapshot +* {ref}/ml-delete-snapshot.html[DELETE /model_snapshots/+++]: Delete a model snapshot + +//// +[float] +[[ml-api-validate]] +=== /validate/ + +* {ref}/ml-valid-detector.html[POST /anomaly_detectors/_validate/detector]: Validate a detector +* {ref}/ml-valid-job.html[POST /anomaly_detectors/_validate]: Validate a job +//// diff --git a/docs/en/stack/ml/index.asciidoc b/docs/en/stack/ml/index.asciidoc index 8ef213ebc..d0ee2a494 100644 --- a/docs/en/stack/ml/index.asciidoc +++ b/docs/en/stack/ml/index.asciidoc @@ -24,14 +24,14 @@ include::overview.asciidoc[] :edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/ml/getting-started.asciidoc include::getting-started.asciidoc[] -:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/ml/configuring.asciidoc -include::{xes-repo-dir}/ml/configuring.asciidoc[] +:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/ml/configuring.asciidoc +include::{es-repo-dir}/ml/configuring.asciidoc[] -:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/ml/stopping-ml.asciidoc -include::{xes-repo-dir}/ml/stopping-ml.asciidoc[] +:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/ml/stopping-ml.asciidoc +include::{es-repo-dir}/ml/stopping-ml.asciidoc[] -:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/ml/api-quickref.asciidoc -include::{xes-repo-dir}/ml/api-quickref.asciidoc[] +:edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/ml/api-quickref.asciidoc +include::api-quickref.asciidoc[] -:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/ml/functions.asciidoc -include::{xes-repo-dir}/ml/functions.asciidoc[] +:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/ml/functions.asciidoc +include::{es-repo-dir}/ml/functions.asciidoc[]