WIP better generated API reference docs

.gitignore

@@ -72,3 +72,4 @@ rest-api-spec
 yaml-rest-tests
 generated-tests
 schema
+api-extractor/*

.npmignore

@@ -8,23 +8,22 @@ pids
 *.pid
 *.seed
 
-# Directory for instrumented libs generated by jscoverage/JSCover
+# unit testing and coverage artifacts
 lib-cov
-
-# Coverage directory used by tools like istanbul
 coverage
-
-# coverage output
 coverage.lcov
-
-# nyc test coverage
 .nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
+.tap
+rest-api-spec
+yaml-rest-tests
+generated-tests
+junit-output
 
-# node-waf configuration
+# lock files
 .lock-wscript
+package-lock.json
+bun.lockb
 
 # Compiled binary addons (http://nodejs.org/api/addons.html)
 build/Release
@@ -45,8 +44,6 @@ jspm_packages
 # vim swap files
 *.swp
 
-package-lock.json
-
 # elasticsearch repo or binary files
 elasticsearch*
 
@@ -54,8 +51,11 @@ elasticsearch*
 # because we should copy them in the main .d.ts file
 api/generated.d.ts
 
-# Ignore doc folder
+# documentation
 docs
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+CHANGELOG.md
 
 # Ignore test folder
 test
@@ -68,12 +68,14 @@ scripts
 .buildkite
 certs
 .github
-CODE_OF_CONDUCT.md
-CONTRIBUTING.md
 
+# Uncompiled source
 src
-bun.lockb
-.tap
-rest-api-spec
-yaml-rest-tests
-generated-tests
+
+# repo configurations
+.dockerignore
+.gitignore
+catalog-info.yaml
+codecov.yml
+renovate.json
+tsconfig.json

api-extractor.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/lib/client.d.ts",
+  "bundledPackages": [
+    "@elastic/elasticsearch"
+  ],
+  "apiReport": {
+    "enabled": false
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json",
+    "includeForgottenExports": true
+  },
+  "dtsRollup": {
+    "enabled": false
+  },
+  "tsdocMetadata": {
+    "enabled": true,
+    "tsdocMetadataFilePath": "<projectFolder>/api-extractor/tsdoc-metadata.json"
+  },
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    }
+  }
+}

docs/reference/api/API.md

@@ -0,0 +1,90 @@
+## Interface `API`
+
+| Name | Type | Description |
+| - | - | - |
+| `asyncSearch` | [AsyncSearchApi](./AsyncSearchApi.md) |   |
+| `autoscaling` | [AutoscalingApi](./AutoscalingApi.md) |   |
+| `bulk` | typeof [bulkApi](./bulkApi.md) |   |
+| `capabilities` | typeof [capabilitiesApi](./capabilitiesApi.md) |   |
+| `cat` | [CatApi](./CatApi.md) |   |
+| `ccr` | [CcrApi](./CcrApi.md) |   |
+| `clearScroll` | typeof [clearScrollApi](./clearScrollApi.md) |   |
+| `closePointInTime` | typeof [closePointInTimeApi](./closePointInTimeApi.md) |   |
+| `cluster` | [ClusterApi](./ClusterApi.md) |   |
+| `connector` | [ConnectorApi](./ConnectorApi.md) |   |
+| `count` | typeof [countApi](./countApi.md) |   |
+| `create` | typeof [createApi](./createApi.md) |   |
+| `danglingIndices` | [DanglingIndicesApi](./DanglingIndicesApi.md) |   |
+| `delete` | typeof [deleteApi](./deleteApi.md) |   |
+| `deleteByQuery` | typeof [deleteByQueryApi](./deleteByQueryApi.md) |   |
+| `deleteByQueryRethrottle` | typeof [deleteByQueryRethrottleApi](./deleteByQueryRethrottleApi.md) |   |
+| `deleteScript` | typeof [deleteScriptApi](./deleteScriptApi.md) |   |
+| `enrich` | [EnrichApi](./EnrichApi.md) |   |
+| `eql` | [EqlApi](./EqlApi.md) |   |
+| `esql` | [EsqlApi](./EsqlApi.md) |   |
+| `exists` | typeof [existsApi](./existsApi.md) |   |
+| `existsSource` | typeof [existsSourceApi](./existsSourceApi.md) |   |
+| `explain` | typeof [explainApi](./explainApi.md) |   |
+| `features` | [FeaturesApi](./FeaturesApi.md) |   |
+| `fieldCaps` | typeof [fieldCapsApi](./fieldCapsApi.md) |   |
+| `fleet` | [FleetApi](./FleetApi.md) |   |
+| `get` | typeof [getApi](./getApi.md) |   |
+| `getScript` | typeof [getScriptApi](./getScriptApi.md) |   |
+| `getScriptContext` | typeof [getScriptContextApi](./getScriptContextApi.md) |   |
+| `getScriptLanguages` | typeof [getScriptLanguagesApi](./getScriptLanguagesApi.md) |   |
+| `getSource` | typeof [getSourceApi](./getSourceApi.md) |   |
+| `graph` | [GraphApi](./GraphApi.md) |   |
+| `healthReport` | typeof [healthReportApi](./healthReportApi.md) |   |
+| `ilm` | [IlmApi](./IlmApi.md) |   |
+| `index` | typeof [indexApi](./indexApi.md) |   |
+| `indices` | [IndicesApi](./IndicesApi.md) |   |
+| `inference` | [InferenceApi](./InferenceApi.md) |   |
+| `info` | typeof [infoApi](./infoApi.md) |   |
+| `ingest` | [IngestApi](./IngestApi.md) |   |
+| `knnSearch` | typeof [knnSearchApi](./knnSearchApi.md) |   |
+| `license` | [LicenseApi](./LicenseApi.md) |   |
+| `logstash` | [LogstashApi](./LogstashApi.md) |   |
+| `mget` | typeof [mgetApi](./mgetApi.md) |   |
+| `migration` | [MigrationApi](./MigrationApi.md) |   |
+| `ml` | [MlApi](./MlApi.md) |   |
+| `monitoring` | [MonitoringApi](./MonitoringApi.md) |   |
+| `msearch` | typeof [msearchApi](./msearchApi.md) |   |
+| `msearchTemplate` | typeof [msearchTemplateApi](./msearchTemplateApi.md) |   |
+| `mtermvectors` | typeof [mtermvectorsApi](./mtermvectorsApi.md) |   |
+| `nodes` | [NodesApi](./NodesApi.md) |   |
+| `openPointInTime` | typeof [openPointInTimeApi](./openPointInTimeApi.md) |   |
+| `ping` | typeof [pingApi](./pingApi.md) |   |
+| `profiling` | [ProfilingApi](./ProfilingApi.md) |   |
+| `putScript` | typeof [putScriptApi](./putScriptApi.md) |   |
+| `queryRules` | [QueryRulesApi](./QueryRulesApi.md) |   |
+| `rankEval` | typeof [rankEvalApi](./rankEvalApi.md) |   |
+| `reindex` | typeof [reindexApi](./reindexApi.md) |   |
+| `reindexRethrottle` | typeof [reindexRethrottleApi](./reindexRethrottleApi.md) |   |
+| `renderSearchTemplate` | typeof [renderSearchTemplateApi](./renderSearchTemplateApi.md) |   |
+| `rollup` | [RollupApi](./RollupApi.md) |   |
+| `scriptsPainlessExecute` | typeof [scriptsPainlessExecuteApi](./scriptsPainlessExecuteApi.md) |   |
+| `scroll` | typeof [scrollApi](./scrollApi.md) |   |
+| `search` | typeof [searchApi](./searchApi.md) |   |
+| `searchableSnapshots` | [SearchableSnapshotsApi](./SearchableSnapshotsApi.md) |   |
+| `searchApplication` | [SearchApplicationApi](./SearchApplicationApi.md) |   |
+| `searchMvt` | typeof [searchMvtApi](./searchMvtApi.md) |   |
+| `searchShards` | typeof [searchShardsApi](./searchShardsApi.md) |   |
+| `searchTemplate` | typeof [searchTemplateApi](./searchTemplateApi.md) |   |
+| `security` | [SecurityApi](./SecurityApi.md) |   |
+| `shutdown` | [ShutdownApi](./ShutdownApi.md) |   |
+| `simulate` | [SimulateApi](./SimulateApi.md) |   |
+| `slm` | [SlmApi](./SlmApi.md) |   |
+| `snapshot` | [SnapshotApi](./SnapshotApi.md) |   |
+| `sql` | [SqlApi](./SqlApi.md) |   |
+| `ssl` | [SslApi](./SslApi.md) |   |
+| `synonyms` | [SynonymsApi](./SynonymsApi.md) |   |
+| `tasks` | [TasksApi](./TasksApi.md) |   |
+| `termsEnum` | typeof [termsEnumApi](./termsEnumApi.md) |   |
+| `termvectors` | typeof [termvectorsApi](./termvectorsApi.md) |   |
+| `textStructure` | [TextStructureApi](./TextStructureApi.md) |   |
+| `transform` | [TransformApi](./TransformApi.md) |   |
+| `update` | typeof [updateApi](./updateApi.md) |   |
+| `updateByQuery` | typeof [updateByQueryApi](./updateByQueryApi.md) |   |
+| `updateByQueryRethrottle` | typeof [updateByQueryRethrottleApi](./updateByQueryRethrottleApi.md) |   |
+| `watcher` | [WatcherApi](./WatcherApi.md) |   |
+| `xpack` | [XpackApi](./XpackApi.md) |   |

docs/reference/api/AcknowledgedResponseBase.md

@@ -0,0 +1,5 @@
+## Interface `AcknowledgedResponseBase`
+
+| Name | Type | Description |
+| - | - | - |
+| `acknowledged` | boolean | For a successful response, this value is always true. On failure, an exception is returned instead. |

docs/reference/api/Action.md

@@ -0,0 +1,4 @@
+## `Action`
+:::
+type Action = [IndexAction](./IndexAction.md) | [CreateAction](./CreateAction.md) | [UpdateAction](./UpdateAction.md) | [DeleteAction](./DeleteAction.md);
+:::

docs/reference/api/AggregateName.md

@@ -0,0 +1,4 @@
+## `AggregateName`
+:::
+type AggregateName = string;
+:::

docs/reference/api/AggregationsAdjacencyMatrixAggregate.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsAdjacencyMatrixAggregate`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsAdjacencyMatrixAggregation.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsAdjacencyMatrixAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `filters` | Record<string, [QueryDslQueryContainer](./QueryDslQueryContainer.md)> | Filters used to create buckets. At least one filter is required. |
+| `separator` | string | Separator used to concatenate filter names. Defaults to &. |

docs/reference/api/AggregationsAdjacencyMatrixBucket.md

@@ -0,0 +1,4 @@
+## `AggregationsAdjacencyMatrixBucket`
+:::
+type AggregationsAdjacencyMatrixBucket = [AggregationsAdjacencyMatrixBucketKeys](./AggregationsAdjacencyMatrixBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [long](./long.md);};
+:::

docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsAdjacencyMatrixBucketKeys`
+
+| Name | Type | Description |
+| - | - | - |
+| `key` | string |   |

docs/reference/api/AggregationsAggregateBase.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsAggregateBase`
+
+| Name | Type | Description |
+| - | - | - |
+| `meta` | [Metadata](./Metadata.md) |   |

docs/reference/api/AggregationsAggregateOrder.md

@@ -0,0 +1,4 @@
+## `AggregationsAggregateOrder`
+:::
+type AggregationsAggregateOrder = [Partial](./Partial.md)<Record<[Field](./Field.md), [SortOrder](./SortOrder.md)>> | [Partial](./Partial.md)<Record<[Field](./Field.md), [SortOrder](./SortOrder.md)>>[];
+:::

docs/reference/api/AggregationsAggregation.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsAggregation`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsAggregationContainer.md

@@ -0,0 +1,85 @@
+## Interface `AggregationsAggregationContainer`
+
+| Name | Type | Description |
+| - | - | - |
+| `adjacency_matrix` | [AggregationsAdjacencyMatrixAggregation](./AggregationsAdjacencyMatrixAggregation.md) | A bucket aggregation returning a form of adjacency matrix. The request provides a collection of named filter expressions, similar to the `filters` aggregation. Each bucket in the response represents a non-empty cell in the matrix of intersecting filters. |
+| `aggregations` | Record<string, [AggregationsAggregationContainer](./AggregationsAggregationContainer.md)> | Sub-aggregations for this aggregation. Only applies to bucket aggregations. |
+| `aggs` | Record<string, [AggregationsAggregationContainer](./AggregationsAggregationContainer.md)> | Sub-aggregations for this aggregation. Only applies to bucket aggregations. aggregations |
+| `auto_date_histogram` | [AggregationsAutoDateHistogramAggregation](./AggregationsAutoDateHistogramAggregation.md) | 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. |
+| `avg_bucket` | [AggregationsAverageBucketAggregation](./AggregationsAverageBucketAggregation.md) | 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. |
+| `avg` | [AggregationsAverageAggregation](./AggregationsAverageAggregation.md) | A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents. |
+| `boxplot` | [AggregationsBoxplotAggregation](./AggregationsBoxplotAggregation.md) | A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents. |
+| `bucket_correlation` | [AggregationsBucketCorrelationAggregation](./AggregationsBucketCorrelationAggregation.md) | A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation. |
+| `bucket_count_ks_test` | [AggregationsBucketKsAggregation](./AggregationsBucketKsAggregation.md) | 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. |
+| `bucket_script` | [AggregationsBucketScriptAggregation](./AggregationsBucketScriptAggregation.md) | A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation. |
+| `bucket_selector` | [AggregationsBucketSelectorAggregation](./AggregationsBucketSelectorAggregation.md) | A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation. |
+| `bucket_sort` | [AggregationsBucketSortAggregation](./AggregationsBucketSortAggregation.md) | A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation. |
+| `cardinality` | [AggregationsCardinalityAggregation](./AggregationsCardinalityAggregation.md) | A single-value metrics aggregation that calculates an approximate count of distinct values. |
+| `categorize_text` | [AggregationsCategorizeTextAggregation](./AggregationsCategorizeTextAggregation.md) | A multi-bucket aggregation that groups semi-structured text into buckets. |
+| `children` | [AggregationsChildrenAggregation](./AggregationsChildrenAggregation.md) | A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field. |
+| `composite` | [AggregationsCompositeAggregation](./AggregationsCompositeAggregation.md) | 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. |
+| `cumulative_cardinality` | [AggregationsCumulativeCardinalityAggregation](./AggregationsCumulativeCardinalityAggregation.md) | A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation. |
+| `cumulative_sum` | [AggregationsCumulativeSumAggregation](./AggregationsCumulativeSumAggregation.md) | A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation. |
+| `date_histogram` | [AggregationsDateHistogramAggregation](./AggregationsDateHistogramAggregation.md) | 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. |
+| `date_range` | [AggregationsDateRangeAggregation](./AggregationsDateRangeAggregation.md) | A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket. |
+| `derivative` | [AggregationsDerivativeAggregation](./AggregationsDerivativeAggregation.md) | A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation. |
+| `diversified_sampler` | [AggregationsDiversifiedSamplerAggregation](./AggregationsDiversifiedSamplerAggregation.md) | 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. |
+| `extended_stats_bucket` | [AggregationsExtendedStatsBucketAggregation](./AggregationsExtendedStatsBucketAggregation.md) | A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. |
+| `extended_stats` | [AggregationsExtendedStatsAggregation](./AggregationsExtendedStatsAggregation.md) | A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents. |
+| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A single bucket aggregation that narrows the set of documents to those that match a query. |
+| `filters` | [AggregationsFiltersAggregation](./AggregationsFiltersAggregation.md) | A multi-bucket aggregation where each bucket contains the documents that match a query. |
+| `frequent_item_sets` | [AggregationsFrequentItemSetsAggregation](./AggregationsFrequentItemSetsAggregation.md) | A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together. |
+| `geo_bounds` | [AggregationsGeoBoundsAggregation](./AggregationsGeoBoundsAggregation.md) | A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field. |
+| `geo_centroid` | [AggregationsGeoCentroidAggregation](./AggregationsGeoCentroidAggregation.md) | A metric aggregation that computes the weighted centroid from all coordinate values for geo fields. |
+| `geo_distance` | [AggregationsGeoDistanceAggregation](./AggregationsGeoDistanceAggregation.md) | A multi-bucket aggregation that works on `geo_point` fields. Evaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request. |
+| `geo_line` | [AggregationsGeoLineAggregation](./AggregationsGeoLineAggregation.md) | Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field. |
+| `geohash_grid` | [AggregationsGeoHashGridAggregation](./AggregationsGeoHashGridAggregation.md) | A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell is labeled using a geohash which is of user-definable precision. |
+| `geohex_grid` | [AggregationsGeohexGridAggregation](./AggregationsGeohexGridAggregation.md) | A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell corresponds to a H3 cell index and is labeled using the H3Index representation. |
+| `geotile_grid` | [AggregationsGeoTileGridAggregation](./AggregationsGeoTileGridAggregation.md) | A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell corresponds to a map tile as used by many online map sites. |
+| `global` | [AggregationsGlobalAggregation](./AggregationsGlobalAggregation.md) | Defines a single bucket of all the documents within the search execution context. This context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself. |
+| `histogram` | [AggregationsHistogramAggregation](./AggregationsHistogramAggregation.md) | A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents. It dynamically builds fixed size (interval) buckets over the values. |
+| `inference` | [AggregationsInferenceAggregation](./AggregationsInferenceAggregation.md) | A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation. |
+| `ip_prefix` | [AggregationsIpPrefixAggregation](./AggregationsIpPrefixAggregation.md) | A bucket aggregation that groups documents based on the network or sub-network of an IP address. |
+| `ip_range` | [AggregationsIpRangeAggregation](./AggregationsIpRangeAggregation.md) | A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket. |
+| `line` | [AggregationsGeoLineAggregation](./AggregationsGeoLineAggregation.md) | &nbsp; |
+| `matrix_stats` | [AggregationsMatrixStatsAggregation](./AggregationsMatrixStatsAggregation.md) | A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`. |
+| `max_bucket` | [AggregationsMaxBucketAggregation](./AggregationsMaxBucketAggregation.md) | A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s). |
+| `max` | [AggregationsMaxAggregation](./AggregationsMaxAggregation.md) | A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents. |
+| `median_absolute_deviation` | [AggregationsMedianAbsoluteDeviationAggregation](./AggregationsMedianAbsoluteDeviationAggregation.md) | A single-value aggregation that approximates the median absolute deviation of its search results. |
+| `meta` | [Metadata](./Metadata.md) | &nbsp; |
+| `min_bucket` | [AggregationsMinBucketAggregation](./AggregationsMinBucketAggregation.md) | A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s). |
+| `min` | [AggregationsMinAggregation](./AggregationsMinAggregation.md) | A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents. |
+| `missing` | [AggregationsMissingAggregation](./AggregationsMissingAggregation.md) | A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set). |
+| `moving_avg` | [AggregationsMovingAverageAggregation](./AggregationsMovingAverageAggregation.md) | &nbsp; |
+| `moving_fn` | [AggregationsMovingFunctionAggregation](./AggregationsMovingFunctionAggregation.md) | Given an ordered series of data, "slides" a window across the data and runs a custom script on each window of data. For convenience, a number of common functions are predefined such as `min`, `max`, and moving averages. |
+| `moving_percentiles` | [AggregationsMovingPercentilesAggregation](./AggregationsMovingPercentilesAggregation.md) | Given an ordered series of percentiles, "slides" a window across those percentiles and computes cumulative percentiles. |
+| `multi_terms` | [AggregationsMultiTermsAggregation](./AggregationsMultiTermsAggregation.md) | A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values. |
+| `nested` | [AggregationsNestedAggregation](./AggregationsNestedAggregation.md) | A special single bucket aggregation that enables aggregating nested documents. |
+| `normalize` | [AggregationsNormalizeAggregation](./AggregationsNormalizeAggregation.md) | A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value. |
+| `parent` | [AggregationsParentAggregation](./AggregationsParentAggregation.md) | A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field. |
+| `percentile_ranks` | [AggregationsPercentileRanksAggregation](./AggregationsPercentileRanksAggregation.md) | A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents. |
+| `percentiles_bucket` | [AggregationsPercentilesBucketAggregation](./AggregationsPercentilesBucketAggregation.md) | A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation. |
+| `percentiles` | [AggregationsPercentilesAggregation](./AggregationsPercentilesAggregation.md) | A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents. |
+| `random_sampler` | [AggregationsRandomSamplerAggregation](./AggregationsRandomSamplerAggregation.md) | A single bucket aggregation that randomly includes documents in the aggregated results. Sampling provides significant speed improvement at the cost of accuracy. |
+| `range` | [AggregationsRangeAggregation](./AggregationsRangeAggregation.md) | A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket. |
+| `rare_terms` | [AggregationsRareTermsAggregation](./AggregationsRareTermsAggregation.md) | A multi-bucket value source based aggregation which finds "rare" terms—terms that are at the long-tail of the distribution and are not frequent. |
+| `rate` | [AggregationsRateAggregation](./AggregationsRateAggregation.md) | Calculates a rate of documents or a field in each bucket. Can only be used inside a `date_histogram` or `composite` aggregation. |
+| `reverse_nested` | [AggregationsReverseNestedAggregation](./AggregationsReverseNestedAggregation.md) | A special single bucket aggregation that enables aggregating on parent documents from nested documents. Should only be defined inside a `nested` aggregation. |
+| `sampler` | [AggregationsSamplerAggregation](./AggregationsSamplerAggregation.md) | A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents. |
+| `scripted_metric` | [AggregationsScriptedMetricAggregation](./AggregationsScriptedMetricAggregation.md) | A metric aggregation that uses scripts to provide a metric output. |
+| `serial_diff` | [AggregationsSerialDifferencingAggregation](./AggregationsSerialDifferencingAggregation.md) | An aggregation that subtracts values in a time series from themselves at different time lags or periods. |
+| `significant_terms` | [AggregationsSignificantTermsAggregation](./AggregationsSignificantTermsAggregation.md) | Returns interesting or unusual occurrences of terms in a set. |
+| `significant_text` | [AggregationsSignificantTextAggregation](./AggregationsSignificantTextAggregation.md) | Returns interesting or unusual occurrences of free-text terms in a set. |
+| `stats_bucket` | [AggregationsStatsBucketAggregation](./AggregationsStatsBucketAggregation.md) | A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. |
+| `stats` | [AggregationsStatsAggregation](./AggregationsStatsAggregation.md) | A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents. |
+| `string_stats` | [AggregationsStringStatsAggregation](./AggregationsStringStatsAggregation.md) | A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents. |
+| `sum_bucket` | [AggregationsSumBucketAggregation](./AggregationsSumBucketAggregation.md) | A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation. |
+| `sum` | [AggregationsSumAggregation](./AggregationsSumAggregation.md) | A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents. |
+| `t_test` | [AggregationsTTestAggregation](./AggregationsTTestAggregation.md) | A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents. |
+| `terms` | [AggregationsTermsAggregation](./AggregationsTermsAggregation.md) | A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value. |
+| `time_series` | [AggregationsTimeSeriesAggregation](./AggregationsTimeSeriesAggregation.md) | The time series aggregation queries data created using a time series index. This is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode. |
+| `top_hits` | [AggregationsTopHitsAggregation](./AggregationsTopHitsAggregation.md) | A metric aggregation that returns the top matching documents per bucket. |
+| `top_metrics` | [AggregationsTopMetricsAggregation](./AggregationsTopMetricsAggregation.md) | A metric aggregation that selects metrics from the document with the largest or smallest sort value. |
+| `value_count` | [AggregationsValueCountAggregation](./AggregationsValueCountAggregation.md) | A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents. |
+| `variable_width_histogram` | [AggregationsVariableWidthHistogramAggregation](./AggregationsVariableWidthHistogramAggregation.md) | A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided. |
+| `weighted_avg` | [AggregationsWeightedAverageAggregation](./AggregationsWeightedAverageAggregation.md) | A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents. |

docs/reference/api/AggregationsAggregationRange.md

@@ -0,0 +1,7 @@
+## Interface `AggregationsAggregationRange`
+
+| Name | Type | Description |
+| - | - | - |
+| `from` | [double](./double.md) | null | Start of the range (inclusive). |
+| `key` | string | Custom key to return the range with. |
+| `to` | [double](./double.md) | null | End of the range (exclusive). |

docs/reference/api/AggregationsArrayPercentilesItem.md

@@ -0,0 +1,7 @@
+## Interface `AggregationsArrayPercentilesItem`
+
+| Name | Type | Description |
+| - | - | - |
+| `key` | string |   |
+| `value_as_string` | string |   |
+| `value` | [double](./double.md) | null |   |

docs/reference/api/AggregationsAutoDateHistogramAggregate.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsAutoDateHistogramAggregate`
+
+| Name | Type | Description |
+| - | - | - |
+| `interval` | [DurationLarge](./DurationLarge.md) |   |

docs/reference/api/AggregationsAutoDateHistogramAggregation.md

@@ -0,0 +1,13 @@
+## Interface `AggregationsAutoDateHistogramAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `buckets` | [integer](./integer.md) | The target number of buckets. |
+| `field` | [Field](./Field.md) | The field on which to run the aggregation. |
+| `format` | string | The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used. |
+| `minimum_interval` | [AggregationsMinimumInterval](./AggregationsMinimumInterval.md) | The minimum rounding interval. This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. |
+| `missing` | [DateTime](./DateTime.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. |
+| `offset` | string | Time zone specified as a ISO 8601 UTC offset. |
+| `params` | Record<string, any> | &nbsp; |
+| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | &nbsp; |
+| `time_zone` | [TimeZone](./TimeZone.md) | Time zone ID. |

docs/reference/api/AggregationsAverageAggregation.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsAverageAggregation`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsAverageBucketAggregation.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsAverageBucketAggregation`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsAvgAggregate.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsAvgAggregate`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsBoxPlotAggregate.md

@@ -0,0 +1,18 @@
+## Interface `AggregationsBoxPlotAggregate`
+
+| Name | Type | Description |
+| - | - | - |
+| `lower_as_string` | string |   |
+| `lower` | [double](./double.md) |   |
+| `max_as_string` | string |   |
+| `max` | [double](./double.md) |   |
+| `min_as_string` | string |   |
+| `min` | [double](./double.md) |   |
+| `q1_as_string` | string |   |
+| `q1` | [double](./double.md) |   |
+| `q2_as_string` | string |   |
+| `q2` | [double](./double.md) |   |
+| `q3_as_string` | string |   |
+| `q3` | [double](./double.md) |   |
+| `upper_as_string` | string |   |
+| `upper` | [double](./double.md) |   |

docs/reference/api/AggregationsBoxplotAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsBoxplotAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `compression` | [double](./double.md) | Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. |

docs/reference/api/AggregationsBucketAggregationBase.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsBucketAggregationBase`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsBucketCorrelationAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsBucketCorrelationAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `function` | [AggregationsBucketCorrelationFunction](./AggregationsBucketCorrelationFunction.md) | The correlation function to execute. |

docs/reference/api/AggregationsBucketCorrelationFunction.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsBucketCorrelationFunction`
+
+| Name | Type | Description |
+| - | - | - |
+| `count_correlation` | [AggregationsBucketCorrelationFunctionCountCorrelation](./AggregationsBucketCorrelationFunctionCountCorrelation.md) | The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. |

docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsBucketCorrelationFunctionCountCorrelation`
+
+| Name | Type | Description |
+| - | - | - |
+| `indicator` | [AggregationsBucketCorrelationFunctionCountCorrelationIndicator](./AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md) | The indicator with which to correlate the configured `bucket_path` values. |

docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md

@@ -0,0 +1,7 @@
+## Interface `AggregationsBucketCorrelationFunctionCountCorrelationIndicator`
+
+| Name | Type | Description |
+| - | - | - |
+| `doc_count` | [integer](./integer.md) | The total number of documents that initially created the expectations. It’s required to be greater than or equal to the sum of all values in the buckets_path as this is the originating superset of data to which the term values are correlated. |
+| `expectations` | [double](./double.md)[] | An array of numbers with which to correlate the configured `bucket_path` values. The length of this value must always equal the number of buckets returned by the `bucket_path`. |
+| `fractions` | [double](./double.md)[] | An array of fractions to use when averaging and calculating variance. This should be used if the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, must equal expectations. |

docs/reference/api/AggregationsBucketKsAggregation.md

@@ -0,0 +1,7 @@
+## Interface `AggregationsBucketKsAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `alternative` | string[] | A list of string values indicating which K-S test alternative to calculate. The valid values are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used when calculating the K-S test. Default value is all possible alternative hypotheses. |
+| `fractions` | [double](./double.md)[] | A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results. In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a metric to define the bucket end points. |
+| `sampling_method` | string | Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`, and `lower_tail`. |

docs/reference/api/AggregationsBucketMetricValueAggregate.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsBucketMetricValueAggregate`
+
+| Name | Type | Description |
+| - | - | - |
+| `keys` | string[] |   |

docs/reference/api/AggregationsBucketPathAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsBucketPathAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `buckets_path` | [AggregationsBucketsPath](./AggregationsBucketsPath.md) | Path to the buckets that contain one set of values to correlate. |

docs/reference/api/AggregationsBucketScriptAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsBucketScriptAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The script to run for this aggregation. |

docs/reference/api/AggregationsBucketSelectorAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsBucketSelectorAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The script to run for this aggregation. |

docs/reference/api/AggregationsBucketSortAggregation.md

@@ -0,0 +1,8 @@
+## Interface `AggregationsBucketSortAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `from` | [integer](./integer.md) | Buckets in positions prior to `from` will be truncated. |
+| `gap_policy` | [AggregationsGapPolicy](./AggregationsGapPolicy.md) | The policy to apply when gaps are found in the data. |
+| `size` | [integer](./integer.md) | The number of buckets to return. Defaults to all buckets of the parent aggregation. |
+| `sort` | [Sort](./Sort.md) | The list of fields to sort on. |

docs/reference/api/AggregationsBuckets.md

@@ -0,0 +1,4 @@
+## `AggregationsBuckets`
+:::
+type AggregationsBuckets<TBucket = unknown> = Record<string, TBucket> | TBucket[];
+:::

docs/reference/api/AggregationsBucketsPath.md

@@ -0,0 +1,4 @@
+## `AggregationsBucketsPath`
+:::
+type AggregationsBucketsPath = string | string[] | Record<string, string>;
+:::

docs/reference/api/AggregationsCalendarInterval.md

@@ -0,0 +1,4 @@
+## `AggregationsCalendarInterval`
+:::
+type AggregationsCalendarInterval = 'second' | '1s' | 'minute' | '1m' | 'hour' | '1h' | 'day' | '1d' | 'week' | '1w' | 'month' | '1M' | 'quarter' | '1q' | 'year' | '1y';
+:::

docs/reference/api/AggregationsCardinalityAggregate.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsCardinalityAggregate`
+
+| Name | Type | Description |
+| - | - | - |
+| `value` | [long](./long.md) |   |

docs/reference/api/AggregationsCardinalityAggregation.md

@@ -0,0 +1,7 @@
+## Interface `AggregationsCardinalityAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `execution_hint` | [AggregationsCardinalityExecutionMode](./AggregationsCardinalityExecutionMode.md) | Mechanism by which cardinality aggregations is run. |
+| `precision_threshold` | [integer](./integer.md) | A unique count below which counts are expected to be close to accurate. This allows to trade memory for accuracy. |
+| `rehash` | boolean |   |

docs/reference/api/AggregationsCardinalityExecutionMode.md

@@ -0,0 +1,4 @@
+## `AggregationsCardinalityExecutionMode`
+:::
+type AggregationsCardinalityExecutionMode = 'global_ordinals' | 'segment_ordinals' | 'direct' | 'save_memory_heuristic' | 'save_time_heuristic';
+:::

docs/reference/api/AggregationsCategorizeTextAggregation.md

@@ -0,0 +1,14 @@
+## Interface `AggregationsCategorizeTextAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `categorization_analyzer` | [AggregationsCategorizeTextAnalyzer](./AggregationsCategorizeTextAnalyzer.md) | The categorization analyzer specifies how the text is analyzed and tokenized before being categorized. The syntax is very similar to that used to define the analyzer in the analyze API. This property cannot be used at the same time as `categorization_filters`. |
+| `categorization_filters` | string[] | This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters. |
+| `field` | [Field](./Field.md) | The semi-structured text field to categorize. |
+| `max_matched_tokens` | [integer](./integer.md) | The maximum number of token positions to match on before attempting to merge categories. Larger values will use more memory and create narrower categories. Max allowed value is 100. |
+| `max_unique_tokens` | [integer](./integer.md) | The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. Smaller values use less memory and create fewer categories. Larger values will use more memory and create narrower categories. Max allowed value is 100. |
+| `min_doc_count` | [integer](./integer.md) | The minimum number of documents in a bucket to be returned to the results. |
+| `shard_min_doc_count` | [integer](./integer.md) | The minimum number of documents in a bucket to be returned from the shard before merging. |
+| `shard_size` | [integer](./integer.md) | The number of categorization buckets to return from each shard before merging all the results. |
+| `similarity_threshold` | [integer](./integer.md) | The minimum percentage of tokens that must match for text to be added to the category bucket. Must be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory usage and create narrower categories. |
+| `size` | [integer](./integer.md) | The number of buckets to return. |

docs/reference/api/AggregationsCategorizeTextAnalyzer.md

@@ -0,0 +1,4 @@
+## `AggregationsCategorizeTextAnalyzer`
+:::
+type AggregationsCategorizeTextAnalyzer = string | [AggregationsCustomCategorizeTextAnalyzer](./AggregationsCustomCategorizeTextAnalyzer.md);
+:::

docs/reference/api/AggregationsChiSquareHeuristic.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsChiSquareHeuristic`
+
+| Name | Type | Description |
+| - | - | - |
+| `background_is_superset` | boolean | Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. |
+| `include_negatives` | boolean | Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. |

docs/reference/api/AggregationsChildrenAggregate.md

@@ -0,0 +1,4 @@
+## `AggregationsChildrenAggregate`
+:::
+type AggregationsChildrenAggregate = [AggregationsChildrenAggregateKeys](./AggregationsChildrenAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);};
+:::

docs/reference/api/AggregationsChildrenAggregateKeys.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsChildrenAggregateKeys`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsChildrenAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsChildrenAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `type` | [RelationName](./RelationName.md) | The child type that should be selected. |

docs/reference/api/AggregationsCompositeAggregate.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsCompositeAggregate`
+
+| Name | Type | Description |
+| - | - | - |
+| `after_key` | [AggregationsCompositeAggregateKey](./AggregationsCompositeAggregateKey.md) |   |

docs/reference/api/AggregationsCompositeAggregateKey.md

@@ -0,0 +1,4 @@
+## `AggregationsCompositeAggregateKey`
+:::
+type AggregationsCompositeAggregateKey = Record<[Field](./Field.md), [FieldValue](./FieldValue.md)>;
+:::

docs/reference/api/AggregationsCompositeAggregation.md

@@ -0,0 +1,7 @@
+## Interface `AggregationsCompositeAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `after` | [AggregationsCompositeAggregateKey](./AggregationsCompositeAggregateKey.md) | When paginating, use the `after_key` value returned in the previous response to retrieve the next page. |
+| `size` | [integer](./integer.md) | The number of composite buckets that should be returned. |
+| `sources` | Record<string, [AggregationsCompositeAggregationSource](./AggregationsCompositeAggregationSource.md)>[] | The value sources used to build composite buckets. Keys are returned in the order of the `sources` definition. |

docs/reference/api/AggregationsCompositeAggregationBase.md

@@ -0,0 +1,10 @@
+## Interface `AggregationsCompositeAggregationBase`
+
+| Name | Type | Description |
+| - | - | - |
+| `field` | [Field](./Field.md) | Either `field` or `script` must be present |
+| `missing_bucket` | boolean |   |
+| `missing_order` | [AggregationsMissingOrder](./AggregationsMissingOrder.md) |   |
+| `order` | [SortOrder](./SortOrder.md) |   |
+| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Either `field` or `script` must be present |
+| `value_type` | [AggregationsValueType](./AggregationsValueType.md) |   |

docs/reference/api/AggregationsCompositeAggregationSource.md

@@ -0,0 +1,8 @@
+## Interface `AggregationsCompositeAggregationSource`
+
+| Name | Type | Description |
+| - | - | - |
+| `date_histogram` | [AggregationsCompositeDateHistogramAggregation](./AggregationsCompositeDateHistogramAggregation.md) | A date histogram aggregation. |
+| `geotile_grid` | [AggregationsCompositeGeoTileGridAggregation](./AggregationsCompositeGeoTileGridAggregation.md) | A geotile grid aggregation. |
+| `histogram` | [AggregationsCompositeHistogramAggregation](./AggregationsCompositeHistogramAggregation.md) | A histogram aggregation. |
+| `terms` | [AggregationsCompositeTermsAggregation](./AggregationsCompositeTermsAggregation.md) | A terms aggregation. |

docs/reference/api/AggregationsCompositeBucket.md

@@ -0,0 +1,4 @@
+## `AggregationsCompositeBucket`
+:::
+type AggregationsCompositeBucket = [AggregationsCompositeBucketKeys](./AggregationsCompositeBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [AggregationsCompositeAggregateKey](./AggregationsCompositeAggregateKey.md) | [long](./long.md);};
+:::

docs/reference/api/AggregationsCompositeBucketKeys.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsCompositeBucketKeys`
+
+| Name | Type | Description |
+| - | - | - |
+| `key` | [AggregationsCompositeAggregateKey](./AggregationsCompositeAggregateKey.md) |   |

docs/reference/api/AggregationsCompositeDateHistogramAggregation.md

@@ -0,0 +1,9 @@
+## Interface `AggregationsCompositeDateHistogramAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `calendar_interval` | [DurationLarge](./DurationLarge.md) | Either `calendar_interval` or `fixed_interval` must be present |
+| `fixed_interval` | [DurationLarge](./DurationLarge.md) | Either `calendar_interval` or `fixed_interval` must be present |
+| `format` | string |   |
+| `offset` | [Duration](./Duration.md) |   |
+| `time_zone` | [TimeZone](./TimeZone.md) |   |

docs/reference/api/AggregationsCompositeGeoTileGridAggregation.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsCompositeGeoTileGridAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `bounds` | [GeoBounds](./GeoBounds.md) |   |
+| `precision` | [integer](./integer.md) |   |

docs/reference/api/AggregationsCompositeHistogramAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsCompositeHistogramAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `interval` | [double](./double.md) |   |

docs/reference/api/AggregationsCompositeTermsAggregation.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsCompositeTermsAggregation`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsCumulativeCardinalityAggregate.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsCumulativeCardinalityAggregate`
+
+| Name | Type | Description |
+| - | - | - |
+| `value_as_string` | string |   |
+| `value` | [long](./long.md) |   |

docs/reference/api/AggregationsCumulativeCardinalityAggregation.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsCumulativeCardinalityAggregation`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsCumulativeSumAggregation.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsCumulativeSumAggregation`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsCustomCategorizeTextAnalyzer.md

@@ -0,0 +1,7 @@
+## Interface `AggregationsCustomCategorizeTextAnalyzer`
+
+| Name | Type | Description |
+| - | - | - |
+| `char_filter` | string[] |   |
+| `filter` | string[] |   |
+| `tokenizer` | string |   |

docs/reference/api/AggregationsDateHistogramAggregate.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsDateHistogramAggregate`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsDateHistogramAggregation.md

@@ -0,0 +1,19 @@
+## Interface `AggregationsDateHistogramAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `calendar_interval` | [AggregationsCalendarInterval](./AggregationsCalendarInterval.md) | Calendar-aware interval. Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. |
+| `extended_bounds` | [AggregationsExtendedBounds](./AggregationsExtendedBounds.md)<[AggregationsFieldDateMath](./AggregationsFieldDateMath.md)> | Enables extending the bounds of the histogram beyond the data itself. |
+| `field` | [Field](./Field.md) | The date field whose values are use to build a histogram. |
+| `fixed_interval` | [Duration](./Duration.md) | Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. |
+| `format` | string | The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used. |
+| `hard_bounds` | [AggregationsExtendedBounds](./AggregationsExtendedBounds.md)<[AggregationsFieldDateMath](./AggregationsFieldDateMath.md)> | Limits the histogram to specified bounds. |
+| `interval` | [Duration](./Duration.md) | &nbsp; |
+| `keyed` | boolean | Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. |
+| `min_doc_count` | [integer](./integer.md) | Only returns buckets that have `min_doc_count` number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned. |
+| `missing` | [DateTime](./DateTime.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. |
+| `offset` | [Duration](./Duration.md) | Changes the start value of each bucket by the specified positive ( `+`) or negative offset ( `-`) duration. |
+| `order` | [AggregationsAggregateOrder](./AggregationsAggregateOrder.md) | The sort order of the returned buckets. |
+| `params` | Record<string, any> | &nbsp; |
+| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | &nbsp; |
+| `time_zone` | [TimeZone](./TimeZone.md) | Time zone used for bucketing and rounding. Defaults to Coordinated Universal Time (UTC). |

docs/reference/api/AggregationsDateHistogramBucket.md

@@ -0,0 +1,4 @@
+## `AggregationsDateHistogramBucket`
+:::
+type AggregationsDateHistogramBucket = [AggregationsDateHistogramBucketKeys](./AggregationsDateHistogramBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | [long](./long.md);};
+:::

docs/reference/api/AggregationsDateHistogramBucketKeys.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsDateHistogramBucketKeys`
+
+| Name | Type | Description |
+| - | - | - |
+| `key_as_string` | string |   |
+| `key` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | &nbsp; |

docs/reference/api/AggregationsDateRangeAggregate.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsDateRangeAggregate`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsDateRangeAggregation.md

@@ -0,0 +1,10 @@
+## Interface `AggregationsDateRangeAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `field` | [Field](./Field.md) | The date field whose values are use to build ranges. |
+| `format` | string | The date format used to format `from` and `to` in the response. |
+| `keyed` | boolean | Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. |
+| `missing` | [AggregationsMissing](./AggregationsMissing.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. |
+| `ranges` | [AggregationsDateRangeExpression](./AggregationsDateRangeExpression.md)[] | Array of date ranges. |
+| `time_zone` | [TimeZone](./TimeZone.md) | Time zone used to convert dates from another time zone to UTC. |

docs/reference/api/AggregationsDateRangeExpression.md

@@ -0,0 +1,7 @@
+## Interface `AggregationsDateRangeExpression`
+
+| Name | Type | Description |
+| - | - | - |
+| `from` | [AggregationsFieldDateMath](./AggregationsFieldDateMath.md) | Start of the range (inclusive). |
+| `key` | string | Custom key to return the range with. |
+| `to` | [AggregationsFieldDateMath](./AggregationsFieldDateMath.md) | End of the range (exclusive). |

docs/reference/api/AggregationsDerivativeAggregate.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsDerivativeAggregate`
+
+| Name | Type | Description |
+| - | - | - |
+| `normalized_value_as_string` | string |   |
+| `normalized_value` | [double](./double.md) |   |

docs/reference/api/AggregationsDerivativeAggregation.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsDerivativeAggregation`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsDiversifiedSamplerAggregation.md

@@ -0,0 +1,9 @@
+## Interface `AggregationsDiversifiedSamplerAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `execution_hint` | [AggregationsSamplerAggregationExecutionHint](./AggregationsSamplerAggregationExecutionHint.md) | The type of value used for de-duplication. |
+| `field` | [Field](./Field.md) | The field used to provide values used for de-duplication. |
+| `max_docs_per_value` | [integer](./integer.md) | Limits how many documents are permitted per choice of de-duplicating value. |
+| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   |
+| `shard_size` | [integer](./integer.md) | Limits how many top-scoring documents are collected in the sample processed on each shard. |

docs/reference/api/AggregationsDoubleTermsAggregate.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsDoubleTermsAggregate`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsDoubleTermsBucket.md

@@ -0,0 +1,4 @@
+## `AggregationsDoubleTermsBucket`
+:::
+type AggregationsDoubleTermsBucket = [AggregationsDoubleTermsBucketKeys](./AggregationsDoubleTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [double](./double.md) | string | [long](./long.md);};
+:::

docs/reference/api/AggregationsDoubleTermsBucketKeys.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsDoubleTermsBucketKeys`
+
+| Name | Type | Description |
+| - | - | - |
+| `key_as_string` | string |   |
+| `key` | [double](./double.md) |   |

docs/reference/api/AggregationsEwmaModelSettings.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsEwmaModelSettings`
+
+| Name | Type | Description |
+| - | - | - |
+| `alpha` | [float](./float.md) |   |

docs/reference/api/AggregationsEwmaMovingAverageAggregation.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsEwmaMovingAverageAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `model` | 'ewma' |   |
+| `settings` | [AggregationsEwmaModelSettings](./AggregationsEwmaModelSettings.md) |   |

docs/reference/api/AggregationsExtendedBounds.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsExtendedBounds`
+
+| Name | Type | Description |
+| - | - | - |
+| `max` | T | Maximum value for the bound. |
+| `min` | T | Minimum value for the bound. |

docs/reference/api/AggregationsExtendedStatsAggregate.md

@@ -0,0 +1,18 @@
+## Interface `AggregationsExtendedStatsAggregate`
+
+| Name | Type | Description |
+| - | - | - |
+| `std_deviation_as_string` | string |   |
+| `std_deviation_bounds_as_string` | [AggregationsStandardDeviationBoundsAsString](./AggregationsStandardDeviationBoundsAsString.md) |   |
+| `std_deviation_bounds` | [AggregationsStandardDeviationBounds](./AggregationsStandardDeviationBounds.md) |   |
+| `std_deviation_population` | [double](./double.md) | null |   |
+| `std_deviation_sampling` | [double](./double.md) | null |   |
+| `std_deviation` | [double](./double.md) | null |   |
+| `sum_of_squares_as_string` | string |   |
+| `sum_of_squares` | [double](./double.md) | null |   |
+| `variance_as_string` | string |   |
+| `variance_population_as_string` | string |   |
+| `variance_population` | [double](./double.md) | null |   |
+| `variance_sampling_as_string` | string |   |
+| `variance_sampling` | [double](./double.md) | null |   |
+| `variance` | [double](./double.md) | null |   |

docs/reference/api/AggregationsExtendedStatsAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsExtendedStatsAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `sigma` | [double](./double.md) | The number of standard deviations above/below the mean to display. |

docs/reference/api/AggregationsExtendedStatsBucketAggregate.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsExtendedStatsBucketAggregate`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsExtendedStatsBucketAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsExtendedStatsBucketAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `sigma` | [double](./double.md) | The number of standard deviations above/below the mean to display. |

docs/reference/api/AggregationsFieldDateMath.md

@@ -0,0 +1,4 @@
+## `AggregationsFieldDateMath`
+:::
+type AggregationsFieldDateMath = [DateMath](./DateMath.md) | [double](./double.md);
+:::

docs/reference/api/AggregationsFilterAggregate.md

@@ -0,0 +1,4 @@
+## `AggregationsFilterAggregate`
+:::
+type AggregationsFilterAggregate = [AggregationsFilterAggregateKeys](./AggregationsFilterAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);};
+:::

docs/reference/api/AggregationsFilterAggregateKeys.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsFilterAggregateKeys`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsFiltersAggregate.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsFiltersAggregate`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsFiltersAggregation.md

@@ -0,0 +1,8 @@
+## Interface `AggregationsFiltersAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `filters` | [AggregationsBuckets](./AggregationsBuckets.md)<[QueryDslQueryContainer](./QueryDslQueryContainer.md)> | Collection of queries from which to build buckets. |
+| `keyed` | boolean | By default, the named filters aggregation returns the buckets as an object. Set to `false` to return the buckets as an array of objects. |
+| `other_bucket_key` | string | The key with which the other bucket is returned. |
+| `other_bucket` | boolean | Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. |

docs/reference/api/AggregationsFiltersBucket.md

@@ -0,0 +1,4 @@
+## `AggregationsFiltersBucket`
+:::
+type AggregationsFiltersBucket = [AggregationsFiltersBucketKeys](./AggregationsFiltersBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md);};
+:::

docs/reference/api/AggregationsFiltersBucketKeys.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsFiltersBucketKeys`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsFormatMetricAggregationBase.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsFormatMetricAggregationBase`
+
+| Name | Type | Description |
+| - | - | - |
+| `format` | string |   |

docs/reference/api/AggregationsFormattableMetricAggregation.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsFormattableMetricAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `format` | string |   |

docs/reference/api/AggregationsFrequentItemSetsAggregate.md

@@ -0,0 +1,4 @@
+## Interface `AggregationsFrequentItemSetsAggregate`
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsFrequentItemSetsAggregation.md

@@ -0,0 +1,9 @@
+## Interface `AggregationsFrequentItemSetsAggregation`
+
+| Name | Type | Description |
+| - | - | - |
+| `fields` | [AggregationsFrequentItemSetsField](./AggregationsFrequentItemSetsField.md)[] | Fields to analyze. |
+| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query that filters documents from analysis. |
+| `minimum_set_size` | [integer](./integer.md) | The minimum size of one item set. |
+| `minimum_support` | [double](./double.md) | The minimum support of one item set. |
+| `size` | [integer](./integer.md) | The number of top item sets to return. |

docs/reference/api/AggregationsFrequentItemSetsBucket.md

@@ -0,0 +1,4 @@
+## `AggregationsFrequentItemSetsBucket`
+:::
+type AggregationsFrequentItemSetsBucket = [AggregationsFrequentItemSetsBucketKeys](./AggregationsFrequentItemSetsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | Record<[Field](./Field.md), string[]> | [double](./double.md) | [long](./long.md);};
+:::

docs/reference/api/AggregationsFrequentItemSetsBucketKeys.md

@@ -0,0 +1,6 @@
+## Interface `AggregationsFrequentItemSetsBucketKeys`
+
+| Name | Type | Description |
+| - | - | - |
+| `key` | Record<[Field](./Field.md), string[]> | &nbsp; |
+| `support` | [double](./double.md) | &nbsp; |

docs/reference/api/AggregationsFrequentItemSetsField.md

@@ -0,0 +1,7 @@
+## Interface `AggregationsFrequentItemSetsField`
+
+| Name | Type | Description |
+| - | - | - |
+| `exclude` | [AggregationsTermsExclude](./AggregationsTermsExclude.md) | Values to exclude. Can be regular expression strings or arrays of strings of exact terms. |
+| `field` | [Field](./Field.md) |   |
+| `include` | [AggregationsTermsInclude](./AggregationsTermsInclude.md) | Values to include. Can be regular expression strings or arrays of strings of exact terms. |

docs/reference/api/AggregationsGapPolicy.md

@@ -0,0 +1,4 @@
+## `AggregationsGapPolicy`
+:::
+type AggregationsGapPolicy = 'skip' | 'insert_zeros' | 'keep_values';
+:::

docs/reference/api/AggregationsGeoBoundsAggregate.md

@@ -0,0 +1,5 @@
+## Interface `AggregationsGeoBoundsAggregate`
+
+| Name | Type | Description |
+| - | - | - |
+| `bounds` | [GeoBounds](./GeoBounds.md) |   |