Skip to content

Commit 4fbbcda

Browse files
authored
[DOCS] Fix nesting in bucket correlation aggregation (#83816)
1 parent 26be52b commit 4fbbcda

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

docs/reference/aggregations/pipeline/bucket-correlation-aggregation.asciidoc

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,29 @@ The correlation function to execute.
3131
The configuration to calculate a count correlation. This function is designed for
3232
determining the correlation of a term value and a given metric. Consequently, it
3333
needs to meet the following requirements.
34+
+
35+
--
3436
3537
* The `buckets_path` must point to a `_count` metric.
3638
* The total count of all the `bucket_path` count values must be less than or equal to `indicator.doc_count`.
3739
* When utilizing this function, an initial calculation to gather the required `indicator` values is required.
38-
40+
--
41+
+
3942
.Properties of `count_correlation`
4043
[%collapsible%open]
4144
=====
4245
`indicator`:::
4346
(Required, object)
4447
The indicator with which to correlate the configured `bucket_path` values.
45-
48+
+
4649
.Properties of `indicator`
4750
[%collapsible%open]
48-
=====
51+
======
52+
`doc_count`:::
53+
(Required, integer)
54+
The total number of documents that initially created the `expectations`. It's required to be greater than or equal to the sum
55+
of all values in the `buckets_path` as this is the originating superset of data to which the term values are correlated.
56+
4957
`expectations`:::
5058
(Required, array)
5159
An array of numbers with which to correlate the configured `bucket_path` values. The length of this value must always equal
@@ -55,12 +63,7 @@ the number of buckets returned by the `bucket_path`.
5563
(Optional, array)
5664
An array of fractions to use when averaging and calculating variance. This should be used if the pre-calculated data and the
5765
`buckets_path` have known gaps. The length of `fractions`, if provided, must equal `expectations`.
58-
59-
`doc_count`:::
60-
(Required, integer)
61-
The total number of documents that initially created the `expectations`. It's required to be greater than or equal to the sum
62-
of all values in the `buckets_path` as this is the originating superset of data to which the term values are correlated.
63-
=====
66+
======
6467
=====
6568
====
6669

@@ -75,8 +78,10 @@ A `bucket_correlation` aggregation looks like this in isolation:
7578
"buckets_path": "range_values>_count", <1>
7679
"function": {
7780
"count_correlation": { <2>
78-
"expectations": [...],
79-
"doc_count": 10000
81+
"indicator": {
82+
"expectations": [...],
83+
"doc_count": 10000
84+
}
8085
}
8186
}
8287
}

0 commit comments

Comments
 (0)