honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Fixed short descriptions for ML APIs 

Original commit: elastic/x-pack-elasticsearch@75937c0da1
This commit is contained in:
lcawley 2018-01-15 08:44:08 -08:00
parent 86f612ae3a
commit c243d6eb21
34 changed files with 53 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/rest-api/ml/close-job.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Close Jobs</titleabbrev> <titleabbrev>Close Jobs</titleabbrev>
++++ ++++
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 job can be opened and closed multiple times throughout its lifecycle.
A closed job cannot receive data or perform analysis A closed job cannot receive data or perform analysis

2
docs/en/rest-api/ml/delete-calendar-job.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Delete Jobs from Calendar</titleabbrev> <titleabbrev>Delete Jobs from Calendar</titleabbrev>
++++ ++++
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 ==== Request

2
docs/en/rest-api/ml/delete-calendar.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Delete Calendar</titleabbrev> <titleabbrev>Delete Calendar</titleabbrev>
++++ ++++
The delete calendar API enables you to delete a calendar. This API enables you to delete a calendar.
==== Request ==== Request

2
docs/en/rest-api/ml/delete-datafeed.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Delete {dfeeds-cap}</titleabbrev> <titleabbrev>Delete {dfeeds-cap}</titleabbrev>
++++ ++++
The delete {dfeed} API enables you to delete an existing {dfeed}. This API enables you to delete an existing {dfeed}.
==== Request ==== Request

2
docs/en/rest-api/ml/delete-job.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Delete Jobs</titleabbrev> <titleabbrev>Delete Jobs</titleabbrev>
++++ ++++
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 ==== Request

2
docs/en/rest-api/ml/delete-snapshot.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Delete Model Snapshots</titleabbrev> <titleabbrev>Delete Model Snapshots</titleabbrev>
++++ ++++
The delete model snapshot API enables you to delete an existing model snapshot. This API enables you to delete an existing model snapshot.
==== Request ==== Request

4
docs/en/rest-api/ml/flush-job.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Flush Jobs</titleabbrev> <titleabbrev>Flush Jobs</titleabbrev>
++++ ++++
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 ==== Request
@ -15,7 +15,7 @@ The flush job API forces any buffered data to be processed by the job.
==== Description ==== 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
<<ml-post-data,post data API>>. Depending on the content of the buffer, then it <<ml-post-data,post data API>>. Depending on the content of the buffer, then it
might additionally calculate new results. might additionally calculate new results.

4
docs/en/rest-api/ml/forecast.asciidoc
View File

@ -5,8 +5,8 @@
<titleabbrev>Forecast Jobs</titleabbrev> <titleabbrev>Forecast Jobs</titleabbrev>
++++ ++++
The forecast jobs API uses historical behavior to predict the future behavior of This API uses historical behavior to predict the future behavior of a time
a time series. series.
==== Request ==== Request

5
docs/en/rest-api/ml/get-bucket.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Get Buckets</titleabbrev> <titleabbrev>Get Buckets</titleabbrev>
++++ ++++
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 ==== Request
@ -17,7 +17,8 @@ The get bucket API enables you to retrieve job results for one or more buckets.
==== Description ==== 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 ==== Path Parameters

2
docs/en/rest-api/ml/get-calendar.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Get Calendars</titleabbrev> <titleabbrev>Get Calendars</titleabbrev>
++++ ++++
The get calendars API enables you to retrieve configuration information for This API enables you to retrieve configuration information for
calendars. calendars.

3
docs/en/rest-api/ml/get-category.asciidoc
View File

@ -5,8 +5,7 @@
<titleabbrev>Get Categories</titleabbrev> <titleabbrev>Get Categories</titleabbrev>
++++ ++++
The get categories API enables you to retrieve job results for one or more This API enables you to retrieve job results for one or more categories.
categories.
==== Request ==== Request

3
docs/en/rest-api/ml/get-datafeed-stats.asciidoc
View File

@ -5,8 +5,7 @@
<titleabbrev>Get {dfeed-cap} Statistics</titleabbrev> <titleabbrev>Get {dfeed-cap} Statistics</titleabbrev>
++++ ++++
The get {dfeed} statistics API enables you to retrieve usage information for This API enables you to retrieve usage information for {dfeeds}.
{dfeeds}.
==== Request ==== Request

