From c243d6eb21c54a7afca65b28ed9347f24bee2733 Mon Sep 17 00:00:00 2001 From: lcawley Date: Mon, 15 Jan 2018 08:44:08 -0800 Subject: [PATCH] [DOCS] Fixed short descriptions for ML APIs Original commit: elastic/x-pack-elasticsearch@75937c0da1875a41542f5d9118d561cff42e524b --- docs/en/rest-api/ml/close-job.asciidoc | 2 +- docs/en/rest-api/ml/delete-calendar-job.asciidoc | 2 +- docs/en/rest-api/ml/delete-calendar.asciidoc | 2 +- docs/en/rest-api/ml/delete-datafeed.asciidoc | 2 +- docs/en/rest-api/ml/delete-job.asciidoc | 2 +- docs/en/rest-api/ml/delete-snapshot.asciidoc | 2 +- docs/en/rest-api/ml/flush-job.asciidoc | 4 ++-- docs/en/rest-api/ml/forecast.asciidoc | 4 ++-- docs/en/rest-api/ml/get-bucket.asciidoc | 5 +++-- docs/en/rest-api/ml/get-calendar.asciidoc | 2 +- docs/en/rest-api/ml/get-category.asciidoc | 3 +-- docs/en/rest-api/ml/get-datafeed-stats.asciidoc | 3 +-- docs/en/rest-api/ml/get-datafeed.asciidoc | 3 +-- docs/en/rest-api/ml/get-influencer.asciidoc | 3 +-- docs/en/rest-api/ml/get-job-stats.asciidoc | 2 +- docs/en/rest-api/ml/get-job.asciidoc | 2 +- docs/en/rest-api/ml/get-overall-buckets.asciidoc | 4 ++-- docs/en/rest-api/ml/get-record.asciidoc | 2 +- docs/en/rest-api/ml/get-snapshot.asciidoc | 2 +- docs/en/rest-api/ml/open-job.asciidoc | 1 + docs/en/rest-api/ml/post-data.asciidoc | 2 +- docs/en/rest-api/ml/preview-datafeed.asciidoc | 8 ++++---- docs/en/rest-api/ml/put-calendar-job.asciidoc | 2 +- docs/en/rest-api/ml/put-calendar.asciidoc | 2 +- docs/en/rest-api/ml/put-datafeed.asciidoc | 2 +- docs/en/rest-api/ml/put-job.asciidoc | 2 +- docs/en/rest-api/ml/revert-snapshot.asciidoc | 16 ++++++++-------- docs/en/rest-api/ml/start-datafeed.asciidoc | 1 + docs/en/rest-api/ml/stop-datafeed.asciidoc | 2 +- docs/en/rest-api/ml/update-datafeed.asciidoc | 2 +- docs/en/rest-api/ml/update-job.asciidoc | 2 +- docs/en/rest-api/ml/update-snapshot.asciidoc | 2 +- docs/en/rest-api/ml/validate-detector.asciidoc | 5 +++-- docs/en/rest-api/ml/validate-job.asciidoc | 5 +++-- 34 files changed, 53 insertions(+), 52 deletions(-) diff --git a/docs/en/rest-api/ml/close-job.asciidoc b/docs/en/rest-api/ml/close-job.asciidoc index e29442da47d..7009692673c 100644 --- a/docs/en/rest-api/ml/close-job.asciidoc +++ b/docs/en/rest-api/ml/close-job.asciidoc @@ -5,7 +5,7 @@ Close Jobs ++++ -The close job API enables you to close one or more jobs. +This API enables you to close one or more jobs. A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis diff --git a/docs/en/rest-api/ml/delete-calendar-job.asciidoc b/docs/en/rest-api/ml/delete-calendar-job.asciidoc index be959092e1d..65ffeb7d32a 100644 --- a/docs/en/rest-api/ml/delete-calendar-job.asciidoc +++ b/docs/en/rest-api/ml/delete-calendar-job.asciidoc @@ -5,7 +5,7 @@ Delete Jobs from Calendar ++++ -The delete jobs from calendar API enables you to remove jobs from a calendar. +This API enables you to remove jobs from a calendar. ==== Request diff --git a/docs/en/rest-api/ml/delete-calendar.asciidoc b/docs/en/rest-api/ml/delete-calendar.asciidoc index fc4ba7c5485..92085769f0e 100644 --- a/docs/en/rest-api/ml/delete-calendar.asciidoc +++ b/docs/en/rest-api/ml/delete-calendar.asciidoc @@ -5,7 +5,7 @@ Delete Calendar ++++ -The delete calendar API enables you to delete a calendar. +This API enables you to delete a calendar. ==== Request diff --git a/docs/en/rest-api/ml/delete-datafeed.asciidoc b/docs/en/rest-api/ml/delete-datafeed.asciidoc index c50e88734ee..eab8c061a2d 100644 --- a/docs/en/rest-api/ml/delete-datafeed.asciidoc +++ b/docs/en/rest-api/ml/delete-datafeed.asciidoc @@ -5,7 +5,7 @@ Delete {dfeeds-cap} ++++ -The delete {dfeed} API enables you to delete an existing {dfeed}. +This API enables you to delete an existing {dfeed}. ==== Request diff --git a/docs/en/rest-api/ml/delete-job.asciidoc b/docs/en/rest-api/ml/delete-job.asciidoc index 1f746e55d9b..e404e9d5f85 100644 --- a/docs/en/rest-api/ml/delete-job.asciidoc +++ b/docs/en/rest-api/ml/delete-job.asciidoc @@ -5,7 +5,7 @@ Delete Jobs ++++ -The delete job API enables you to delete an existing anomaly detection job. +This API enables you to delete an existing anomaly detection job. ==== Request diff --git a/docs/en/rest-api/ml/delete-snapshot.asciidoc b/docs/en/rest-api/ml/delete-snapshot.asciidoc index 16e9969bcac..b63e37a1b45 100644 --- a/docs/en/rest-api/ml/delete-snapshot.asciidoc +++ b/docs/en/rest-api/ml/delete-snapshot.asciidoc @@ -5,7 +5,7 @@ Delete Model Snapshots ++++ -The delete model snapshot API enables you to delete an existing model snapshot. +This API enables you to delete an existing model snapshot. ==== Request diff --git a/docs/en/rest-api/ml/flush-job.asciidoc b/docs/en/rest-api/ml/flush-job.asciidoc index 0a4c055113d..b67a0615af9 100644 --- a/docs/en/rest-api/ml/flush-job.asciidoc +++ b/docs/en/rest-api/ml/flush-job.asciidoc @@ -5,7 +5,7 @@ Flush Jobs ++++ -The flush job API forces any buffered data to be processed by the job. +This API forces any buffered data to be processed by the job. ==== Request @@ -15,7 +15,7 @@ The flush job API forces any buffered data to be processed by the job. ==== Description -The flush job API is only applicable when sending data for analysis using the +The flush jobs API is only applicable when sending data for analysis using the <>. Depending on the content of the buffer, then it might additionally calculate new results. diff --git a/docs/en/rest-api/ml/forecast.asciidoc b/docs/en/rest-api/ml/forecast.asciidoc index 37cab20188a..964d73a4100 100644 --- a/docs/en/rest-api/ml/forecast.asciidoc +++ b/docs/en/rest-api/ml/forecast.asciidoc @@ -5,8 +5,8 @@ Forecast Jobs ++++ -The forecast jobs API uses historical behavior to predict the future behavior of -a time series. +This API uses historical behavior to predict the future behavior of a time +series. ==== Request diff --git a/docs/en/rest-api/ml/get-bucket.asciidoc b/docs/en/rest-api/ml/get-bucket.asciidoc index f62b9d56c3e..9a20d4fc15e 100644 --- a/docs/en/rest-api/ml/get-bucket.asciidoc +++ b/docs/en/rest-api/ml/get-bucket.asciidoc @@ -5,7 +5,7 @@ Get Buckets ++++ -The get bucket API enables you to retrieve job results for one or more buckets. +This API enables you to retrieve job results for one or more buckets. ==== Request @@ -17,7 +17,8 @@ The get bucket API enables you to retrieve job results for one or more buckets. ==== Description -This API presents a chronological view of the records, grouped by bucket. +The get buckets API presents a chronological view of the records, grouped by +bucket. ==== Path Parameters diff --git a/docs/en/rest-api/ml/get-calendar.asciidoc b/docs/en/rest-api/ml/get-calendar.asciidoc index 0a6029633d3..d2936522766 100644 --- a/docs/en/rest-api/ml/get-calendar.asciidoc +++ b/docs/en/rest-api/ml/get-calendar.asciidoc @@ -5,7 +5,7 @@ Get Calendars ++++ -The get calendars API enables you to retrieve configuration information for +This API enables you to retrieve configuration information for calendars. diff --git a/docs/en/rest-api/ml/get-category.asciidoc b/docs/en/rest-api/ml/get-category.asciidoc index a0eae894de0..37d0a95c14c 100644 --- a/docs/en/rest-api/ml/get-category.asciidoc +++ b/docs/en/rest-api/ml/get-category.asciidoc @@ -5,8 +5,7 @@ Get Categories ++++ -The get categories API enables you to retrieve job results for one or more -categories. +This API enables you to retrieve job results for one or more categories. ==== Request diff --git a/docs/en/rest-api/ml/get-datafeed-stats.asciidoc b/docs/en/rest-api/ml/get-datafeed-stats.asciidoc index 4ee799271af..085b8c2df46 100644 --- a/docs/en/rest-api/ml/get-datafeed-stats.asciidoc +++ b/docs/en/rest-api/ml/get-datafeed-stats.asciidoc @@ -5,8 +5,7 @@ Get {dfeed-cap} Statistics ++++ -The get {dfeed} statistics API enables you to retrieve usage information for -{dfeeds}. +This API enables you to retrieve usage information for {dfeeds}. ==== Request diff --git a/docs/en/rest-api/ml/get-datafeed.asciidoc b/docs/en/rest-api/ml/get-datafeed.asciidoc index ac612ae6943..cf31207ba21 100644 --- a/docs/en/rest-api/ml/get-datafeed.asciidoc +++ b/docs/en/rest-api/ml/get-datafeed.asciidoc @@ -5,8 +5,7 @@ Get {dfeeds-cap} ++++ -The get {dfeeds} API enables you to retrieve configuration information for -{dfeeds}. +This API enables you to retrieve configuration information for {dfeeds}. ==== Request diff --git a/docs/en/rest-api/ml/get-influencer.asciidoc b/docs/en/rest-api/ml/get-influencer.asciidoc index 125197373bf..6c49e66e944 100644 --- a/docs/en/rest-api/ml/get-influencer.asciidoc +++ b/docs/en/rest-api/ml/get-influencer.asciidoc @@ -5,8 +5,7 @@ Get Influencers ++++ -The get influencers API enables you to retrieve job results for one or more -influencers. +This API enables you to retrieve job results for one or more influencers. ==== Request diff --git a/docs/en/rest-api/ml/get-job-stats.asciidoc b/docs/en/rest-api/ml/get-job-stats.asciidoc index d9d2273330b..a35e326eae2 100644 --- a/docs/en/rest-api/ml/get-job-stats.asciidoc +++ b/docs/en/rest-api/ml/get-job-stats.asciidoc @@ -5,7 +5,7 @@ Get Job Statistics ++++ -The get jobs API enables you to retrieve usage information for jobs. +This API enables you to retrieve usage information for jobs. ==== Request diff --git a/docs/en/rest-api/ml/get-job.asciidoc b/docs/en/rest-api/ml/get-job.asciidoc index 7a8f4c127b5..0818983406e 100644 --- a/docs/en/rest-api/ml/get-job.asciidoc +++ b/docs/en/rest-api/ml/get-job.asciidoc @@ -5,7 +5,7 @@ Get Jobs ++++ -The get jobs API enables you to retrieve configuration information for jobs. +This API enables you to retrieve configuration information for jobs. ==== Request diff --git a/docs/en/rest-api/ml/get-overall-buckets.asciidoc b/docs/en/rest-api/ml/get-overall-buckets.asciidoc index eee6cec9c04..d0e8c1f214b 100644 --- a/docs/en/rest-api/ml/get-overall-buckets.asciidoc +++ b/docs/en/rest-api/ml/get-overall-buckets.asciidoc @@ -5,8 +5,8 @@ Get Overall Buckets ++++ -This API enables you to retrieve overall bucket results -that summarize the bucket results of multiple jobs. +This API enables you to retrieve overall bucket results that summarize the +bucket results of multiple jobs. ==== Request diff --git a/docs/en/rest-api/ml/get-record.asciidoc b/docs/en/rest-api/ml/get-record.asciidoc index abe00f6547f..6cd222027e6 100644 --- a/docs/en/rest-api/ml/get-record.asciidoc +++ b/docs/en/rest-api/ml/get-record.asciidoc @@ -5,7 +5,7 @@ Get Records ++++ -The get records API enables you to retrieve anomaly records for a job. +This API enables you to retrieve anomaly records for a job. ==== Request diff --git a/docs/en/rest-api/ml/get-snapshot.asciidoc b/docs/en/rest-api/ml/get-snapshot.asciidoc index 53ce0a617a3..7ac2a3d765f 100644 --- a/docs/en/rest-api/ml/get-snapshot.asciidoc +++ b/docs/en/rest-api/ml/get-snapshot.asciidoc @@ -5,7 +5,7 @@ Get Model Snapshots ++++ -The get model snapshots API enables you to retrieve information about model snapshots. +This API enables you to retrieve information about model snapshots. ==== Request diff --git a/docs/en/rest-api/ml/open-job.asciidoc b/docs/en/rest-api/ml/open-job.asciidoc index a1dec2d684c..37d201ed226 100644 --- a/docs/en/rest-api/ml/open-job.asciidoc +++ b/docs/en/rest-api/ml/open-job.asciidoc @@ -5,6 +5,7 @@ Open Jobs ++++ +This API enables you to open one or more jobs. A job must be opened in order for it to be ready to receive and analyze data. A job can be opened and closed multiple times throughout its lifecycle. diff --git a/docs/en/rest-api/ml/post-data.asciidoc b/docs/en/rest-api/ml/post-data.asciidoc index 5daeb8b2f67..ec20be5dadb 100644 --- a/docs/en/rest-api/ml/post-data.asciidoc +++ b/docs/en/rest-api/ml/post-data.asciidoc @@ -5,7 +5,7 @@ Post Data to Jobs ++++ -The post data API enables you to send data to an anomaly detection job for analysis. +This API enables you to send data to an anomaly detection job for analysis. ==== Request diff --git a/docs/en/rest-api/ml/preview-datafeed.asciidoc b/docs/en/rest-api/ml/preview-datafeed.asciidoc index dfb402efa92..5f3bc5054e3 100644 --- a/docs/en/rest-api/ml/preview-datafeed.asciidoc +++ b/docs/en/rest-api/ml/preview-datafeed.asciidoc @@ -5,7 +5,7 @@ Preview {dfeeds-cap} ++++ -The preview {dfeed} API enables you to preview a {dfeed}. +This API enables you to preview a {dfeed}. ==== Request @@ -15,9 +15,9 @@ The preview {dfeed} API enables you to preview a {dfeed}. ==== Description -The API returns the first "page" of results from the `search` that is created -by using the current {dfeed} settings. This preview shows the structure of -the data that will be passed to the anomaly detection engine. +The preview {dfeeds} API returns the first "page" of results from the `search` +that is created by using the current {dfeed} settings. This preview shows the +structure of the data that will be passed to the anomaly detection engine. ==== Path Parameters diff --git a/docs/en/rest-api/ml/put-calendar-job.asciidoc b/docs/en/rest-api/ml/put-calendar-job.asciidoc index b7c550e1959..d49c4c62e79 100644 --- a/docs/en/rest-api/ml/put-calendar-job.asciidoc +++ b/docs/en/rest-api/ml/put-calendar-job.asciidoc @@ -5,7 +5,7 @@ Add Jobs to Calendar ++++ -The add jobs to calendar API enables you to add jobs to a calendar. +This API enables you to add jobs to a calendar. ==== Request diff --git a/docs/en/rest-api/ml/put-calendar.asciidoc b/docs/en/rest-api/ml/put-calendar.asciidoc index 5f8714b1d58..2598c35007f 100644 --- a/docs/en/rest-api/ml/put-calendar.asciidoc +++ b/docs/en/rest-api/ml/put-calendar.asciidoc @@ -5,7 +5,7 @@ Create Calendar ++++ -The create calendar API enables you to instantiate a calendar. +This API enables you to instantiate a calendar. ==== Request diff --git a/docs/en/rest-api/ml/put-datafeed.asciidoc b/docs/en/rest-api/ml/put-datafeed.asciidoc index 2e367273690..00d678d3091 100644 --- a/docs/en/rest-api/ml/put-datafeed.asciidoc +++ b/docs/en/rest-api/ml/put-datafeed.asciidoc @@ -5,7 +5,7 @@ Create {dfeeds-cap} ++++ -The create {dfeed} API enables you to instantiate a {dfeed}. +This API enables you to instantiate a {dfeed}. ==== Request diff --git a/docs/en/rest-api/ml/put-job.asciidoc b/docs/en/rest-api/ml/put-job.asciidoc index 8356b071dd1..975b87c6f1e 100644 --- a/docs/en/rest-api/ml/put-job.asciidoc +++ b/docs/en/rest-api/ml/put-job.asciidoc @@ -5,7 +5,7 @@ Create Jobs ++++ -The create job API enables you to instantiate a job. +This API enables you to instantiate a job. ==== Request diff --git a/docs/en/rest-api/ml/revert-snapshot.asciidoc b/docs/en/rest-api/ml/revert-snapshot.asciidoc index a835c0f4db3..30e93976543 100644 --- a/docs/en/rest-api/ml/revert-snapshot.asciidoc +++ b/docs/en/rest-api/ml/revert-snapshot.asciidoc @@ -5,7 +5,7 @@ Revert Model Snapshots ++++ -The revert model snapshot API enables you to revert to a specific snapshot. +This API enables you to revert to a specific snapshot. ==== Request @@ -14,13 +14,13 @@ The revert model snapshot API enables you to revert to a specific snapshot. ==== Description -The {ml} feature in {xpack} reacts quickly to anomalous input, learning new behaviors in data. -Highly anomalous input increases the variance in the models whilst the system learns -whether this is a new step-change in behavior or a one-off event. In the case -where this anomalous input is known to be a one-off, then it might be appropriate -to reset the model state to a time before this event. For example, you might -consider reverting to a saved snapshot after Black Friday -or a critical system failure. +The {ml} feature in {xpack} reacts quickly to anomalous input, learning new +behaviors in data. Highly anomalous input increases the variance in the models +whilst the system learns whether this is a new step-change in behavior or a +one-off event. In the case where this anomalous input is known to be a one-off, +then it might be appropriate to reset the model state to a time before this +event. For example, you might consider reverting to a saved snapshot after Black +Friday or a critical system failure. //// To revert to a saved snapshot, you must follow this sequence: diff --git a/docs/en/rest-api/ml/start-datafeed.asciidoc b/docs/en/rest-api/ml/start-datafeed.asciidoc index 801984deac0..865ca4ae997 100644 --- a/docs/en/rest-api/ml/start-datafeed.asciidoc +++ b/docs/en/rest-api/ml/start-datafeed.asciidoc @@ -5,6 +5,7 @@ Start {dfeeds-cap} ++++ +This API enables you to start one or more {dfeeds}. A {dfeed} must be started in order to retrieve data from {es}. A {dfeed} can be started and stopped multiple times throughout its lifecycle. diff --git a/docs/en/rest-api/ml/stop-datafeed.asciidoc b/docs/en/rest-api/ml/stop-datafeed.asciidoc index ca616b67404..3511c9362c3 100644 --- a/docs/en/rest-api/ml/stop-datafeed.asciidoc +++ b/docs/en/rest-api/ml/stop-datafeed.asciidoc @@ -5,7 +5,7 @@ Stop {dfeeds-cap} ++++ -The stop {dfeeds} API enables you to stop one or more {dfeeds}. +This API enables you to stop one or more {dfeeds}. A {dfeed} that is stopped ceases to retrieve data from {es}. A {dfeed} can be started and stopped multiple times throughout its lifecycle. diff --git a/docs/en/rest-api/ml/update-datafeed.asciidoc b/docs/en/rest-api/ml/update-datafeed.asciidoc index 560f3c82ca2..4643236c170 100644 --- a/docs/en/rest-api/ml/update-datafeed.asciidoc +++ b/docs/en/rest-api/ml/update-datafeed.asciidoc @@ -5,7 +5,7 @@ Update {dfeeds-cap} ++++ -The update {dfeed} API enables you to update certain properties of a {dfeed}. +This API enables you to update certain properties of a {dfeed}. ==== Request diff --git a/docs/en/rest-api/ml/update-job.asciidoc b/docs/en/rest-api/ml/update-job.asciidoc index 25640b32c82..f8bc3c10376 100644 --- a/docs/en/rest-api/ml/update-job.asciidoc +++ b/docs/en/rest-api/ml/update-job.asciidoc @@ -5,7 +5,7 @@ Update Jobs ++++ -The update job API enables you to update certain properties of a job. +This API enables you to update certain properties of a job. ==== Request diff --git a/docs/en/rest-api/ml/update-snapshot.asciidoc b/docs/en/rest-api/ml/update-snapshot.asciidoc index 30a2c0c5143..74a684619c4 100644 --- a/docs/en/rest-api/ml/update-snapshot.asciidoc +++ b/docs/en/rest-api/ml/update-snapshot.asciidoc @@ -5,7 +5,7 @@ Update Model Snapshots ++++ -The update model snapshot API enables you to update certain properties of a snapshot. +This API enables you to update certain properties of a snapshot. ==== Request diff --git a/docs/en/rest-api/ml/validate-detector.asciidoc b/docs/en/rest-api/ml/validate-detector.asciidoc index 60c0c7f0646..6fc5fea6fbb 100644 --- a/docs/en/rest-api/ml/validate-detector.asciidoc +++ b/docs/en/rest-api/ml/validate-detector.asciidoc @@ -5,7 +5,7 @@ Validate Detectors ++++ -The validate detectors API validates detector configuration information. +This API validates detector configuration information. ==== Request @@ -13,7 +13,8 @@ The validate detectors API validates detector configuration information. ==== Description -This API enables you validate the detector configuration before you create a job. +The validate detectors API enables you validate the detector configuration +before you create a job. ==== Request Body diff --git a/docs/en/rest-api/ml/validate-job.asciidoc b/docs/en/rest-api/ml/validate-job.asciidoc index 18a6e96da32..b206734bc03 100644 --- a/docs/en/rest-api/ml/validate-job.asciidoc +++ b/docs/en/rest-api/ml/validate-job.asciidoc @@ -5,7 +5,7 @@ Validate Jobs ++++ -The validate jobs API validates job configuration information. +This API validates job configuration information. ==== Request @@ -13,7 +13,8 @@ The validate jobs API validates job configuration information. ==== Description -This API enables you validate the job configuration before you create the job. +The validate jobs API enables you validate the job configuration before you +create the job. ==== Request Body