Split query DSL, analyzer, and aggregation sections and add more to a…

…nalyzer section (#4693) * Add analyzer documentation Signed-off-by: Fanit Kolchina <[email protected]> * Add index and search analyzer pages Signed-off-by: Fanit Kolchina <[email protected]> * Doc review comments Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * More doc review comments Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Implemented editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Update index-analyzers.md Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Aug 8, 2023 · a87fdc0 · a87fdc0
1 parent aed1d68
commit a87fdc0
Show file tree

Hide file tree

Showing 76 changed files with 624 additions and 276 deletions.
diff --git a/...l/aggregations/bucket/adjacency-matrix.md → _aggregations/bucket/adjacency-matrix.md b/...l/aggregations/bucket/adjacency-matrix.md → _aggregations/bucket/adjacency-matrix.md
@@ -4,6 +4,8 @@ title: Adjacency matrix
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 10
+redirect_from:
+  - /query-dsl/aggregations/bucket/adjacency-matrix/
 ---
 
 # Adjacency matrix aggregations

diff --git a/...dsl/aggregations/bucket/date-histogram.md → _aggregations/bucket/date-histogram.md b/...dsl/aggregations/bucket/date-histogram.md → _aggregations/bucket/date-histogram.md
@@ -4,6 +4,8 @@ title: Date histogram
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 20
+redirect_from:
+  - /query-dsl/aggregations/bucket/date-histogram/
 ---
 
 # Date histogram aggregations

diff --git a/_query-dsl/aggregations/bucket/date-range.md → _aggregations/bucket/date-range.md b/_query-dsl/aggregations/bucket/date-range.md → _aggregations/bucket/date-range.md
@@ -4,6 +4,8 @@ title: Date range
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 30
+redirect_from:
+  - /query-dsl/aggregations/bucket/date-range/
 ---
 
 # Date range aggregations

diff --git a/...ggregations/bucket/diversified-sampler.md → _aggregations/bucket/diversified-sampler.md b/...ggregations/bucket/diversified-sampler.md → _aggregations/bucket/diversified-sampler.md
@@ -4,6 +4,8 @@ title: Diversified sampler
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 40
+redirect_from:
+  - /query-dsl/aggregations/bucket/diversified-sampler/
 ---
 
 # Diversified sampler aggregations

diff --git a/_query-dsl/aggregations/bucket/filter.md → _aggregations/bucket/filter.md b/_query-dsl/aggregations/bucket/filter.md → _aggregations/bucket/filter.md
@@ -4,6 +4,8 @@ title: Filter
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 50
+redirect_from:
+  - /query-dsl/aggregations/bucket/filter/
 ---
 
 # Filter aggregations

diff --git a/_query-dsl/aggregations/bucket/filters.md → _aggregations/bucket/filters.md b/_query-dsl/aggregations/bucket/filters.md → _aggregations/bucket/filters.md
@@ -4,6 +4,8 @@ title: Filters
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 60
+redirect_from:
+  - /query-dsl/aggregations/bucket/filters/
 ---
 
 # Filters aggregations

diff --git a/...y-dsl/aggregations/bucket/geo-distance.md → _aggregations/bucket/geo-distance.md b/...y-dsl/aggregations/bucket/geo-distance.md → _aggregations/bucket/geo-distance.md
@@ -4,6 +4,8 @@ title: Geodistance
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 70
+redirect_from:
+  - /query-dsl/aggregations/bucket/geo-distance/
 ---
 
 # Geodistance aggregations

diff --git a/...y-dsl/aggregations/bucket/geohash-grid.md → _aggregations/bucket/geohash-grid.md b/...y-dsl/aggregations/bucket/geohash-grid.md → _aggregations/bucket/geohash-grid.md
@@ -4,6 +4,8 @@ title: Geohash grid
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 80
+redirect_from:
+  - /query-dsl/aggregations/bucket/geohash-grid/
 ---
 
 # Geohash grid aggregations

diff --git a/...ry-dsl/aggregations/bucket/geohex-grid.md → _aggregations/bucket/geohex-grid.md b/...ry-dsl/aggregations/bucket/geohex-grid.md → _aggregations/bucket/geohex-grid.md
@@ -7,6 +7,7 @@ nav_order: 85
 redirect_from:
   - /aggregations/geohexgrid/
   - /query-dsl/aggregations/geohexgrid/
+  - /query-dsl/aggregations/bucket/geohex-grid/
 ---
 
 # Geohex grid aggregations

diff --git a/...y-dsl/aggregations/bucket/geotile-grid.md → _aggregations/bucket/geotile-grid.md b/...y-dsl/aggregations/bucket/geotile-grid.md → _aggregations/bucket/geotile-grid.md
@@ -4,6 +4,8 @@ title: Geotile grid
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 87
+redirect_from:
+  - /query-dsl/aggregations/bucket/geotile-grid/
 ---
 
 # Geotile grid aggregations

diff --git a/_query-dsl/aggregations/bucket/global.md → _aggregations/bucket/global.md b/_query-dsl/aggregations/bucket/global.md → _aggregations/bucket/global.md
@@ -4,6 +4,8 @@ title: Global
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 90
+redirect_from:
+  - /query-dsl/aggregations/bucket/global/
 ---
 
 # Global aggregations

diff --git a/_query-dsl/aggregations/bucket/histogram.md → _aggregations/bucket/histogram.md b/_query-dsl/aggregations/bucket/histogram.md → _aggregations/bucket/histogram.md
@@ -4,6 +4,8 @@ title: Histogram
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 100
+redirect_from:
+  - /query-dsl/aggregations/bucket/histogram/
 ---
 
 # Histogram aggregations

diff --git a/_aggregations/bucket/index.md b/_aggregations/bucket/index.md
@@ -0,0 +1,45 @@
+---
+layout: default
+title: Bucket aggregations
+has_children: true
+has_toc: false
+nav_order: 3
+redirect_from:
+  - /opensearch/bucket-agg/
+  - /query-dsl/aggregations/bucket-agg/
+  - /query-dsl/aggregations/bucket/
+  - /aggregations/bucket-agg/
+---
+
+# Bucket aggregations
+
+Bucket aggregations categorize sets of documents as buckets. The type of bucket aggregation determines the bucket for a given document.
+
+You can use bucket aggregations to implement faceted navigation (usually placed as a sidebar on a search result landing page) to help your users filter the results.
+
+## Supported bucket aggregations
+
+OpenSearch supports the following bucket aggregations:
+
+- [Adjacency matrix]({{site.url}}{{site.baseurl}}/aggregations/bucket/adjacency-matrix/)
+- [Date histogram]({{site.url}}{{site.baseurl}}/aggregations/bucket/date-histogram/)
+- [Date range]({{site.url}}{{site.baseurl}}/aggregations/bucket/date-range/)
+- [Diversified sampler]({{site.url}}{{site.baseurl}}/aggregations/bucket/diversified-sampler/)
+- [Filter]({{site.url}}{{site.baseurl}}/aggregations/bucket/filter/)
+- [Filters]({{site.url}}{{site.baseurl}}/aggregations/bucket/filters/)
+- [Geodistance]({{site.url}}{{site.baseurl}}/aggregations/bucket/geo-distance/)
+- [Geohash grid]({{site.url}}{{site.baseurl}}/aggregations/bucket/geohash-grid/)
+- [Geohex grid]({{site.url}}{{site.baseurl}}/aggregations/bucket/geohex-grid/)
+- [Geotile grid]({{site.url}}{{site.baseurl}}/aggregations/bucket/geotile-grid/)
+- [Global]({{site.url}}{{site.baseurl}}/aggregations/bucket/global/)
+- [Histogram]({{site.url}}{{site.baseurl}}/aggregations/bucket/histogram/)
+- [IP range]({{site.url}}{{site.baseurl}}/aggregations/bucket/ip-range/)
+- [Missing]({{site.url}}{{site.baseurl}}/aggregations/bucket/missing/)
+- [Multi-terms]({{site.url}}{{site.baseurl}}/aggregations/bucket/multi-terms/)
+- [Nested]({{site.url}}{{site.baseurl}}/aggregations/bucket/nested/)
+- [Range]({{site.url}}{{site.baseurl}}/aggregations/bucket/range/)
+- [Reverse nested]({{site.url}}{{site.baseurl}}/aggregations/bucket/reverse-nested/)
+- [Sampler]({{site.url}}{{site.baseurl}}/aggregations/bucket/sampler/)
+- [Significant terms]({{site.url}}{{site.baseurl}}/aggregations/bucket/significant-terms/)
+- [Significant text]({{site.url}}{{site.baseurl}}/aggregations/bucket/significant-text/)
+- [Terms]({{site.url}}{{site.baseurl}}/aggregations/bucket/terms/)
diff --git a/_query-dsl/aggregations/bucket/ip-range.md → _aggregations/bucket/ip-range.md b/_query-dsl/aggregations/bucket/ip-range.md → _aggregations/bucket/ip-range.md
@@ -4,6 +4,8 @@ title: IP range
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 110
+redirect_from:
+  - /query-dsl/aggregations/bucket/ip-range/
 ---
 
 # IP range aggregations

diff --git a/_query-dsl/aggregations/bucket/missing.md → _aggregations/bucket/missing.md b/_query-dsl/aggregations/bucket/missing.md → _aggregations/bucket/missing.md
@@ -4,6 +4,8 @@ title: Missing
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 120
+redirect_from:
+  - /query-dsl/aggregations/bucket/missing/
 ---
 
 # Missing aggregations

diff --git a/...ry-dsl/aggregations/bucket/multi-terms.md → _aggregations/bucket/multi-terms.md b/...ry-dsl/aggregations/bucket/multi-terms.md → _aggregations/bucket/multi-terms.md
@@ -4,6 +4,8 @@ title: Multi-terms
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 130
+redirect_from:
+  - /query-dsl/aggregations/multi-terms/
 ---
 
 # Multi-terms aggregations

diff --git a/_query-dsl/aggregations/bucket/nested.md → _aggregations/bucket/nested.md b/_query-dsl/aggregations/bucket/nested.md → _aggregations/bucket/nested.md
@@ -4,6 +4,8 @@ title: Nested
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 140
+redirect_from:
+  - /query-dsl/aggregations/bucket/nested/
 ---
 
 # Nested aggregations

diff --git a/_query-dsl/aggregations/bucket/range.md → _aggregations/bucket/range.md b/_query-dsl/aggregations/bucket/range.md → _aggregations/bucket/range.md
@@ -4,6 +4,8 @@ title: Range
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 150
+redirect_from:
+  - /query-dsl/aggregations/bucket/range/
 ---
 
 # Range aggregations

diff --git a/...dsl/aggregations/bucket/reverse-nested.md → _aggregations/bucket/reverse-nested.md b/...dsl/aggregations/bucket/reverse-nested.md → _aggregations/bucket/reverse-nested.md
@@ -4,6 +4,8 @@ title: Reverse nested
 parent: Bucket aggregations
 grand_parent: Aggregations
 nav_order: 160
+redirect_from:
+  - /query-dsl/aggregations/bucket/reverse-nested/
 ---
 
 # Reverse nested aggregations

diff --git a/_query-dsl/aggregations/bucket/sampler.md → _aggregations/bucket/sampler.md b/_query-dsl/aggregations/bucket/sampler.md → _aggregations/bucket/sampler.md
diff --git a/.../aggregations/bucket/significant-terms.md → _aggregations/bucket/significant-terms.md b/.../aggregations/bucket/significant-terms.md → _aggregations/bucket/significant-terms.md
diff --git a/...l/aggregations/bucket/significant-text.md → _aggregations/bucket/significant-text.md b/...l/aggregations/bucket/significant-text.md → _aggregations/bucket/significant-text.md
diff --git a/_query-dsl/aggregations/bucket/terms.md → _aggregations/bucket/terms.md b/_query-dsl/aggregations/bucket/terms.md → _aggregations/bucket/terms.md
diff --git a/_query-dsl/aggregations/aggregations.md → _aggregations/index.md b/_query-dsl/aggregations/aggregations.md → _aggregations/index.md
@@ -3,9 +3,10 @@ layout: default
 title: Aggregations
 has_children: true
 nav_order: 5
-permalink: /aggregations/
+nav_exclude: true
 redirect_from:
   - /opensearch/aggregations/
+  - /query-dsl/aggregations/
 ---
 
 # Aggregations

diff --git a/_query-dsl/aggregations/metric/average.md → _aggregations/metric/average.md b/_query-dsl/aggregations/metric/average.md → _aggregations/metric/average.md
@@ -4,6 +4,8 @@ title: Average
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 10
+redirect_from:
+  - /query-dsl/aggregations/metric/average/
 ---
 
 # Average aggregations

diff --git a/...ry-dsl/aggregations/metric/cardinality.md → _aggregations/metric/cardinality.md b/...ry-dsl/aggregations/metric/cardinality.md → _aggregations/metric/cardinality.md
@@ -4,6 +4,8 @@ title: Cardinality
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 20
+redirect_from:
+  - /query-dsl/aggregations/metric/cardinality/
 ---
 
 # Cardinality aggregations

diff --git a/...dsl/aggregations/metric/extended-stats.md → _aggregations/metric/extended-stats.md b/...dsl/aggregations/metric/extended-stats.md → _aggregations/metric/extended-stats.md
@@ -4,6 +4,8 @@ title: Extended stats
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 30
+redirect_from:
+  - /query-dsl/aggregations/metric/extended-stats/
 ---
 
 # Extended stats aggregations

diff --git a/_query-dsl/aggregations/metric/geobounds.md → _aggregations/metric/geobounds.md b/_query-dsl/aggregations/metric/geobounds.md → _aggregations/metric/geobounds.md
@@ -4,6 +4,8 @@ title: Geobounds
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 40
+redirect_from:
+  - /query-dsl/aggregations/metric/geobounds/
 ---
 
 ## Geobounds aggregations

diff --git a/_aggregations/metric/index.md b/_aggregations/metric/index.md
@@ -0,0 +1,47 @@
+---
+layout: default
+title: Metric aggregations
+has_children: true
+has_toc: false
+nav_order: 2
+redirect_from:
+  - /opensearch/metric-agg/
+  - /query-dsl/aggregations/metric-agg/
+  - /aggregations/metric-agg/
+  - /query-dsl/aggregations/metric/
+---
+
+# Metric aggregations
+
+Metric aggregations let you perform simple calculations such as finding the minimum, maximum, and average values of a field.
+
+## Types of metric aggregations
+
+There are two types of metric aggregations: single-value metric aggregations and multi-value metric aggregations.
+
+### Single-value metric aggregations
+
+Single-value metric aggregations return a single metric, for example, `sum`, `min`, `max`, `avg`, `cardinality`, or `value_count`.
+
+### Multi-value metric aggregations
+
+Multi-value metric aggregations return more than one metric. These include `stats`, `extended_stats`, `matrix_stats`, `percentile`, `percentile_ranks`, `geo_bound`, `top_hits`, and `scripted_metric`.
+
+## Supported metric aggregations
+
+OpenSearch supports the following metric aggregations:
+
+- [Average]({{site.url}}{{site.baseurl}}/aggregations/metric/average/)
+- [Cardinality]({{site.url}}{{site.baseurl}}/aggregations/metric/cardinality/)
+- [Extended stats]({{site.url}}{{site.baseurl}}/aggregations/metric/extended-stats/)
+- [Geobounds]({{site.url}}{{site.baseurl}}/aggregations/metric/geobounds/)
+- [Matrix stats]({{site.url}}{{site.baseurl}}/aggregations/metric/matrix-stats/)
+- [Maximum]({{site.url}}{{site.baseurl}}/aggregations/metric/maximum/)
+- [Minimum]({{site.url}}{{site.baseurl}}/aggregations/metric/minimum/)
+- [Percentile ranks]({{site.url}}{{site.baseurl}}/aggregations/metric/percentile-ranks/)
+- [Percentile]({{site.url}}{{site.baseurl}}/aggregations/metric/percentile/)
+- [Scripted metric]({{site.url}}{{site.baseurl}}/aggregations/metric/scripted-metric/)
+- [Stats]({{site.url}}{{site.baseurl}}/aggregations/metric/stats/)
+- [Sum]({{site.url}}{{site.baseurl}}/aggregations/metric/sum/)
+- [Top hits]({{site.url}}{{site.baseurl}}/aggregations/metric/top-hits/)
+- [Value count]({{site.url}}{{site.baseurl}}/aggregations/metric/value-count/)
diff --git a/...y-dsl/aggregations/metric/matrix-stats.md → _aggregations/metric/matrix-stats.md b/...y-dsl/aggregations/metric/matrix-stats.md → _aggregations/metric/matrix-stats.md
@@ -4,6 +4,8 @@ title: Matrix stats
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 50
+redirect_from:
+  - /query-dsl/aggregations/metric/matrix-stats/
 ---
 
 # Matrix stats aggregations

diff --git a/_query-dsl/aggregations/metric/maximum.md → _aggregations/metric/maximum.md b/_query-dsl/aggregations/metric/maximum.md → _aggregations/metric/maximum.md
@@ -4,6 +4,8 @@ title: Maximum
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 60
+redirect_from:
+  - /query-dsl/aggregations/metric/maximum/
 ---
 
 # Maximum aggregations

diff --git a/_query-dsl/aggregations/metric/minimum.md → _aggregations/metric/minimum.md b/_query-dsl/aggregations/metric/minimum.md → _aggregations/metric/minimum.md
@@ -4,6 +4,8 @@ title: Minimum
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 70
+redirect_from:
+  - /query-dsl/aggregations/metric/minimum/
 ---
 
 # Minimum aggregations

diff --git a/...l/aggregations/metric/percentile-ranks.md → _aggregations/metric/percentile-ranks.md b/...l/aggregations/metric/percentile-ranks.md → _aggregations/metric/percentile-ranks.md
@@ -4,6 +4,8 @@ title: Percentile ranks
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 80
+redirect_from:
+  - /query-dsl/aggregations/metric/percentile-ranks/
 ---
 
 # Percentile rank aggregations

diff --git a/_query-dsl/aggregations/metric/percentile.md → _aggregations/metric/percentile.md b/_query-dsl/aggregations/metric/percentile.md → _aggregations/metric/percentile.md
@@ -4,6 +4,8 @@ title: Percentile
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 90
+redirect_from:
+  - /query-dsl/aggregations/metric/percentile/
 ---
 
 # Percentile aggregations

diff --git a/...sl/aggregations/metric/scripted-metric.md → _aggregations/metric/scripted-metric.md b/...sl/aggregations/metric/scripted-metric.md → _aggregations/metric/scripted-metric.md
@@ -4,6 +4,8 @@ title: Scripted metric
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 100
+redirect_from:
+  - /query-dsl/aggregations/metric/scripted-metric/
 ---
 
 # Scripted metric aggregations

diff --git a/_query-dsl/aggregations/metric/stats.md → _aggregations/metric/stats.md b/_query-dsl/aggregations/metric/stats.md → _aggregations/metric/stats.md
@@ -1,9 +1,11 @@
 ---
 layout: default
-title: Stats aggregations
+title: Stats
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 110
+redirect_from:
+  - /query-dsl/aggregations/metric/stats/
 ---
 
 # Stats aggregations

diff --git a/_query-dsl/aggregations/metric/sum.md → _aggregations/metric/sum.md b/_query-dsl/aggregations/metric/sum.md → _aggregations/metric/sum.md
@@ -4,6 +4,8 @@ title: Sum
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 120
+redirect_from:
+  - /query-dsl/aggregations/metric/sum/
 ---
 
 # Sum aggregations

diff --git a/_query-dsl/aggregations/metric/top-hits.md → _aggregations/metric/top-hits.md b/_query-dsl/aggregations/metric/top-hits.md → _aggregations/metric/top-hits.md
@@ -4,6 +4,8 @@ title: Top hits
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 130
+redirect_from:
+  - /query-dsl/aggregations/metric/top-hits/
 ---
 
 # Top hits aggregations

diff --git a/...ry-dsl/aggregations/metric/value-count.md → _aggregations/metric/value-count.md b/...ry-dsl/aggregations/metric/value-count.md → _aggregations/metric/value-count.md
@@ -4,6 +4,8 @@ title: Value count
 parent: Metric aggregations
 grand_parent: Aggregations
 nav_order: 140
+redirect_from:
+  - /query-dsl/aggregations/metric/value-count/
 ---
 
 # Value count aggregations