Skip to content

Commit

Permalink
[DOCS] Add descriptions for aggs A-F (#2225)
Browse files Browse the repository at this point in the history
  • Loading branch information
abdonpijpelink authored Aug 4, 2023
1 parent 02f092b commit 6a340c7
Show file tree
Hide file tree
Showing 7 changed files with 651 additions and 135 deletions.
421 changes: 287 additions & 134 deletions output/schema/schema.json

Large diffs are not rendered by default.

23 changes: 22 additions & 1 deletion specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -463,4 +463,25 @@ query-dsl-terms-query,https://www.elastic.co/guide/en/elasticsearch/reference/{b
query-dsl-terms-set-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-set-query.html
query-dsl-text-expansion-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-text-expansion-query.html
query-dsl-wildcard-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html
query-dsl-wrapper-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html
query-dsl-wrapper-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html
search-aggregations-bucket-adjacency-matrix-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-adjacency-matrix-aggregation.html
search-aggregations-bucket-autodatehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html
search-aggregations-metrics-avg-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-avg-aggregation.html
search-aggregations-pipeline-avg-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-avg-bucket-aggregation.html
gap-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#gap-policy
search-aggregations-metrics-boxplot-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-boxplot-aggregation.html
search-aggregations-pipeline-bucket-script-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-script-aggregation.html
search-aggregations-pipeline-bucket-selector-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-selector-aggregation.html
search-aggregations-pipeline-bucket-sort-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-sort-aggregation.html
search-aggregations-metrics-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-cardinality-aggregation.html
search-aggregations-bucket-children-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-children-aggregation.html
search-aggregations-pipeline-cumulative-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-cardinality-aggregation.html
search-aggregations-pipeline-cumulative-sum-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-sum-aggregation.html
search-aggregations-bucket-datehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html
search-aggregations-bucket-daterange-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-daterange-aggregation.html
search-aggregations-pipeline-derivative-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-derivative-aggregation.html
search-aggregations-bucket-diversified-sampler-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-diversified-sampler-aggregation.html
search-aggregations-metrics-extendedstats-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-extendedstats-aggregation.html
search-aggregations-pipeline-extended-stats-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-extended-stats-bucket-aggregation.html
search-aggregations-bucket-frequent-item-sets-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-frequent-item-sets-aggregation.html
search-aggregations-bucket-filter-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filter-aggregation.html
95 changes: 95 additions & 0 deletions specification/_types/aggregations/AggregationContainer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,45 +120,140 @@ export class AggregationContainer {
*/
meta?: Metadata

/**
* A bucket aggregation returning a form of adjacency matrix.
* The request provides a collection of named filter expressions, similar to the filters aggregation request.
* Each bucket in the response represents a non-empty cell in the matrix of intersecting filters.
* @doc_id search-aggregations-bucket-adjacency-matrix-aggregation
*/
adjacency_matrix?: AdjacencyMatrixAggregation
/**
* 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.
* @doc_id search-aggregations-bucket-autodatehistogram-aggregation
*/
auto_date_histogram?: AutoDateHistogramAggregation
/**
* A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.
* @doc_id search-aggregations-metrics-avg-aggregation
*/
avg?: AverageAggregation
/**
* A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.
* The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.
* @doc_id search-aggregations-pipeline-avg-bucket-aggregation
*/
avg_bucket?: AverageBucketAggregation
/**
* A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.
* @doc_id search-aggregations-metrics-boxplot-aggregation
*/
boxplot?: BoxplotAggregation
/**
* A parent pipeline aggregation which runs a script which can perform per bucket computations on specified metrics in the parent multi-bucket aggregation.
* @doc_id search-aggregations-pipeline-bucket-script-aggregation
*/
bucket_script?: BucketScriptAggregation
/**
* A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.
* @doc_id search-aggregations-pipeline-bucket-selector-aggregation
*/
bucket_selector?: BucketSelectorAggregation
/**
* A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.
* @doc_id search-aggregations-pipeline-bucket-sort-aggregation
*/
bucket_sort?: BucketSortAggregation
/**
* 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.
* @doc_id search-aggregations-bucket-count-ks-test-aggregation
* @availability stack stability=experimental
* @availability serverless stability=experimental
*/
bucket_count_ks_test?: BucketKsAggregation
/**
* A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.
* @doc_id search-aggregations-bucket-correlation-aggregation
* @availability stack stability=experimental
* @availability serverless stability=experimental
*/
bucket_correlation?: BucketCorrelationAggregation
/**
* A single-value metrics aggregation that calculates an approximate count of distinct values.
* @doc_id search-aggregations-metrics-cardinality-aggregation
*/
cardinality?: CardinalityAggregation
/**
* A multi-bucket aggregation that groups semi-structured text into buckets.
* @doc_id search-aggregations-bucket-categorize-text-aggregation
* @availability stack stability=experimental
* @availability serverless stability=experimental
*/
categorize_text?: CategorizeTextAggregation
/**
* A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.
* @doc_id search-aggregations-bucket-children-aggregation
*/
children?: ChildrenAggregation
/**
* A multi-bucket aggregation that creates composite buckets from different sources.
* Unlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.
*/
composite?: CompositeAggregation
/**
* A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` (or `date_histogram`) aggregation.
* @doc_id search-aggregations-pipeline-cumulative-cardinality-aggregation
*/
cumulative_cardinality?: CumulativeCardinalityAggregation
/**
* A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` (or `date_histogram`) aggregation.
* @doc_id search-aggregations-pipeline-cumulative-sum-aggregation
*/
cumulative_sum?: CumulativeSumAggregation
/**
* A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.
* It dynamically builds fixed size (interval) buckets over the values.
* @doc_id search-aggregations-bucket-datehistogram-aggregation
*/
date_histogram?: DateHistogramAggregation
/**
* A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.
* @doc_id search-aggregations-bucket-daterange-aggregation
*/
date_range?: DateRangeAggregation
/**
* A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.
* @doc_id search-aggregations-pipeline-derivative-aggregation
*/
derivative?: DerivativeAggregation
/**
* A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.
* Similar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.
* @doc_id search-aggregations-bucket-diversified-sampler-aggregation
*/
diversified_sampler?: DiversifiedSamplerAggregation
/**
* A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.
* @doc_id search-aggregations-metrics-extendedstats-aggregation
*/
extended_stats?: ExtendedStatsAggregation
/**
* A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.
* @doc_id search-aggregations-pipeline-extended-stats-bucket-aggregation
*/
extended_stats_bucket?: ExtendedStatsBucketAggregation
/**
* A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.
* @doc_id search-aggregations-bucket-frequent-item-sets-aggregation
*/
frequent_item_sets?: FrequentItemSetsAggregation
/**
* A single bucket aggregation that narrows the set of documents to those that match a query.
* @doc_id search-aggregations-bucket-filter-aggregation
*/
filter?: QueryContainer
/**
* A multi-bucket aggregation where each bucket contains the documents that match a query.
*/
filters?: FiltersAggregation
geo_bounds?: GeoBoundsAggregation
geo_centroid?: GeoCentroidAggregation
Expand Down
Loading

0 comments on commit 6a340c7

Please sign in to comment.