3
docs/en/rest-api/ml/get-datafeed.asciidoc
View File

@ -5,8 +5,7 @@
<titleabbrev>Get {dfeeds-cap}</titleabbrev> <titleabbrev>Get {dfeeds-cap}</titleabbrev>
++++ ++++
The get {dfeeds} API enables you to retrieve configuration information for This API enables you to retrieve configuration information for {dfeeds}.
{dfeeds}.
==== Request ==== Request

3
docs/en/rest-api/ml/get-influencer.asciidoc
View File

@ -5,8 +5,7 @@
<titleabbrev>Get Influencers</titleabbrev> <titleabbrev>Get Influencers</titleabbrev>
++++ ++++
The get influencers API enables you to retrieve job results for one or more This API enables you to retrieve job results for one or more influencers.
influencers.
==== Request ==== Request

2
docs/en/rest-api/ml/get-job-stats.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Get Job Statistics</titleabbrev> <titleabbrev>Get Job Statistics</titleabbrev>
++++ ++++
The get jobs API enables you to retrieve usage information for jobs. This API enables you to retrieve usage information for jobs.
==== Request ==== Request

2
docs/en/rest-api/ml/get-job.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Get Jobs</titleabbrev> <titleabbrev>Get Jobs</titleabbrev>
++++ ++++
The get jobs API enables you to retrieve configuration information for jobs. This API enables you to retrieve configuration information for jobs.
==== Request ==== Request

4
docs/en/rest-api/ml/get-overall-buckets.asciidoc
View File

@ -5,8 +5,8 @@
<titleabbrev>Get Overall Buckets</titleabbrev> <titleabbrev>Get Overall Buckets</titleabbrev>
++++ ++++
This API enables you to retrieve overall bucket results This API enables you to retrieve overall bucket results that summarize the
that summarize the bucket results of multiple jobs. bucket results of multiple jobs.
==== Request ==== Request

2
docs/en/rest-api/ml/get-record.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Get Records</titleabbrev> <titleabbrev>Get Records</titleabbrev>
++++ ++++
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 ==== Request

2
docs/en/rest-api/ml/get-snapshot.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Get Model Snapshots</titleabbrev> <titleabbrev>Get Model Snapshots</titleabbrev>
++++ ++++
The get model snapshots API enables you to retrieve information about model snapshots. This API enables you to retrieve information about model snapshots.
==== Request ==== Request

1
docs/en/rest-api/ml/open-job.asciidoc
View File

@ -5,6 +5,7 @@
<titleabbrev>Open Jobs</titleabbrev> <titleabbrev>Open Jobs</titleabbrev>
++++ ++++
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 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. A job can be opened and closed multiple times throughout its lifecycle.

2
docs/en/rest-api/ml/post-data.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Post Data to Jobs</titleabbrev> <titleabbrev>Post Data to Jobs</titleabbrev>
++++ ++++
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 ==== Request

8
docs/en/rest-api/ml/preview-datafeed.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Preview {dfeeds-cap}</titleabbrev> <titleabbrev>Preview {dfeeds-cap}</titleabbrev>
++++ ++++
The preview {dfeed} API enables you to preview a {dfeed}. This API enables you to preview a {dfeed}.
==== Request ==== Request
@ -15,9 +15,9 @@ The preview {dfeed} API enables you to preview a {dfeed}.
==== Description ==== Description
The API returns the first "page" of results from the `search` that is created The preview {dfeeds} API returns the first "page" of results from the `search`
by using the current {dfeed} settings. This preview shows the structure of that is created by using the current {dfeed} settings. This preview shows the
the data that will be passed to the anomaly detection engine. structure of the data that will be passed to the anomaly detection engine.
==== Path Parameters ==== Path Parameters

2
docs/en/rest-api/ml/put-calendar-job.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Add Jobs to Calendar</titleabbrev> <titleabbrev>Add Jobs to Calendar</titleabbrev>
++++ ++++
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 ==== Request

2
docs/en/rest-api/ml/put-calendar.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Create Calendar</titleabbrev> <titleabbrev>Create Calendar</titleabbrev>
++++ ++++
The create calendar API enables you to instantiate a calendar. This API enables you to instantiate a calendar.
==== Request ==== Request

