[DOCS] Shortens ML API intros
This commit is contained in:
lcawl
parent
93662c6385
commit
509729f9c1
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Close Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to close one or more jobs.
|
||||
Closes 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
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Delete Events from Calendar</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to delete scheduled events from a calendar.
|
||||
Deletes scheduled events from a calendar.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Delete Jobs from Calendar</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to delete jobs from a calendar.
|
||||
Deletes jobs from a calendar.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Delete Calendar</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to delete a calendar.
|
||||
Deletes a calendar.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Delete {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to delete an existing {dfeed}.
|
||||
Deletes an existing {dfeed}.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Delete Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to delete an existing anomaly detection job.
|
||||
Deletes an existing anomaly detection job.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Delete Model Snapshots</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to delete an existing model snapshot.
|
||||
Deletes an existing model snapshot.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Flush Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API forces any buffered data to be processed by the job.
|
||||
Forces any buffered data to be processed by the job.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,8 +5,7 @@
|
|||
<titleabbrev>Forecast Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API uses historical behavior to predict the future behavior of a time
|
||||
series.
|
||||
Predict the future behavior of a time series by using historical behavior.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Buckets</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve job results for one or more buckets.
|
||||
Retrieves job results for one or more buckets.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Scheduled Events</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve information about the scheduled events in
|
||||
Retrieves information about the scheduled events in
|
||||
calendars.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Calendars</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve configuration information for calendars.
|
||||
Retrieves configuration information for calendars.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Categories</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve job results for one or more categories.
|
||||
Retrieves job results for one or more categories.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get {dfeed-cap} Statistics</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve usage information for {dfeeds}.
|
||||
Retrieves usage information for {dfeeds}.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve configuration information for {dfeeds}.
|
||||
Retrieves configuration information for {dfeeds}.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Influencers</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve job results for one or more influencers.
|
||||
Retrieves job results for one or more influencers.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Job Statistics</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve usage information for jobs.
|
||||
Retrieves usage information for jobs.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve configuration information for jobs.
|
||||
Retrieves configuration information for jobs.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Overall Buckets</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve overall bucket results that summarize the
|
||||
Retrieves overall bucket results that summarize the
|
||||
bucket results of multiple jobs.
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Records</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve anomaly records for a job.
|
||||
Retrieves anomaly records for a job.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Get Model Snapshots</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to retrieve information about model snapshots.
|
||||
Retrieves information about model snapshots.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Open Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to open one or more jobs.
|
||||
Opens 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Add Events to Calendar</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to post scheduled events in a calendar.
|
||||
Posts scheduled events in a calendar.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Post Data to Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to send data to an anomaly detection job for analysis.
|
||||
Sends data to an anomaly detection job for analysis.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Preview {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to preview a {dfeed}.
|
||||
Previews a {dfeed}.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Add Jobs to Calendar</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to add a job to a calendar.
|
||||
Adds a job to a calendar.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Create Calendar</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to instantiate a calendar.
|
||||
Instantiates a calendar.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Create {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to instantiate a {dfeed}.
|
||||
Instantiates a {dfeed}.
|
||||
|
||||
|
||||
==== Request
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Create Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to instantiate a job.
|
||||
Instantiates a job.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Revert Model Snapshots</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to revert to a specific snapshot.
|
||||
Reverts to a specific snapshot.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Start {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to start one or more {dfeeds}.
|
||||
Starts 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Stop {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to stop one or more {dfeeds}.
|
||||
Stops 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.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Update {dfeeds-cap}</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to update certain properties of a {dfeed}.
|
||||
Updates certain properties of a {dfeed}.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Update Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to update certain properties of a job.
|
||||
Updates certain properties of a job.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Update Model Snapshots</titleabbrev>
|
||||
++++
|
||||
|
||||
This API enables you to update certain properties of a snapshot.
|
||||
Updates certain properties of a snapshot.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Validate Detectors </titleabbrev>
|
||||
++++
|
||||
|
||||
This API validates detector configuration information.
|
||||
Validates detector configuration information.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<titleabbrev>Validate Jobs</titleabbrev>
|
||||
++++
|
||||
|
||||
This API validates job configuration information.
|
||||
Validates job configuration information.
|
||||
|
||||
==== Request
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue