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

[DOCS] Improves navigation between forecast APIs and adds short description. (#57035)

This commit is contained in:
István Zoltán Szabó 2020-05-25 09:09:47 +02:00
parent 05c019585e
commit 47bf95cee3
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/reference/ml/anomaly-detection/apis/forecast.asciidoc
View File

@ -23,7 +23,14 @@ Predicts the future behavior of a time series by using its historical behavior.
[[ml-forecast-desc]]
==== {api-description-title}
See {ml-docs}/ml-overview.html#ml-forecasting[Forecasting the future].
You can create a forecast job based on an {anomaly-job} to extrapolate future
behavior. Refer to
{ml-docs}/ml-overview.html#ml-forecasting[Forecasting the future] and
{ml-docs}/ml-limitations.html#ml-forecast-limitations[forecast limitations] to
learn more.
You can delete a forecast by using the
<<ml-delete-forecast,Delete forecast API>>.
[NOTE]
===============================
@ -50,9 +57,11 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
processed.
`expires_in`::
(Optional, <<time-units, time units>>) The period of time that forecast results are retained.
After a forecast expires, the results are deleted. The default value is 14 days.
If set to a value of `0`, the forecast is never automatically deleted.
(Optional, <<time-units, time units>>) The period of time that forecast
results are retained. After a forecast expires, the results are deleted. The
default value is 14 days. If set to a value of `0`, the forecast is never
automatically deleted.
[[ml-forecast-example]]
==== {api-examples-title}