2
docs/en/rest-api/ml/put-datafeed.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Create {dfeeds-cap}</titleabbrev> <titleabbrev>Create {dfeeds-cap}</titleabbrev>
++++ ++++
The create {dfeed} API enables you to instantiate a {dfeed}. This API enables you to instantiate a {dfeed}.
==== Request ==== Request

2
docs/en/rest-api/ml/put-job.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Create Jobs</titleabbrev> <titleabbrev>Create Jobs</titleabbrev>
++++ ++++
The create job API enables you to instantiate a job. This API enables you to instantiate a job.
==== Request ==== Request

16
docs/en/rest-api/ml/revert-snapshot.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Revert Model Snapshots</titleabbrev> <titleabbrev>Revert Model Snapshots</titleabbrev>
++++ ++++
The revert model snapshot API enables you to revert to a specific snapshot. This API enables you to revert to a specific snapshot.
==== Request ==== Request
@ -14,13 +14,13 @@ The revert model snapshot API enables you to revert to a specific snapshot.
==== Description ==== Description
The {ml} feature in {xpack} reacts quickly to anomalous input, learning new behaviors in data. The {ml} feature in {xpack} reacts quickly to anomalous input, learning new
Highly anomalous input increases the variance in the models whilst the system learns behaviors in data. Highly anomalous input increases the variance in the models
whether this is a new step-change in behavior or a one-off event. In the case whilst the system learns whether this is a new step-change in behavior or a
where this anomalous input is known to be a one-off, then it might be appropriate one-off event. In the case where this anomalous input is known to be a one-off,
to reset the model state to a time before this event. For example, you might then it might be appropriate to reset the model state to a time before this
consider reverting to a saved snapshot after Black Friday event. For example, you might consider reverting to a saved snapshot after Black
or a critical system failure. Friday or a critical system failure.
//// ////
To revert to a saved snapshot, you must follow this sequence: To revert to a saved snapshot, you must follow this sequence:

1
docs/en/rest-api/ml/start-datafeed.asciidoc
View File

@ -5,6 +5,7 @@
<titleabbrev>Start {dfeeds-cap}</titleabbrev> <titleabbrev>Start {dfeeds-cap}</titleabbrev>
++++ ++++
This API enables you to start one or more {dfeeds}.
A {dfeed} must be started in order to retrieve data from {es}. A {dfeed} must be started in order to retrieve data from {es}.
A {dfeed} can be started and stopped multiple times throughout its lifecycle. A {dfeed} can be started and stopped multiple times throughout its lifecycle.

2
docs/en/rest-api/ml/stop-datafeed.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Stop {dfeeds-cap}</titleabbrev> <titleabbrev>Stop {dfeeds-cap}</titleabbrev>
++++ ++++
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} that is stopped ceases to retrieve data from {es}.
A {dfeed} can be started and stopped multiple times throughout its lifecycle. A {dfeed} can be started and stopped multiple times throughout its lifecycle.

2
docs/en/rest-api/ml/update-datafeed.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Update {dfeeds-cap}</titleabbrev> <titleabbrev>Update {dfeeds-cap}</titleabbrev>
++++ ++++
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 ==== Request

2
docs/en/rest-api/ml/update-job.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Update Jobs</titleabbrev> <titleabbrev>Update Jobs</titleabbrev>
++++ ++++
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 ==== Request

2
docs/en/rest-api/ml/update-snapshot.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Update Model Snapshots</titleabbrev> <titleabbrev>Update Model Snapshots</titleabbrev>
++++ ++++
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 ==== Request

5
docs/en/rest-api/ml/validate-detector.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Validate Detectors </titleabbrev> <titleabbrev>Validate Detectors </titleabbrev>
++++ ++++
The validate detectors API validates detector configuration information. This API validates detector configuration information.
==== Request ==== Request
@ -13,7 +13,8 @@ The validate detectors API validates detector configuration information.
==== Description ==== 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 ==== Request Body

5
docs/en/rest-api/ml/validate-job.asciidoc
View File

@ -5,7 +5,7 @@
<titleabbrev>Validate Jobs</titleabbrev> <titleabbrev>Validate Jobs</titleabbrev>
++++ ++++
The validate jobs API validates job configuration information. This API validates job configuration information.
==== Request ==== Request
@ -13,7 +13,8 @@ The validate jobs API validates job configuration information.
==== Description ==== 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 ==== Request Body