Skip to content

Commit 8bec50e

Browse files
[DOCS] Describes the relationship of the time-related settings in anomaly detection docs (#50959)
Co-Authored-By: David Roberts <[email protected]>
1 parent ffc7fc3 commit 8bec50e

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,11 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config]
6464
`frequency`::
6565
(Optional, <<time-units, time units>>)
6666
include::{docdir}/ml/ml-shared.asciidoc[tag=frequency]
67+
+
68+
--
69+
To learn more about the relationship between time related settings, see
70+
<<ml-put-datafeed-time-related-settings>>.
71+
--
6772

6873
`indices`::
6974
(Required, array)
@@ -84,6 +89,11 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=query]
8489
`query_delay`::
8590
(Optional, <<time-units, time units>>)
8691
include::{docdir}/ml/ml-shared.asciidoc[tag=query-delay]
92+
+
93+
--
94+
To learn more about the relationship between time related settings, see
95+
<<ml-put-datafeed-time-related-settings>>.
96+
--
8797

8898
`script_fields`::
8999
(Optional, object)
@@ -93,6 +103,20 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=script-fields]
93103
(Optional, unsigned integer)
94104
include::{docdir}/ml/ml-shared.asciidoc[tag=scroll-size]
95105

106+
107+
[[ml-put-datafeed-time-related-settings]]
108+
===== Interaction between time-related settings
109+
110+
Time-related settings have the following relationships:
111+
112+
* Queries run at `query_delay` after the end of
113+
each `frequency`.
114+
115+
* When `frequency` is shorter than `bucket_span` of the associated job, interim
116+
results for the last (partial) bucket are written, and then overwritten by the
117+
full bucket results eventually.
118+
119+
96120
[[ml-put-datafeed-example]]
97121
==== {api-examples-title}
98122

docs/reference/ml/anomaly-detection/apis/put-job.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=analysis-config]
4949
`analysis_config`.`bucket_span`:::
5050
(<<time-units,time units>>)
5151
include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-span]
52+
+
53+
--
54+
To learn more about the relationship between time related settings, see
55+
<<ml-put-datafeed-time-related-settings>>.
56+
--
5257

5358
`analysis_config`.`categorization_field_name`:::
5459
(string)

0 commit comments

Comments
 (0)