[DOCS] Updated titles of ML APIs
Original commit: elastic/x-pack-elasticsearch@3b3d856a89
This commit is contained in:
parent
51b80aa998
commit
4f1866db69
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-close-job]]
|
||||
=== Close Jobs
|
||||
=== Close Jobs API
|
||||
++++
|
||||
<titleabbrev>Close Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
The close job API enables you to close one or more jobs.
|
||||
A job can be opened and closed multiple times throughout its lifecycle.
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-delete-datafeed]]
|
||||
=== Delete {dfeeds-cap}
|
||||
=== Delete {dfeeds-cap} API
|
||||
++++
|
||||
<titleabbrev>Delete {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
The delete {dfeed} API enables you to delete an existing {dfeed}.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-delete-job]]
|
||||
=== Delete Jobs
|
||||
=== Delete Jobs API
|
||||
++++
|
||||
<titleabbrev>Delete Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
The delete job API enables you to delete an existing anomaly detection job.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-delete-snapshot]]
|
||||
=== Delete Model Snapshots
|
||||
=== Delete Model Snapshots API
|
||||
++++
|
||||
<titleabbrev>Delete Model Snapshots</titleabbrev>
|
||||
++++
|
||||
|
||||
The delete model snapshot API enables you to delete an existing model snapshot.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-flush-job]]
|
||||
=== Flush Jobs
|
||||
=== Flush Jobs API
|
||||
++++
|
||||
<titleabbrev>Flush Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
The flush job API forces any buffered data to be processed by the job.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-forecast]]
|
||||
=== Forecast Jobs
|
||||
=== Forecast Jobs API
|
||||
++++
|
||||
<titleabbrev>Forecast Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
The forecast jobs API uses historical behavior to predict the future behavior of
|
||||
a time series.
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-bucket]]
|
||||
=== Get Buckets
|
||||
=== Get Buckets API
|
||||
++++
|
||||
<titleabbrev>Get Buckets</titleabbrev>
|
||||
++++
|
||||
|
||||
The get bucket API enables you to retrieve job results for one or more buckets.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-category]]
|
||||
=== Get Categories
|
||||
=== Get Categories API
|
||||
++++
|
||||
<titleabbrev>Get Categories</titleabbrev>
|
||||
++++
|
||||
|
||||
The get categories API enables you to retrieve job results for one or more
|
||||
categories.
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-datafeed-stats]]
|
||||
=== Get {dfeed-cap} Statistics
|
||||
=== Get {dfeed-cap} Statistics API
|
||||
++++
|
||||
<titleabbrev>Get {dfeed-cap} Statistics</titleabbrev>
|
||||
++++
|
||||
|
||||
The get {dfeed} statistics API enables you to retrieve usage information for
|
||||
{dfeeds}.
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-datafeed]]
|
||||
=== Get {dfeeds-cap}
|
||||
=== Get {dfeeds-cap} API
|
||||
++++
|
||||
<titleabbrev>Get {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
The get {dfeeds} API enables you to retrieve configuration information for
|
||||
{dfeeds}.
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-influencer]]
|
||||
=== Get Influencers
|
||||
=== Get Influencers API
|
||||
++++
|
||||
<titleabbrev>Get Influencers</titleabbrev>
|
||||
++++
|
||||
|
||||
The get influencers API enables you to retrieve job results for one or more
|
||||
influencers.
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-job-stats]]
|
||||
=== Get Job Statistics
|
||||
=== Get Job Statistics API
|
||||
++++
|
||||
<titleabbrev>Get Job Statistics</titleabbrev>
|
||||
++++
|
||||
|
||||
The get jobs API enables you to retrieve usage information for jobs.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-job]]
|
||||
=== Get Jobs
|
||||
=== Get Jobs API
|
||||
++++
|
||||
<titleabbrev>Get Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
The get jobs API enables you to retrieve configuration information for jobs.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-overall-buckets]]
|
||||
=== Get Overall Buckets
|
||||
=== Get Overall Buckets API
|
||||
++++
|
||||
<titleabbrev>Get Overall Buckets</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve overall bucket results
|
||||
that summarize the bucket results of multiple jobs.
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-record]]
|
||||
=== Get Records
|
||||
=== Get Records API
|
||||
++++
|
||||
<titleabbrev>Get Records</titleabbrev>
|
||||
++++
|
||||
|
||||
The get records API enables you to retrieve anomaly records for a job.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-get-snapshot]]
|
||||
=== Get Model Snapshots
|
||||
=== Get Model Snapshots API
|
||||
++++
|
||||
<titleabbrev>Get Model Snapshots</titleabbrev>
|
||||
++++
|
||||
|
||||
The get model snapshots API enables you to retrieve information about model snapshots.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-open-job]]
|
||||
=== Open Jobs
|
||||
=== Open Jobs API
|
||||
++++
|
||||
<titleabbrev>Open Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
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.
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-post-data]]
|
||||
=== Post Data to Jobs
|
||||
=== Post Data to Jobs API
|
||||
++++
|
||||
<titleabbrev>Post Data to Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
The post data API enables you to send data to an anomaly detection job for analysis.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-preview-datafeed]]
|
||||
=== Preview {dfeeds-cap}
|
||||
=== Preview {dfeeds-cap} API
|
||||
++++
|
||||
<titleabbrev>Preview {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
The preview {dfeed} API enables you to preview a {dfeed}.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-put-datafeed]]
|
||||
=== Create {dfeeds-cap}
|
||||
=== Create {dfeeds-cap} API
|
||||
++++
|
||||
<titleabbrev>Create {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
The create {dfeed} API enables you to instantiate a {dfeed}.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-put-job]]
|
||||
=== Create Jobs
|
||||
=== Create Jobs API
|
||||
++++
|
||||
<titleabbrev>Create Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
The create job API enables you to instantiate a job.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-revert-snapshot]]
|
||||
=== Revert Model Snapshots
|
||||
=== Revert Model Snapshots API
|
||||
++++
|
||||
<titleabbrev>Revert Model Snapshots</titleabbrev>
|
||||
++++
|
||||
|
||||
The revert model snapshot API enables you to revert to a specific snapshot.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-start-datafeed]]
|
||||
=== Start {dfeeds-cap}
|
||||
=== Start {dfeeds-cap} API
|
||||
++++
|
||||
<titleabbrev>Start {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
A {dfeed} must be started in order to retrieve data from {es}.
|
||||
A {dfeed} can be started and stopped multiple times throughout its lifecycle.
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-stop-datafeed]]
|
||||
=== Stop {dfeeds-cap}
|
||||
=== Stop {dfeeds-cap} API
|
||||
++++
|
||||
<titleabbrev>Stop {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
The stop {dfeeds} API enables you to stop one or more {dfeeds}.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-update-datafeed]]
|
||||
=== Update {dfeeds-cap}
|
||||
=== Update {dfeeds-cap} API
|
||||
++++
|
||||
<titleabbrev>Update {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
The update {dfeed} API enables you to update certain properties of a {dfeed}.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-update-job]]
|
||||
=== Update Jobs
|
||||
=== Update Jobs API
|
||||
++++
|
||||
<titleabbrev>Update Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
The update job API enables you to update certain properties of a job.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-update-snapshot]]
|
||||
=== Update Model Snapshots
|
||||
=== Update Model Snapshots API
|
||||
++++
|
||||
<titleabbrev>Update Model Snapshots</titleabbrev>
|
||||
++++
|
||||
|
||||
The update model snapshot API enables you to update certain properties of a snapshot.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-valid-detector]]
|
||||
=== Validate Detectors
|
||||
=== Validate Detectors API
|
||||
++++
|
||||
<titleabbrev>Validate Detectors </titleabbrev>
|
||||
++++
|
||||
|
||||
The validate detectors API validates detector configuration information.
|
||||
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[ml-valid-job]]
|
||||
=== Validate Jobs
|
||||
=== Validate Jobs API
|
||||
++++
|
||||
<titleabbrev>Validate Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
The validate jobs API validates job configuration information.
|
||||
|
||||
|
|
Loading…
Reference in New Issue