@@ -120,45 +120,140 @@ export class AggregationContainer {
120
120
*/
121
121
meta ?: Metadata
122
122
123
+ /**
124
+ * A bucket aggregation returning a form of adjacency matrix.
125
+ * The request provides a collection of named filter expressions, similar to the filters aggregation request.
126
+ * Each bucket in the response represents a non-empty cell in the matrix of intersecting filters.
127
+ * @doc_id search-aggregations-bucket-adjacency-matrix-aggregation
128
+ */
123
129
adjacency_matrix ?: AdjacencyMatrixAggregation
130
+ /**
131
+ * A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.
132
+ * @doc_id search-aggregations-bucket-autodatehistogram-aggregation
133
+ */
124
134
auto_date_histogram ?: AutoDateHistogramAggregation
135
+ /**
136
+ * A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.
137
+ * @doc_id search-aggregations-metrics-avg-aggregation
138
+ */
125
139
avg ?: AverageAggregation
140
+ /**
141
+ * A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.
142
+ * The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.
143
+ * @doc_id search-aggregations-pipeline-avg-bucket-aggregation
144
+ */
126
145
avg_bucket ?: AverageBucketAggregation
146
+ /**
147
+ * A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.
148
+ * @doc_id search-aggregations-metrics-boxplot-aggregation
149
+ */
127
150
boxplot ?: BoxplotAggregation
151
+ /**
152
+ * A parent pipeline aggregation which runs a script which can perform per bucket computations on specified metrics in the parent multi-bucket aggregation.
153
+ * @doc_id search-aggregations-pipeline-bucket-script-aggregation
154
+ */
128
155
bucket_script ?: BucketScriptAggregation
156
+ /**
157
+ * A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.
158
+ * @doc_id search-aggregations-pipeline-bucket-selector-aggregation
159
+ */
129
160
bucket_selector ?: BucketSelectorAggregation
161
+ /**
162
+ * A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.
163
+ * @doc_id search-aggregations-pipeline-bucket-sort-aggregation
164
+ */
130
165
bucket_sort ?: BucketSortAggregation
131
166
/**
167
+ * A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test ("K-S test") against a provided distribution, and the distribution implied by the documents counts in the configured sibling aggregation.
132
168
* @doc_id search-aggregations-bucket-count-ks-test-aggregation
133
169
* @availability stack stability=experimental
134
170
* @availability serverless stability=experimental
135
171
*/
136
172
bucket_count_ks_test ?: BucketKsAggregation
137
173
/**
174
+ * A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.
138
175
* @doc_id search-aggregations-bucket-correlation-aggregation
139
176
* @availability stack stability=experimental
140
177
* @availability serverless stability=experimental
141
178
*/
142
179
bucket_correlation ?: BucketCorrelationAggregation
180
+ /**
181
+ * A single-value metrics aggregation that calculates an approximate count of distinct values.
182
+ * @doc_id search-aggregations-metrics-cardinality-aggregation
183
+ */
143
184
cardinality ?: CardinalityAggregation
144
185
/**
186
+ * A multi-bucket aggregation that groups semi-structured text into buckets.
145
187
* @doc_id search-aggregations-bucket-categorize-text-aggregation
146
188
* @availability stack stability=experimental
147
189
* @availability serverless stability=experimental
148
190
*/
149
191
categorize_text ?: CategorizeTextAggregation
192
+ /**
193
+ * A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.
194
+ * @doc_id search-aggregations-bucket-children-aggregation
195
+ */
150
196
children ?: ChildrenAggregation
197
+ /**
198
+ * A multi-bucket aggregation that creates composite buckets from different sources.
199
+ * Unlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.
200
+ */
151
201
composite ?: CompositeAggregation
202
+ /**
203
+ * A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` (or `date_histogram`) aggregation.
204
+ * @doc_id search-aggregations-pipeline-cumulative-cardinality-aggregation
205
+ */
152
206
cumulative_cardinality ?: CumulativeCardinalityAggregation
207
+ /**
208
+ * A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` (or `date_histogram`) aggregation.
209
+ * @doc_id search-aggregations-pipeline-cumulative-sum-aggregation
210
+ */
153
211
cumulative_sum ?: CumulativeSumAggregation
212
+ /**
213
+ * A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.
214
+ * It dynamically builds fixed size (interval) buckets over the values.
215
+ * @doc_id search-aggregations-bucket-datehistogram-aggregation
216
+ */
154
217
date_histogram ?: DateHistogramAggregation
218
+ /**
219
+ * A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.
220
+ * @doc_id search-aggregations-bucket-daterange-aggregation
221
+ */
155
222
date_range ?: DateRangeAggregation
223
+ /**
224
+ * A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.
225
+ * @doc_id search-aggregations-pipeline-derivative-aggregation
226
+ */
156
227
derivative ?: DerivativeAggregation
228
+ /**
229
+ * A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.
230
+ * Similar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.
231
+ * @doc_id search-aggregations-bucket-diversified-sampler-aggregation
232
+ */
157
233
diversified_sampler ?: DiversifiedSamplerAggregation
234
+ /**
235
+ * A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.
236
+ * @doc_id search-aggregations-metrics-extendedstats-aggregation
237
+ */
158
238
extended_stats ?: ExtendedStatsAggregation
239
+ /**
240
+ * A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.
241
+ * @doc_id search-aggregations-pipeline-extended-stats-bucket-aggregation
242
+ */
159
243
extended_stats_bucket ?: ExtendedStatsBucketAggregation
244
+ /**
245
+ * A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.
246
+ * @doc_id search-aggregations-bucket-frequent-item-sets-aggregation
247
+ */
160
248
frequent_item_sets ?: FrequentItemSetsAggregation
249
+ /**
250
+ * A single bucket aggregation that narrows the set of documents to those that match a query.
251
+ * @doc_id search-aggregations-bucket-filter-aggregation
252
+ */
161
253
filter ?: QueryContainer
254
+ /**
255
+ * A multi-bucket aggregation where each bucket contains the documents that match a query.
256
+ */
162
257
filters ?: FiltersAggregation
163
258
geo_bounds ?: GeoBoundsAggregation
164
259
geo_centroid ?: GeoCentroidAggregation
0 commit comments