The identity and technical contract details declared by the specification.
_types.query_dsl.SpanContainingQuery
_types.query_dsl.TypeQuery
_types.analysis.MinHashTokenFilter
_types.aggregations.TopHitsAggregation
_types.aggregations.BucketSelectorAggregation
_types.query_dsl.CombinedFieldsZeroTerms
string
_types.mapping.VersionProperty
_types.mapping.MatchType
string
_types.analysis.HunspellTokenFilter
_types.FieldMemoryUsage
object
2 properties
1 required
_types.aggregations.TermsPartition
object
2 properties
2 required
_types.query_dsl.GeoBoundingBoxQuery
_types.analysis.DanishAnalyzer
object
3 properties
1 required
indices._types.SoftDeletes
object
2 properties
_types.mapping.CorePropertyBase
_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator
object
3 properties
2 required
indices._types.SegmentSortMode
string
_types.analysis.KuromojiAnalyzer
object
3 properties
1 required
_types.aggregations.ChildrenAggregation
_types.EpochTimeUnitMillis
_types.aggregations.MatrixAggregation
_types.query_dsl.DisMaxQuery
_types.RecoveryStats
object
8 properties
3 required
_types.mapping.IntegerNumberProperty
_types.aggregations.SamplerAggregationExecutionHint
string
indices.put_index_template.IndexTemplateMapping
object
5 properties
_types.aggregations.MovingPercentilesAggregation
_types.aggregations.HoltWintersModelSettings
object
6 properties
_types.aggregations.HistogramAggregation
_types.GeoTilePrecision
number
_types.mapping.DataStreamTimestamp
object
1 property
1 required
_types.aggregations.DateRangeAggregation
indices._types.MappingLimitSettingsFieldNameLength
object
1 property
_types.analysis.CompoundWordTokenFilterBase
indices.get_alias._types.IndexAliases
object
1 property
1 required
indices._types.SettingsSimilarityDfr
object
4 properties
4 required
_types.aggregations.StringStatsAggregation
indices._types.TranslogRetention
object
2 properties
indices._types.SamplingMethod
string
_types.aggregations.TTestType
string
_types.TextSimilarityReranker
_types.aggregations.ParentAggregation
_types.analysis.BulgarianAnalyzer
object
4 properties
1 required
_types.aggregations.MaxBucketAggregation
_global.search._types.FieldCollapse
object
4 properties
1 required
indices.recovery.RecoveryStartStatus
object
4 properties
2 required
_types.mapping.GeoShapeProperty
The geoshape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles and polygons.
_types.DateTime
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch…
_types.query_dsl.RangeQueryBase
_types.query_dsl.NumericDecayFunction
_types.analysis.StemmerOverrideTokenFilter
_types.mapping.Subobjects
string
_types.aggregations.FormattableMetricAggregation
indices._types.RetentionLease
object
1 property
1 required
indices.update_aliases.AddAction
object
11 properties
_types.analysis.TokenizerDefinition
indices._types.IndexState
object
6 properties
_types.query_dsl.UntypedRangeQuery
_types.CompletionStats
object
3 properties
1 required
_types.aggregations.GeoLineSort
object
1 property
1 required
_types.mapping.SizeField
object
1 property
1 required
indices.segments.IndexSegment
object
1 property
1 required
_types.mapping.LongRangeProperty
_types.IndexingStats
object
18 properties
11 required
_types.analysis.KuromojiPartOfSpeechTokenFilter
_types.mapping.FieldAliasProperty
cluster.stats.DenseVectorStats
object
2 properties
1 required
_types.aggregations.MultiTermLookup
_types.query_dsl.DecayFunctionBaseGeoLocationDistance
object
1 property
_types.aggregations.CompositeAggregation
_types.analysis.HyphenationDecompounderTokenFilter
_types.query_dsl.SemanticQuery
_types.aggregations.InferenceAggregation
_types.analysis.ArabicAnalyzer
object
4 properties
1 required
_types.aggregations.HoltWintersMovingAverageAggregation
_types.query_dsl.TextQueryType
string
_types.analysis.KuromojiIterationMarkCharFilter
_types.analysis.StopWords
Language value, such as arabic or thai. Defaults to english. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by la…
indices.stats.ShardRetentionLeases
object
3 properties
3 required
_types.analysis.SimplePatternSplitTokenizer
indices._types.IndexTemplateSummary
object
5 properties
_types.mapping.PassthroughObjectProperty
_types.aggregations.ScriptedMetricAggregation
_types.analysis.ScandinavianNormalizationTokenFilter
_types.aggregations.StatsBucketAggregation
_types.query_dsl.RangeQueryBaselong
_types.mapping.RankVectorProperty
Technical preview
indices._types.DataStreamVisibility
object
3 properties
_types.mapping.ShapeProperty
The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as rectangles and polygons.
_types.mapping.IcuCollationProperty
_types.analysis.DictionaryDecompounderTokenFilter
_types.analysis.UppercaseTokenFilter
_types.StoreStats
object
6 properties
2 required
_types.mapping.NestedProperty
indices.update_aliases.Action
object
3 properties
_types.aggregations.BucketPathAggregation
_types.mapping.FlattenedProperty
_types.analysis.DelimitedPayloadEncoding
string
_types.aggregations.AggregationRange
object
3 properties
_types.analysis.CustomNormalizer
object
3 properties
1 required
_types.DiversifyRetriever
_types.query_dsl.TextExpansionQuery
_types.mapping.PropertyBase
object
6 properties
_types.analysis.ClassicTokenFilter
_types.analysis.SimplePatternTokenizer
_types.mapping.DenseVectorElementType
string
_types.analysis.SimpleAnalyzer
object
2 properties
1 required
_types.HealthStatus
string
_types.analysis.MultiplexerTokenFilter
_types.aggregations.ExtendedStatsBucketAggregation
_types.analysis.CjkAnalyzer
object
3 properties
1 required
_types.analysis.TrimTokenFilter
_types.analysis.PersianNormalizationTokenFilter
_types.analysis.IndicNormalizationTokenFilter
_types.query_dsl.WildcardQuery
_global.search._types.HighlighterOrder
string
_types.query_dsl.FuzzyQuery
_types.InnerRetriever
object
3 properties
3 required
_types.ShardFailure
object
6 properties
1 required
_types.query_dsl.SparseVectorQuery
_types.analysis.PhoneticNameType
string
_types.SlicedScroll
object
3 properties
2 required
_types.aggregations.SignificantTextAggregation
_types.aggregations.SignificantTermsAggregation
indices._types.IndexSettingsUnassigned
object
1 property
_types.mapping.BinaryProperty
_types.mapping.AggregateMetricDoubleProperty
_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance
_types.query_dsl.MultiValueMode
string
indices._types.SettingsSimilarityBoolean
object
1 property
1 required
_types.WarmerStats
object
4 properties
3 required
_types.aggregations.GoogleNormalizedDistanceHeuristic
object
1 property
_types.query_dsl.TermsSetQuery
_types.aggregations.TermsAggregation
_types.analysis.IcuCollationAlternate
string
_types.analysis.IcuNormalizationMode
string
_types.query_dsl.ConstantScoreQuery
_types.query_dsl.DateRangeQuery
_types.WaitForActiveShardOptions
string
_types.query_dsl.MatchPhraseQuery
_types.query_dsl.FunctionBoostMode
string
indices._types.IndexRoutingRebalanceOptions
string
_types.query_dsl.DateDecayFunction
_types.query_dsl.DecayFunctionBasedoubledouble
object
1 property
_types.analysis.TokenChar
string
_types.query_dsl.HasParentQuery
_types.query_dsl.SpanMultiTermQuery
_types.mapping.CountedKeywordProperty
_types.analysis.MappingCharFilter
_types.analysis.IndonesianAnalyzer
object
4 properties
1 required
_types.analysis.CharFilterBase
object
1 property
_types.analysis.IrishAnalyzer
object
4 properties
1 required
_types.query_dsl.RankFeatureQuery
_types.analysis.PortugueseAnalyzer
object
4 properties
1 required
_types.aggregations.HoltMovingAverageAggregation
indices._types.Storage
object
3 properties
1 required
_types.analysis.DelimitedPayloadTokenFilter
_types.analysis.SynonymTokenFilter
_types.query_dsl.SpanFirstQuery
indices._types.Queries
object
1 property
_types.query_dsl.MatchBoolPrefixQuery
_types.analysis.DutchStemTokenFilter
_types.analysis.FinnishAnalyzer
object
4 properties
1 required
indices._types.IndexingSlowlogTresholds
object
1 property
_types.analysis.StopWordLanguage
string
_types.query_dsl.FieldValueFactorModifier
string
_types.GeoHashPrecision
A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m".
_types.analysis.FingerprintTokenFilter
_types.analysis.LetterTokenizer
_types.mapping.RankVectorElementType
string
_types.mapping.CompletionProperty
_types.mapping.JoinProperty
_types.analysis.IcuTransformDirection
string
_spec_utils.Stringifiedboolean
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_global.search._types.ScoreMode
string
_types.aggregations.PercentageScoreHeuristic
object
_types.query_dsl.SpanNearQuery
_types.mapping.SyntheticSourceKeepEnum
string
_types.mapping.PointProperty
_types.mapping.GeoPointMetricType
string
indices.recovery.TranslogStatus
object
6 properties
5 required
_types.analysis.StopTokenFilter
_types.analysis.PatternAnalyzer
object
7 properties
1 required
_types.analysis.ThaiTokenizer
indices._types.RetentionSource
string
_types.aggregations.MutualInformationHeuristic
object
2 properties
_types.query_dsl.IntervalsFuzzy
object
6 properties
1 required
indices.recovery.RecoveryIndexStatus
object
9 properties
5 required
_types.analysis.IcuFoldingTokenFilter
_types.aggregations.GeoLineAggregation
object
5 properties
1 required
_types.analysis.PatternReplaceCharFilter
_types.analysis.HtmlStripCharFilter
indices.stats.ShardLease
object
4 properties
4 required
indices.forcemerge._types.ForceMergeResponseBody
_types.RRFRetrieverComponent
object
Wraps a retriever with an optional weight for RRF scoring.
2 properties
1 required
_types.analysis.PhoneticEncoder
string
_types.analysis.DutchAnalyzer
object
4 properties
1 required
indices._types.SettingsSimilarityScripted
object
3 properties
2 required
indices._types.IndexSettingsLifecycleStep
object
1 property
_types.ScriptField
object
2 properties
1 required
_types.analysis.SnowballAnalyzer
object
4 properties
2 required
_types.analysis.SoraniNormalizationTokenFilter
_types.mapping.DateNanosProperty
_types.analysis.FrenchAnalyzer
object
4 properties
1 required
_types.aggregations.EwmaMovingAverageAggregation
_types.query_dsl.CombinedFieldsOperator
string
_types.aggregations.AutoDateHistogramAggregation
_types.analysis.ThaiAnalyzer
object
3 properties
1 required
_types.aggregations.PercentileRanksAggregation
_types.query_dsl.Operator
string
_types.query_dsl.RuleQuery
indices.stats.IndexStats
object
19 properties
_types.mapping.DenseVectorIndexOptionsType
string
indices._types.MappingLimitSettingsSourceFields
object
1 property
1 required
_types.analysis.HindiAnalyzer
object
4 properties
1 required
ml._types.ClassificationInferenceOptions
object
5 properties
_types.query_dsl.RankFeatureFunctionLinear
_types.aggregations.PipelineAggregationBase
_types.analysis.ApostropheTokenFilter
_types.KnnSearch
object
12 properties
1 required
_types.query_dsl.FunctionScoreQuery
_types.analysis.BasqueAnalyzer
object
4 properties
1 required
indices._types.SlowlogTresholds
object
2 properties
indices.analyze.AnalyzerDetail
object
2 properties
2 required
_types.analysis.EstonianAnalyzer
object
3 properties
1 required
indices.stats.MappingStats
object
6 properties
5 required
indices.recovery.RecoveryStatus
object
1 property
1 required
_types.mapping.CompositeSubField
object
1 property
1 required
_types.analysis.LatvianAnalyzer
object
4 properties
1 required
_types.query_dsl.GeoShapeQuery
_types.mapping.RankFeatureProperty
_types.analysis.SynonymGraphTokenFilter
_types.mapping.SparseVectorProperty
indices._types.SearchIdle
object
1 property
_types.CommonStatsFlag
string
cluster._types.ComponentTemplateNodeWithRollover
object
8 properties
1 required
_types.aggregations.MovingFunctionAggregation
_types.query_dsl.FieldAndFormat
object
A reference to a field with formatting instructions on how to return the value
3 properties
1 required
_types.GeoHexCell
string
A map hex cell (H3) reference
indices._types.IndexSettingBlocks
object
5 properties
indices.field_usage_stats.FieldsUsageBody
object
1 property
1 required
_types.aggregations.TopMetricsAggregation
_types.RefreshStats
object
7 properties
5 required
_types.analysis.PatternCaptureTokenFilter
indices.resolve_index.ResolveIndexDataStreamsItem
object
3 properties
3 required
_types.GeoHashLocation
object
1 property
1 required
_types.analysis.WordDelimiterTokenFilter
_types.SortOptions
object
4 properties
_types.aggregations.BoxplotAggregation
indices._types.IndexSettings
object
57 properties
_types.analysis.PredicateTokenFilter
_types.mapping.ShortNumberProperty
_types.analysis.SwedishAnalyzer
object
4 properties
1 required
_types.query_dsl.TermsQuery
indices.recovery.FileDetails
object
3 properties
3 required
_types.QueryCacheStats
object
8 properties
7 required
indices._types.IndexTemplateSummaryWithRollover
object
5 properties
_global.search._types.BoundaryScanner
string
_types.ScoreNormalizer
string
_types.analysis.IcuNormalizationCharFilter
_types.aggregations.GeohexGridAggregation
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
_types.mapping.DynamicMapping
string
indices._types.SettingsQueryString
object
1 property
1 required
_types.analysis.NGramTokenFilter
_types.query_dsl.RankFeatureFunctionSaturation
_types.aggregations.StatsAggregation
_types.analysis.ElisionTokenFilter
_types.mapping.TermVectorOption
string
_types.analysis.LithuanianAnalyzer
object
4 properties
1 required
_types.GeoDistanceSort
object
6 properties
_types.mapping.SemanticTextIndexOptions
object
2 properties
indices.analyze.AnalyzeToken
object
6 properties
5 required
_types.analysis.KeywordMarkerTokenFilter
_types.mapping.RuntimeFields
object
indices.recovery.RecoveryStage
string
indices.analyze.TokenDetail
object
2 properties
2 required
_types.analysis.KeywordTokenizer
_types.query_dsl.MatchPhrasePrefixQuery
_types.analysis.KeepTypesMode
string
indices._types.DownsamplingRound
object
2 properties
2 required
_types.FieldSizeUsage
object
2 properties
1 required
_types.aggregations.CartesianCentroidAggregation
_types.Embedding
object
3 properties
1 required
_types.analysis.TokenFilter
_types.analysis.CustomAnalyzer
object
6 properties
2 required
_types.mapping.ObjectProperty
_types.analysis.EdgeNGramTokenizer
indices.shard_stores.ShardStoreWrapper
object
1 property
1 required
_types.query_dsl.SpanTermQuery
indices.segments.Segment
object
9 properties
9 required
_types.CoordsGeoBounds
object
4 properties
4 required
_types.query_dsl.MultiMatchQuery
_types.analysis.BrazilianStemTokenFilter
_types.InferenceStringGroup
_types.query_dsl.GeoExecution
string
_types.aggregations.MetricAggregationBase
object
3 properties
_types.ExpandWildcard
string
_types.query_dsl.UntypedDistanceFeatureQuery
_types.Script
object
5 properties
indices._types.SlowlogTresholdLevels
object
4 properties
_types.query_dsl.ChildScoreMode
string
_types.analysis.AsciiFoldingTokenFilter
_types.GeoLocation
A latitude/longitude as a 2 dimensional point. It can be represented in various ways: - as a {lat, long} object - as a geo hash value - as a [lon, lat] array -…
_types.mapping.DateProperty
indices._types.IndexTemplateDataStreamConfiguration
object
2 properties
_types.aggregations.CompositeAggregationBase
object
6 properties
indices._types.IndexRouting
object
2 properties
_types.analysis.PersianStemTokenFilter
indices.shard_stores.ShardStore
object
3 properties
1 required
_types.aggregations.MatrixStatsAggregation
_types.aggregations.TTestAggregation
_types.aggregations.ScriptedHeuristic
object
1 property
1 required
_types.IBDistribution
string
_types.mapping.RuntimeFieldFetchFields
object
2 properties
1 required
_types.aggregations.FrequentItemSetsAggregation
object
5 properties
1 required
_types.aggregations.FiltersAggregation
_types.mapping.RangePropertyBase
_types.query_dsl.IntervalsAnyOf
object
2 properties
1 required
_types.aggregations.PValueHeuristic
object
2 properties
_types.analysis.DecimalDigitTokenFilter
_types.aggregations.BucketCorrelationAggregation
A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.
_types.GeoTile
string
A map tile reference, represented as {zoom}/{x}/{y}
indices._types.SlowlogSettings
object
4 properties
_types.analysis.TokenFilterDefinition
_types.analysis.ArmenianAnalyzer
object
4 properties
1 required
indices._types.DataStreamOptionsTemplate
object
Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.
1 property
_global.search._types.HighlighterType
_types.WktGeoBounds
object
1 property
1 required
_types.aggregations.ChangePointAggregation
_types.mapping.RuntimeFieldType
string
_types.query_dsl.CombinedFieldsQuery
indices.stats.ShardFileSizeInfo
object
6 properties
2 required
_types.TextEmbedding
object
2 properties
1 required
indices._types.IndexSettingsAnalysis
object
5 properties
_types.mapping.FloatRangeProperty
_types.analysis.KuromojiReadingFormTokenFilter
_types.analysis.Normalizer
indices._types.IndexingSlowlogSettings
object
4 properties
_types.query_dsl.DistanceFeatureQuery
dangling_indices.list_dangling_indices.DanglingIndex
object
4 properties
4 required
_types.mapping.SemanticTextProperty
object
7 properties
1 required
_types.analysis.ConditionTokenFilter
_types.analysis.WhitespaceAnalyzer
object
2 properties
1 required
_types.aggregations.CartesianBoundsAggregation
_types.GeoBounds
A geo bounding box. It can be represented in various ways: - as 4 top/bottom/left/right coordinates - as 2 topleft / bottomright points - as 2 topright / botto…
_global.search._types.SearchRequestBody
object
34 properties
_types.mapping.IpProperty
_types.analysis.HungarianAnalyzer
object
4 properties
1 required
_types.analysis.IcuCollationTokenFilter
indices._types.IndicesBlockOptions
string
_types.TopLeftBottomRightGeoBounds
object
2 properties
2 required
indices.reload_search_analyzers.ReloadDetails
object
3 properties
3 required
_types.query_dsl.IntervalsQuery
_types.NestedSortValue
object
4 properties
1 required
indices.update_aliases.RemoveIndexAction
object
3 properties
_global.search._types.SourceFilter
object
3 properties
_types.query_dsl.RankFeatureFunction
object
indices.stats.ShardsTotalStats
object
1 property
1 required
_types.QueryVectorBuilder
object
3 properties
_types.query_dsl.SpanNotQuery
_types.analysis.NoriTokenizer
_types.analysis.IcuNormalizationType
string
_types.SearchStats
object
21 properties
14 required
indices._types.IndexRoutingRebalance
object
1 property
1 required
indices.stats.ShardStats
object
28 properties
_types.mapping.TokenCountProperty
_types.aggregations.MovingAverageAggregationBase
_types.query_dsl.RegexpQuery
_types.aggregations.FieldDateMath
A date range limit, represented either as a DateMath expression or a number expressed according to the target field's precision.
_types.DiversifyRetrieverTypes
string
_types.analysis.FingerprintAnalyzer
object
6 properties
1 required
_types.aggregations.AverageAggregation
_types.GeoDistanceType
string
_types.TokenPruningConfig
object
3 properties
_types.TopRightBottomLeftGeoBounds
object
2 properties
2 required
indices._types.NumericFielddataFormat
string
indices.segments.ShardsSegment
object
4 properties
4 required
cluster._types.ComponentTemplateSummaryRes
object
7 properties
indices._types.DataStreamLifecycleRolloverConditions
object
10 properties
indices._types.DataStreamLifecycle
object
Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.
7 properties
indices._types.SettingsSimilarityLmj
object
2 properties
1 required
_types.query_dsl.QueryBase
object
2 properties
_types.analysis.PhoneticLanguage
string
_types.query_dsl.PercolateQuery
_types.query_dsl.IntervalsWildcard
object
3 properties
1 required
_types.aggregations.TermsExclude
_types.mapping.HistogramProperty
indices.stats.IndicesStats
object
6 properties
_types.SequenceNumber
number
_types.query_dsl.WrapperQuery
_types.query_dsl.FieldValueFactorScoreFunction
object
4 properties
1 required
_types.analysis.PatternTokenizer
_types.aggregations.TermsAggregationExecutionHint
string
_types.analysis.NoriPartOfSpeechTokenFilter
_types.analysis.RomanianAnalyzer
object
4 properties
1 required
indices.recovery.RecoveryFiles
object
5 properties
4 required
indices.close.CloseShardResult
object
1 property
1 required
_types.analysis.CzechAnalyzer
object
4 properties
1 required
indices._types.FailureStoreLifecycle
object
The failure store lifecycle configures the data stream lifecycle configuration for failure indices.
2 properties
indices._types.FailureStoreLifecycleTemplate
object
Template equivalent of FailureStoreLifecycle that allows nullable values.
2 properties
_types.analysis.TokenizerBase
object
1 property
_types.aggregations.SerialDifferencingAggregation
_types.TranslogStats
object
7 properties
5 required
_types.query_dsl.QueryContainer
object
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
61 properties
_types.mapping.ConstantKeywordProperty
_types.analysis.HindiNormalizationTokenFilter
_types.aggregations.MinimumInterval
string
_types.ScoreSort
object
1 property
indices._types.MappingLimitSettingsDepth
object
1 property
_types.aggregations.BucketSortAggregation
_types.query_dsl.CommonTermsQuery
_types.mapping.FieldMapping
object
2 properties
2 required
_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag
A set of flags that can be represented as a single enum value or a set of values that are encoded as a pipe-separated string Depending on the target language,…
_types.analysis.JaStopTokenFilter
_types.EmptyObject
object
For empty Class assignments
_types.query_dsl.PinnedDoc
object
2 properties
1 required
indices._types.StorageType
_types.RequestCacheStats
object
5 properties
4 required
_types.analysis.ArabicStemTokenFilter
_global.search._types.Rescore
_types.aggregations.BucketsQueryContainer
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.mapping.MatchOnlyTextProperty
object
A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field effectively stores data the same way as a text fiel…
4 properties
1 required
_types.query_dsl.DistanceFeatureQueryBase
_types.aggregations.SumBucketAggregation
_types.aggregations.Missing
_types.aggregations.DateHistogramAggregation
_types.mapping.DocValuesConfig
object
Configuration object for doc values when sub-parameters are needed.
2 properties
_types.query_dsl.RangeQueryBasedouble
indices._types.MappingLimitSettingsDimensionFields
object
1 property
_types.query_dsl.IdsQuery
_types.query_dsl.BoostingQuery
_global.search._types.HighlighterEncoder
string
_types.query_dsl.QueryStringQuery
indices.get_mapping.IndexMappingRecord
object
2 properties
1 required
_types.mapping.SearchAsYouTypeProperty
_types.query_dsl.SpanWithinQuery
indices._types.CacheQueries
object
1 property
1 required
_types.GlobalOrdinalFieldStats
object
3 properties
2 required
_types.MultiTermQueryRewrite
string
_types.analysis.RussianStemTokenFilter
_types.aggregations.WeightedAverageValue
object
3 properties
indices._types.MergeScheduler
object
2 properties
_types.query_dsl.IntervalsRegexp
object
3 properties
1 required
_types.analysis.KeywordAnalyzer
object
2 properties
1 required
_types.TransportAddress
string
_types.query_dsl.DecayFunctionBaseDateMathDuration
object
1 property
indices._types.IndexingPressure
object
1 property
1 required
_types.analysis.KeywordRepeatTokenFilter
_types.analysis.BrazilianAnalyzer
object
3 properties
1 required
_types.analysis.LowercaseNormalizer
object
1 property
1 required
_types.analysis.WhitespaceTokenizer
_global.search._types.InnerHits
object
17 properties
_types.query_dsl.SpanQuery
object
10 properties
indices._types.IndexRoutingAllocationDisk
object
1 property
_types.aggregations.TDigestExecutionHint
string
_global.search._types.RescoreQuery
object
4 properties
1 required
_types.aggregations.MissingOrder
string
_types.mapping.DynamicTemplate
_types.query_dsl.SpanGapQuery
object
Can only be used as a clause in a spannear query.
_types.analysis.WordDelimiterTokenFilterBase
_types.query_dsl.ExistsQuery
_types.analysis.EnglishAnalyzer
object
4 properties
1 required
indices.recovery.RecoveryOrigin
object
12 properties
indices.resolve_index.ResolveIndexAliasItem
object
2 properties
2 required
_types.analysis.SynonymFormat
string
_types.RetrieverContainer
object
9 properties
_types.analysis.SpanishAnalyzer
object
4 properties
1 required
_types.VersionString
string
_types.query_dsl.ParentIdQuery
_types.mapping.SuggestContext
object
4 properties
2 required
indices._types.IndexSettingsTimeSeries
object
3 properties
_types.analysis.FrenchStemTokenFilter
_types.ElasticsearchVersionMinInfo
object
Reduced (minimal) info ElasticsearchVersion
4 properties
4 required
_types.analysis.KeepTypesTokenFilter
_types.RelationName
string
_types.query_dsl.GeoPolygonQuery
_types.mapping.TimeSeriesMetricType
string
indices._types.FielddataFrequencyFilter
object
3 properties
3 required
_types.query_dsl.MatchAllQuery
_types.analysis.NoriAnalyzer
object
5 properties
1 required
_types.analysis.TurkishAnalyzer
object
4 properties
1 required
_types.mapping.ChunkRescorerChunkingSettings
object
6 properties
1 required
indices.close.CloseIndexResult
object
2 properties
1 required
_types.aggregations.IpPrefixAggregation
_types.analysis.IcuCollationCaseFirst
string
indices.simulate_template.Overlapping
object
2 properties
2 required
_types.DataStreamName
string
_types.mapping.IndexField
object
1 property
1 required
_types.analysis.SnowballTokenFilter
_types.mapping.TypeMapping
object
17 properties
_types.aggregations.MissingAggregation
_types.aggregations.MaxAggregation
_types.analysis.PhoneticRuleType
string
indices._types.SettingsHighlight
object
1 property
_types.analysis.UniqueTokenFilter
_types.aggregations.BucketKsAggregation
A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred to as a "K-S test" from now on) against a provided distribution, a…
_types.KnnEmbeddingInput
Knn embedding input. Either a string, an object or array of objects
_types.analysis.BengaliAnalyzer
object
4 properties
1 required
_types.InferenceString
object
3 properties
2 required
_global.search._types.HighlightField
_types.aggregations.SumAggregation
_types.aggregations.ExtendedStatsAggregation
indices._types.IndexMode
string
_types.analysis.SynonymTokenFilterBase
_types.analysis.KuromojiStemmerTokenFilter
_global.search._types.LearningToRank
object
2 properties
1 required
indices._types.SourceMode
string
_types.ScriptSortType
string
_types.mapping.ChunkingSettings
object
6 properties
2 required
_types.mapping.IndexOptions
string
_types.mapping.DenseVectorProperty
indices._types.IndexSettingsLifecycle
object
7 properties
_types.query_dsl.IntervalsContainer
object
8 properties
indices._types.SegmentSortMissing
string
ml._types.RegressionInferenceOptions
object
2 properties
_types.mapping.DenseVectorSimilarity
string
_types.mapping.RuntimeField
object
9 properties
1 required
indices._types.SettingsSimilarityIb
object
4 properties
4 required
_types.DFIIndependenceMeasure
string
_types.mapping.DoubleNumberProperty
_types.query_dsl.RandomScoreFunction
object
2 properties
_types.aggregations.MedianAbsoluteDeviationAggregation
_types.aggregations.RangeAggregation
_types.query_dsl.LikeDocument
object
8 properties
_types.analysis.IcuCollationStrength
string
_types.analysis.GermanStemTokenFilter
_types.analysis.CharFilter
indices.analyze.AnalyzeDetail
object
5 properties
1 required
_types.mapping.DocValues
Defines whether doc values are enabled for a field. Can be a simple boolean, or a configuration object for finer-grained control over sub-parameters such as mu…
_types.mapping.PercolatorProperty
_types.analysis.TruncateTokenFilter
indices._types.Alias
object
6 properties
_types.analysis.LimitTokenCountTokenFilter
indices.remove_block.RemoveIndicesBlockStatus
object
3 properties
1 required
indices._types.DataStreamFailureStore
object
Data stream failure store contains the configuration of the failure store for a given data stream.
2 properties
_types.analysis.GermanAnalyzer
object
4 properties
1 required
_types.aggregations.SamplerAggregation
_types.query_dsl.PinnedQuery
_global.search._types.HighlighterTagsSchema
string
_types.mapping.DynamicProperty
_types.aggregations.IpRangeAggregationRange
object
3 properties
_types.ScriptSort
object
5 properties
1 required
_types.query_dsl.FunctionScoreContainer
_types.analysis.StopAnalyzer
object
4 properties
1 required
_types.aggregations.HoltWintersType
string
indices.shard_stores.ShardStoreAllocation
string
_types.analysis.GalicianAnalyzer
object
4 properties
1 required
_types.ShardStatistics
object
5 properties
3 required
_types.analysis.IcuTokenizer
indices.stats.ShardRoutingState
string
inference._types.EmbeddingContentFormat
string
indices._types.DataStreamOptions
object
Data stream options contain the configuration of data stream level features for a given data stream, for example, the failure store configuration.
1 property
indices.shard_stores.IndicesShardStores
object
1 property
1 required
_types.analysis.WordDelimiterGraphTokenFilter
_types.aggregations.RandomSamplerAggregation
_types.query_dsl.IntervalsAllOf
object
4 properties
1 required
_types.query_dsl.ShapeQuery
_types.analysis.CatalanAnalyzer
object
4 properties
1 required
indices._types.Translog
object
4 properties
_types.analysis.PersianAnalyzer
object
3 properties
1 required
_types.aggregations.NormalizeAggregation
_types.analysis.CjkBigramTokenFilter
_types.analysis.CharFilterDefinition
_types.aggregations.MovingAverageAggregation
indices.shard_stores.ShardStoreStatus
string
_types.query_dsl.SimpleQueryStringFlags
Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX
_types.mapping.PreserveLeafArrays
string
_types.aggregations.CompositeDateHistogramAggregation
_types.analysis.CharGroupTokenizer
_types.aggregations.CardinalityAggregation
_types.query_dsl.RangeRelation
string
_types.analysis.KuromojiTokenizationMode
string
_types.analysis.NGramTokenizer
_types.analysis.KuromojiTokenizer
_types.analysis.StemmerTokenFilter
_types.SegmentsStats
object
23 properties
13 required
_types.analysis.CommonGramsTokenFilter
_types.query_dsl.DecayFunction
_types.query_dsl.PrefixQuery
_types.analysis.IcuCollationDecomposition
string
_types.BulkStats
object
9 properties
5 required
_global.search._types.SourceConfig
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
_types.FlushStats
object
6 properties
4 required
_types.DurationLarge
string
A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
_global.search._types.HighlightBase
object
21 properties
_spec_utils.StringifiedEpochTimeUnitMillis
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_types.LatLonGeoLocation
object
2 properties
2 required
_types.analysis.UaxEmailUrlTokenizer
_types.aggregations.PercentilesAggregation
_types.aggregations.NormalizeMethod
string
_types.analysis.IcuNormalizationTokenFilter
indices._types.DataStreamFailureStoreTemplate
object
Template equivalent of DataStreamFailureStore that allows nullable values.
2 properties
_types.aggregations.VariableWidthHistogramAggregation
object
5 properties
_types.aggregations.RateAggregation
_types.GetStats
object
10 properties
7 required
_types.aggregations.CategorizeTextAggregation
A multi-bucket aggregation that groups semi-structured text into buckets. Each text field is re-analyzed using a custom analyzer. The resulting tokens are then…
_types.query_dsl.IntervalsFilter
object
9 properties
_types.aggregations.TestPopulation
object
3 properties
1 required
_types.aggregations.CustomCategorizeTextAnalyzer
object
3 properties
_types.mapping.GeoStrategy
string
_types.GlobalOrdinalsStats
object
3 properties
1 required
_types.aggregations.MultiTermsAggregation
_global.search._types.Highlight
indices.delete_alias.IndicesAliasesResponseBody
_types.query_dsl.SpanFieldMaskingQuery
indices.get.Feature
string
_types.analysis.ShingleTokenFilter
indices._types.AliasDefinition
object
6 properties
indices._types.TranslogDurability
string
_types.aggregations.GeoLinePoint
object
1 property
1 required
_types.MergesStats
object
16 properties
10 required
_types.aggregations.AdjacencyMatrixAggregation
_types.query_dsl.ScriptQuery
_types.query_dsl.RangeQueryBaseDateMath
_types.DocStats
object
4 properties
2 required
indices._types.MappingLimitSettingsTotalFields
object
2 properties
indices._types.Merge
object
1 property
indices._types.IndexSettingsUnassignedNodeLeft
object
1 property
_types.mapping.WildcardProperty
_types.query_dsl.RangeQuery
_types.mapping.FloatNumberProperty
_types.mapping.GeoOrientation
string
indices.stats.ShardRouting
object
4 properties
3 required
_types.aggregations.TopMetricsValue
object
1 property
1 required
_types.aggregations.CumulativeSumAggregation
indices.get_index_template.IndexTemplateItem
object
2 properties
2 required
indices.recovery.ShardRecovery
object
17 properties
11 required
_types.DurationValueUnitMillis
_types.aggregations.GeoTileGridAggregation
_types.mapping.SourceField
object
4 properties
_types.analysis.TokenFilterBase
object
1 property
_types.query_dsl.DecayFunctionBase
object
1 property
_types.query_dsl.GeoDistanceFeatureQuery
_global.search._types.HighlighterFragmenter
string
_types.mapping.Murmur3HashProperty
_types.FieldValue
A field value.
_types.analysis.ArabicNormalizationTokenFilter
_types.RankContainer
object
1 property
_types.query_dsl.IntervalsPrefix
object
3 properties
1 required
_types.mapping.LongNumberProperty
_types.aggregations.BucketAggregationBase
Base type for bucket aggregations. These aggregations also accept sub-aggregations.
_types.aggregations.ChiSquareHeuristic
object
2 properties
2 required
_types.mapping.IntegerRangeProperty
indices._types.SegmentSortOrder
string
indices.reload_search_analyzers.ReloadResult
object
2 properties
2 required
indices.resolve_index.ResolveIndexItem
object
5 properties
2 required
indices._types.DataStreamLifecycleWithRollover
Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.
_global.search._types.PointInTimeReference
object
2 properties
1 required
indices.add_block.AddIndicesBlockStatus
object
2 properties
2 required
indices.analyze.TextToAnalyze
_types.mapping.DocValuesPropertyBase
_types.mapping.IpRangeProperty
_types.PipelineName
string
_types.analysis.LowercaseTokenizer
_types.query_dsl.MoreLikeThisQuery
indices._types.IndexRoutingAllocationOptions
string
_types.aggregations.CompositeTermsAggregation
_types.query_dsl.RankFeatureFunctionSigmoid
indices.segments.ShardSegmentRouting
object
3 properties
3 required
_types.RescoreVector
object
1 property
1 required
_types.aggregations.TermsAggregationCollectMode
string
_types.analysis.NoriDecompoundMode
string
indices.stats.ShardPath
object
3 properties
3 required
_types.aggregations.WeightedAverageAggregation
_types.AcknowledgedResponseBase
object
1 property
1 required
_types.analysis.SnowballLanguage
string
_types.query_dsl.Like
Text that we want similar documents for or a lookup to a document's field for the text.
_types.aggregations.AggregationContainer
_types.RRFRetrieverEntry
Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight.
_types.MinimumShouldMatch
The minimum number of terms that should match as integer, percentage or range
_types.aggregations.FrequentItemSetsField
object
3 properties
1 required
indices._types.TemplateMapping
object
6 properties
5 required
_types.aggregations.CategorizeTextAnalyzer
_types.query_dsl.ScriptScoreQuery
_types.mapping.DenseVectorIndexOptions
object
7 properties
1 required
_types.aggregations.ReverseNestedAggregation
indices._types.IndexTemplateWithRollover
object
14 properties
2 required
_types.analysis.Tokenizer
_types.aggregations.GeoHashGridAggregation
cluster._types.ComponentTemplate
object
2 properties
2 required
_types.query_dsl.NestedQuery
_types.query_dsl.TermQuery
indices._types.IndexRoutingAllocationInclude
object
2 properties
_types.analysis.StandardTokenizer
_types.IndicesResponseBase
_types.aggregations.EwmaModelSettings
object
1 property
_types.mapping.SparseVectorIndexOptions
object
2 properties
indices.shard_stores.ShardStoreException
object
2 properties
2 required
_types.aggregations.FormatMetricAggregationBase
_types.aggregations.ExtendedBoundsFieldDateMath
object
2 properties
_types.query_dsl.GeoGridQuery
_types.DistanceUnit
string
_types.query_dsl.NumberRangeQuery
_types.aggregations.AverageBucketAggregation
_types.aggregations.CardinalityExecutionMode
string
_types.aggregations.RateMode
string
_types.aggregations.CompositeGeoTileGridAggregation
_types.analysis.BengaliNormalizationTokenFilter
_types.aggregations.DerivativeAggregation
_types.aggregations.CompositeHistogramAggregation
indices._types.IndexRoutingAllocation
object
4 properties
_types.aggregations.HdrMethod
object
1 property
_types.analysis.CjkWidthTokenFilter
_types.VersionNumber
number
_global.search._types.TrackHits
Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response do…
_types.query_dsl.FunctionScoreMode
string
_types.mapping.AllField
object
10 properties
10 required
indices._types.IndexCheckOnStartup
string
_types.analysis.ReverseTokenFilter
indices.stats.IndexMetadataState
string
_types.mapping.NumberPropertyBase
indices._types.NumericFielddata
object
1 property
1 required
_types.query_dsl.GeoValidationMethod
string
_types.DFRBasicModel
string
_types.FielddataStats
object
5 properties
2 required
indices.recovery.RecoveryBytes
object
9 properties
4 required
_types.aggregations.BucketCorrelationFunctionCountCorrelation
object
1 property
1 required
_types.analysis.IcuAnalyzer
object
3 properties
3 required
indices._types.IndexRoutingAllocationInitialRecovery
object
1 property
_types.query_dsl.LongNumberRangeQuery
indices._types.IndexVersioning
object
2 properties
_types.analysis.ClassicTokenizer
_types.Duration
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indica…
_types.mapping.TextIndexPrefixes
object
2 properties
_spec_utils.Stringifiedinteger
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration
indices._types.SettingsSimilarityBm25
object
4 properties
1 required
_types.query_dsl.TermRangeQuery
_types.aggregations.DateRangeExpression
object
3 properties
_types.aggregations.ValueType
string
indices._types.SettingsAnalyze
object
1 property
_global.search._types.Suggester
object
1 property
_types.aggregations.GeoBoundsAggregation
_types.analysis.SerbianNormalizationTokenFilter
_types.mapping.UnsignedLongNumberProperty
_types.analysis.CzechStemTokenFilter
_types.analysis.LowercaseTokenFilterLanguages
string
_types.WaitForActiveShards
indices.stats.ShardCommit
object
4 properties
4 required
_types.LookupQueryVectorBuilder
object
4 properties
3 required
_types.query_dsl.MatchNoneQuery
_types.query_dsl.UntypedDecayFunction
_types.aggregations.SimpleMovingAverageAggregation
_types.mapping.OnScriptError
string
_types.query_dsl.ZeroTermsQuery
string
_types.mapping.ScaledFloatNumberProperty
_types.analysis.GreekAnalyzer
object
3 properties
1 required
_types.ShardsOperationResponseBase
object
1 property
_types.RetrieverBase
object
3 properties
cluster.stats.DenseVectorOffHeapStats
object
15 properties
7 required
indices.simulate_template.Template
object
3 properties
3 required
_spec_utils.NullValue
stringnull
A null value that is to be interpreted as an actual value, unless other uses of null that are equivalent to a missing value. It is used for exemple in settings…
_types.mapping.TextProperty
_types.aggregations.TDigest
object
2 properties
_types.analysis.GermanNormalizationTokenFilter
_types.VersionType
string
_types.analysis.ItalianAnalyzer
object
4 properties
1 required
indices._types.SettingsSimilarityLmd
object
2 properties
1 required
indices.recovery.RecoveryType
string
indices.analyze.ExplainAnalyzeToken
object
9 properties
8 required
_types.aggregations.RareTermsAggregation
_types.aggregations.GeoDistanceAggregation
_types.aggregations.ExtendedBoundsdouble
object
2 properties
_types.aggregations.BucketScriptAggregation
indices._types.MappingLimitSettings
object
Mapping Limit Settings
9 properties
_types.aggregations.TermsInclude
_types.aggregations.LinearMovingAverageAggregation
indices._types.SettingsSimilarity
_types.aggregations.ValueCountAggregation
indices.stats.ShardSequenceNumber
object
3 properties
3 required
_types.analysis.EdgeNGramSide
string
_types.query_dsl.HasChildQuery
_types.analysis.ScandinavianFoldingTokenFilter
_types.query_dsl.DateDistanceFeatureQuery
indices._types.SettingsSearch
object
2 properties
indices.recovery.RecoveryPriority
string
_types.aggregations.GlobalAggregation
_types.mapping.DenseVectorIndexOptionsRescoreVector
object
1 property
1 required
_types.aggregations.Aggregation
object
_types.analysis.StandardAnalyzer
object
4 properties
1 required
_types.analysis.LowercaseTokenFilter
_types.aggregations.TimeSeriesAggregation
_types.query_dsl.SpanOrQuery
_types.query_dsl.BoolQuery
_types.SpecifiedDocument
object
2 properties
1 required
_types.query_dsl.SimpleQueryStringQuery
indices.recovery.VerifyIndex
object
4 properties
2 required
indices._types.IndexingPressureMemory
object
1 property
indices.stats.ShardQueryCache
object
8 properties
7 required
_types.aggregations.InferenceConfigContainer
object
2 properties
_types.aggregations.GapPolicy
string
indices.update_aliases.RemoveAction
object
5 properties
_types.analysis.FlattenGraphTokenFilter
_types.analysis.LengthTokenFilter
_types.analysis.PatternReplaceTokenFilter
_types.query_dsl.RangeQueryBasestring
_types.query_dsl.ScriptScoreFunction
object
1 property
1 required
_types.aggregations.DiversifiedSamplerAggregation
_types.aggregations.NestedAggregation
_types.analysis.CjkBigramIgnoredScript
string
indices._types.IndexSegmentSort
object
4 properties
_types.aggregations.CalendarInterval
string
indices.resolve_cluster.ResolveClusterInfo
object
Provides information about each cluster request relevant to doing a cross-cluster search.
5 properties
2 required
_types.mapping.FieldNamesField
object
1 property
1 required
indices._types.IndexTemplate
object
14 properties
2 required
cluster.stats.SparseVectorStats
object
1 property
1 required
_types.analysis.KeepWordsTokenFilter
_types.analysis.NorwegianAnalyzer
object
4 properties
1 required
_types.mapping.DoubleRangeProperty
_types.mapping.SourceFieldMode
string
indices.rollover.RolloverConditions
object
15 properties
_types.aggregations.CompositeAggregateKey
object
_types.mapping.GeoPointProperty
_types.Normalization
string
_types.analysis.RemoveDuplicatesTokenFilter
_types.query_dsl.MatchQuery
_types.aggregations.CumulativeCardinalityAggregation
_types.mapping.RankFeaturesProperty
_types.analysis.EdgeNGramTokenFilter
indices._types.SettingsSimilarityDfi
object
2 properties
2 required
_types.DFRAfterEffect
string
_types.query_dsl.SimpleQueryStringFlag
string
_types.query_dsl.WeightedTokensQuery
_types.mapping.ByteNumberProperty
_types.Routing
Only to be used in query and path parameters, as the array form is actually a csv
_types.aggregations.BucketsPath
Buckets path can be expressed in different ways, and an aggregation may accept some or all of these forms depending on its type. Please refer to each aggregati…
_types.aggregations.MinBucketAggregation
_types.mapping.ExponentialHistogramProperty
_types.analysis.RussianAnalyzer
object
4 properties
1 required
indices._types.MappingLimitSettingsNestedObjects
object
1 property
indices.analyze.CharFilterDetail
object
2 properties
2 required
_types.aggregations.GeoCentroidAggregation
_types.mapping.HalfFloatNumberProperty
_types.query_dsl.IntervalsRange
object
6 properties
_types.analysis.PathHierarchyTokenizer
_global.search._types.ScriptRescore
object
1 property
1 required
_types.mapping.KeywordProperty
_types.analysis.ChineseAnalyzer
object
3 properties
1 required
_types.query_dsl.RankFeatureFunctionLogarithm
_types.query_dsl.GeoDistanceQuery
_types.analysis.SerbianAnalyzer
object
4 properties
1 required
_types.query_dsl.GeoDecayFunction
_types.aggregations.BucketCorrelationFunction
object
1 property
1 required
_types.analysis.PorterStemTokenFilter
_types.analysis.IcuTransformTokenFilter
_types.analysis.PhoneticTokenFilter
indices.validate_query.IndicesValidationExplanation
object
5 properties
1 required
_types.query_dsl.IntervalsMatch
object
6 properties
1 required
_types.mapping.RoutingField
object
1 property
1 required
_types.aggregations.PercentilesBucketAggregation
_types.ChunkRescorer
object
2 properties
_types.mapping.DateRangeProperty
_types.analysis.SoraniAnalyzer
object
4 properties
1 required
inference._types.EmbeddingContentType
string
_types.aggregations.IpRangeAggregation
_types.analysis.KStemTokenFilter
_types.mapping.BooleanProperty
_types.aggregations.AggregateOrder
_types.aggregations.MinAggregation
_types.aggregations.CompositeAggregationSource
object
4 properties
_types.ErrorCause
object
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on th…
6 properties
1 required
_types.aggregations.HoltLinearModelSettings
object
2 properties
indices._types.MappingLimitSettingsNestedFields
object
1 property
indices.get_field_mapping.TypeFieldMappings
object
1 property
1 required
_types.UnitMillis
number
Time unit for milliseconds
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Elastic Stack (ELK Stack) publishes across the network.