Skip to content

Commit 6a340c7

Browse files
[DOCS] Add descriptions for aggs A-F (#2225)
1 parent 02f092b commit 6a340c7

File tree

7 files changed

+651
-135
lines changed

7 files changed

+651
-135
lines changed

output/schema/schema.json

Lines changed: 287 additions & 134 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -463,4 +463,25 @@ query-dsl-terms-query,https://www.elastic.co/guide/en/elasticsearch/reference/{b
463463
query-dsl-terms-set-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-set-query.html
464464
query-dsl-text-expansion-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-text-expansion-query.html
465465
query-dsl-wildcard-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html
466-
query-dsl-wrapper-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html
466+
query-dsl-wrapper-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html
467+
search-aggregations-bucket-adjacency-matrix-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-adjacency-matrix-aggregation.html
468+
search-aggregations-bucket-autodatehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html
469+
search-aggregations-metrics-avg-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-avg-aggregation.html
470+
search-aggregations-pipeline-avg-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-avg-bucket-aggregation.html
471+
gap-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#gap-policy
472+
search-aggregations-metrics-boxplot-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-boxplot-aggregation.html
473+
search-aggregations-pipeline-bucket-script-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-script-aggregation.html
474+
search-aggregations-pipeline-bucket-selector-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-selector-aggregation.html
475+
search-aggregations-pipeline-bucket-sort-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-sort-aggregation.html
476+
search-aggregations-metrics-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-cardinality-aggregation.html
477+
search-aggregations-bucket-children-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-children-aggregation.html
478+
search-aggregations-pipeline-cumulative-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-cardinality-aggregation.html
479+
search-aggregations-pipeline-cumulative-sum-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-sum-aggregation.html
480+
search-aggregations-bucket-datehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html
481+
search-aggregations-bucket-daterange-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-daterange-aggregation.html
482+
search-aggregations-pipeline-derivative-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-derivative-aggregation.html
483+
search-aggregations-bucket-diversified-sampler-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-diversified-sampler-aggregation.html
484+
search-aggregations-metrics-extendedstats-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-extendedstats-aggregation.html
485+
search-aggregations-pipeline-extended-stats-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-extended-stats-bucket-aggregation.html
486+
search-aggregations-bucket-frequent-item-sets-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-frequent-item-sets-aggregation.html
487+
search-aggregations-bucket-filter-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filter-aggregation.html

specification/_types/aggregations/AggregationContainer.ts

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,45 +120,140 @@ export class AggregationContainer {
120120
*/
121121
meta?: Metadata
122122

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+
*/
123129
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+
*/
124134
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+
*/
125139
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+
*/
126145
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+
*/
127150
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+
*/
128155
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+
*/
129160
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+
*/
130165
bucket_sort?: BucketSortAggregation
131166
/**
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.
132168
* @doc_id search-aggregations-bucket-count-ks-test-aggregation
133169
* @availability stack stability=experimental
134170
* @availability serverless stability=experimental
135171
*/
136172
bucket_count_ks_test?: BucketKsAggregation
137173
/**
174+
* A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.
138175
* @doc_id search-aggregations-bucket-correlation-aggregation
139176
* @availability stack stability=experimental
140177
* @availability serverless stability=experimental
141178
*/
142179
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+
*/
143184
cardinality?: CardinalityAggregation
144185
/**
186+
* A multi-bucket aggregation that groups semi-structured text into buckets.
145187
* @doc_id search-aggregations-bucket-categorize-text-aggregation
146188
* @availability stack stability=experimental
147189
* @availability serverless stability=experimental
148190
*/
149191
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+
*/
150196
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+
*/
151201
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+
*/
152206
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+
*/
153211
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+
*/
154217
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+
*/
155222
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+
*/
156227
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+
*/
157233
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+
*/
158238
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+
*/
159243
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+
*/
160248
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+
*/
161253
filter?: QueryContainer
254+
/**
255+
* A multi-bucket aggregation where each bucket contains the documents that match a query.
256+
*/
162257
filters?: FiltersAggregation
163258
geo_bounds?: GeoBoundsAggregation
164259
geo_centroid?: GeoCentroidAggregation

0 commit comments

Comments
 (0)