How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Stack (ELK Stack) ml trained model API

The ml trained model API from Elastic Stack (ELK Stack) — 12 operation(s) for ml trained model.

Elastic Stack (ELK Stack) ml trained model API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ml trained model. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 15 operations across 12 paths, and defines 489 schemas. It is described by OpenAPI 3.2.0.

Requests are made against the base URL https://{elasticsearch_endpoint}.

15 operations 12 paths 489 schemas 2 DELETE4 GET5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
License
Resource Areas
1

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 2 DELETE, 4 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

ml trained model 15
POST
/_ml/trained_models/{model_id}/deployment/cache/_clear
Clear trained model deployment cache
ml-clear-trained-model-deployment-cache 1 param → 200
GET
/_ml/trained_models/{model_id}
Get trained model configuration info
ml-get-trained-models 8 params → 200
PUT
/_ml/trained_models/{model_id}
Create a trained model
ml-put-trained-model 3 params body → 200
DELETE
/_ml/trained_models/{model_id}
Delete an unreferenced trained model
ml-delete-trained-model 3 params → 200
PUT
/_ml/trained_models/{model_id}/model_aliases/{model_alias}
Create or update a trained model alias
ml-put-trained-model-alias 3 params → 200
DELETE
/_ml/trained_models/{model_id}/model_aliases/{model_alias}
Delete a trained model alias
ml-delete-trained-model-alias 2 params → 200
GET
/_ml/trained_models
Get trained model configuration info
ml-get-trained-models-1 7 params → 200
GET
/_ml/trained_models/{model_id}/_stats
Get trained models usage info
ml-get-trained-models-stats 4 params → 200
GET
/_ml/trained_models/_stats
Get trained models usage info
ml-get-trained-models-stats-1 3 params → 200
POST
/_ml/trained_models/{model_id}/_infer
Evaluate a trained model
ml-infer-trained-model 2 params body → 200
PUT
/_ml/trained_models/{model_id}/definition/{part}
Create part of a trained model definition
ml-put-trained-model-definition-part 2 params body → 200
PUT
/_ml/trained_models/{model_id}/vocabulary
Create a trained model vocabulary
ml-put-trained-model-vocabulary 1 param body → 200
POST
/_ml/trained_models/{model_id}/deployment/_start
Start a trained model deployment
ml-start-trained-model-deployment 9 params body → 200
POST
/_ml/trained_models/{model_id}/deployment/_stop
Stop a trained model deployment
ml-stop-trained-model-deployment 3 params body → 200
POST
/_ml/trained_models/{model_id}/deployment/_update
Update a trained model deployment
ml-update-trained-model-deployment 2 params body → 200

Schemas 489

The contract defines 489 schemas that model the data the API accepts and returns. The most detailed are _types.query_dsl.QueryContainer (61 properties), _global.search._types.SearchRequestBody (34 properties), ml._types.TrainedModelConfig (21 properties), _global.search._types.HighlightBase (21 properties). Each schema is shown below with its type and property counts.

_types.query_dsl.SpanContainingQuery
_types.query_dsl.TypeQuery
ml.put_trained_model.Definition
object
2 properties 1 required
ml._types.TrainedModelDeploymentStats
object
18 properties 6 required
_types.aggregations.BucketSelectorAggregation
_types.aggregations.TopHitsAggregation
_types.query_dsl.CombinedFieldsZeroTerms
string
_types.aggregations.TermsPartition
object
2 properties 2 required
_types.query_dsl.GeoBoundingBoxQuery
_types.SortResults
array
_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator
object
3 properties 2 required
ml._types.Vocabulary
object
1 property 1 required
_types.aggregations.ChildrenAggregation
_types.EpochTimeUnitMillis
_types.aggregations.MatrixAggregation
_types.query_dsl.DisMaxQuery
_types.aggregations.SamplerAggregationExecutionHint
string
ml.put_trained_model.TargetMeanEncodingPreprocessor
object
4 properties 4 required
_types.aggregations.MovingPercentilesAggregation
_types.aggregations.HoltWintersModelSettings
object
6 properties
_types.aggregations.HistogramAggregation
_types.GeoTilePrecision
number
_types.aggregations.DateRangeAggregation
_types.aggregations.StringStatsAggregation
_types.aggregations.TTestType
string
_types.TextSimilarityReranker
_types.aggregations.ParentAggregation
_types.aggregations.MaxBucketAggregation
_global.search._types.FieldCollapse
object
4 properties 1 required
_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…
ml._types.TotalFeatureImportance
object
3 properties 3 required
_types.query_dsl.RangeQueryBase
_types.query_dsl.NumericDecayFunction
_types.aggregations.FormattableMetricAggregation
ml._types.QueryFeatureExtractor
object
3 properties 2 required
ml._types.ZeroShotClassificationInferenceUpdateOptions
object
4 properties 1 required
ml.put_trained_model.Weights
object
1 property 1 required
ml._types.TrainedModelSizeStats
object
2 properties 2 required
_types.query_dsl.UntypedRangeQuery
ml._types.PassThroughInferenceUpdateOptions
object
2 properties
_types.IndexName
string
_types.aggregations.GeoLineSort
object
1 property 1 required
_types.aggregations.MultiTermLookup
_types.query_dsl.DecayFunctionBaseGeoLocationDistance
object
1 property
_types.aggregations.CompositeAggregation
_types.query_dsl.SemanticQuery
_types.aggregations.InferenceAggregation
_types.aggregations.HoltWintersMovingAverageAggregation
_types.query_dsl.TextQueryType
string
_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…
_types.aggregations.ScriptedMetricAggregation
ml._types.NlpBertTokenizationConfig
BERT and MPNet tokenization configuration options
_types.aggregations.StatsBucketAggregation
_types.query_dsl.RangeQueryBaselong
ml._types.InferenceConfigCreateContainer
object
Inference configuration provided when storing the model config
11 properties
ml._types.TrainedModelLocation
object
1 property 1 required
_types.aggregations.BucketPathAggregation
_types.aggregations.AggregationRange
object
3 properties
_types.DateFormat
string
_types.DiversifyRetriever
_types.query_dsl.TextExpansionQuery
ml._types.Hyperparameter
object
5 properties 3 required
_types.aggregations.ExtendedStatsBucketAggregation
_types.GeoHash
string
_types.query_dsl.WildcardQuery
_global.search._types.HighlighterOrder
string
_types.query_dsl.FuzzyQuery
_types.UnitFloatMillis
number
Time unit for fractional milliseconds
_types.Id
string
_types.InnerRetriever
object
3 properties 3 required
_types.query_dsl.SparseVectorQuery
_types.SlicedScroll
object
3 properties 2 required
ml._types.TrainedModelStats
object
6 properties 3 required
_types.aggregations.SignificantTextAggregation
ml.put_trained_model.AggregateOutput
object
4 properties
_types.aggregations.SignificantTermsAggregation
ml._types.TrainedModelAssignment
object
7 properties 4 required
_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance
_types.query_dsl.MultiValueMode
string
_types.Sort
_types.aggregations.GoogleNormalizedDistanceHeuristic
object
1 property
_types.query_dsl.TermsSetQuery
_types.aggregations.TermsAggregation
_types.query_dsl.ConstantScoreQuery
_types.query_dsl.DateRangeQuery
ml._types.TrainedModelAssignmentRoutingStateAndReason
object
2 properties 1 required
_types.query_dsl.MatchPhraseQuery
_types.query_dsl.FunctionBoostMode
string
ml._types.TrainedModelInferenceStats
object
5 properties 5 required
_types.query_dsl.DateDecayFunction
_types.query_dsl.DecayFunctionBasedoubledouble
object
1 property
_types.query_dsl.HasParentQuery
_types.query_dsl.SpanMultiTermQuery
_types.SortOrder
string
_types.query_dsl.RankFeatureQuery
_types.aggregations.HoltMovingAverageAggregation
_types.query_dsl.SpanFirstQuery
_types.query_dsl.MatchBoolPrefixQuery
_types.RuleRetriever
ml._types.TrainedModelType
string
_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.Fields
_global.search._types.ScoreMode
string
_types.aggregations.PercentageScoreHeuristic
object
_types.query_dsl.SpanNearQuery
_types.aggregations.MutualInformationHeuristic
object
2 properties
_types.query_dsl.IntervalsFuzzy
object
6 properties 1 required
_types.aggregations.GeoLineAggregation
object
5 properties 1 required
_types.PinnedRetriever
_types.RRFRetrieverComponent
object
Wraps a retriever with an optional weight for RRF scoring.
2 properties 1 required
_types.ScriptField
object
2 properties 1 required
_types.aggregations.EwmaMovingAverageAggregation
_types.query_dsl.CombinedFieldsOperator
string
_types.aggregations.AutoDateHistogramAggregation
_types.aggregations.PercentileRanksAggregation
_types.query_dsl.Operator
string
_types.query_dsl.RuleQuery
ml._types.ModelPackageConfig
object
14 properties 1 required
ml._types.ClassificationInferenceOptions
object
5 properties
_types.query_dsl.RankFeatureFunctionLinear
_types.RrfRank
_types.aggregations.PipelineAggregationBase
_types.KnnSearch
object
12 properties 1 required
_types.query_dsl.FunctionScoreQuery
_types.mapping.CompositeSubField
object
1 property 1 required
_types.query_dsl.GeoShapeQuery
ml._types.TrainedModelPrefixStrings
object
2 properties
_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
_types.aggregations.TopMetricsAggregation
ml._types.QuestionAnsweringInferenceUpdateOptions
object
5 properties 1 required
ml._types.FeatureExtractor
ml._types.DiscoveryNode
object
_types.GeoHashLocation
object
1 property 1 required
_types.SortOptions
object
4 properties
_types.aggregations.BoxplotAggregation
_types.ByteSize
_types.query_dsl.TermsQuery
_global.search._types.BoundaryScanner
string
_types.ScoreNormalizer
string
ml.put_trained_model.Preprocessor
object
3 properties
_types.aggregations.GeohexGridAggregation
_types.DurationValueUnitFloatMillis
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
ml._types.TextExpansionInferenceUpdateOptions
object
2 properties
_types.query_dsl.RankFeatureFunctionSaturation
_types.aggregations.StatsAggregation
_types.GeoDistanceSort
object
6 properties
_types.DateMath
string
ml._types.TrainedModelInferenceFeatureImportance
object
3 properties 1 required
_types.mapping.RuntimeFields
object
_types.TimeZone
string
_types.query_dsl.MatchPhrasePrefixQuery
_types.aggregations.CartesianCentroidAggregation
_types.Embedding
object
3 properties 1 required
_types.query_dsl.SpanTermQuery
ml._types.TokenizationTruncate
string
_types.CoordsGeoBounds
object
4 properties 4 required
_types.query_dsl.MultiMatchQuery
_types.InferenceStringGroup
_types.query_dsl.GeoExecution
string
_types.aggregations.MetricAggregationBase
object
3 properties
ml._types.NerInferenceOptions
object
Named entity recognition options
4 properties
_types.query_dsl.UntypedDistanceFeatureQuery
ml._types.Include
string
_types.Script
object
5 properties
_types.query_dsl.ChildScoreMode
string
_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.aggregations.CompositeAggregationBase
object
6 properties
ml._types.InferenceResponseResult
object
9 properties
_types.aggregations.MatrixStatsAggregation
_types.aggregations.TTestAggregation
_types.aggregations.ScriptedHeuristic
object
1 property 1 required
_types.mapping.RuntimeFieldFetchFields
object
2 properties 1 required
ml._types.DeploymentAssignmentState
string
_types.aggregations.FrequentItemSetsAggregation
object
5 properties 1 required
_types.aggregations.FiltersAggregation
_types.query_dsl.IntervalsAnyOf
object
2 properties 1 required
_types.aggregations.PValueHeuristic
object
2 properties
ml.put_trained_model.OneHotEncodingPreprocessor
object
2 properties 2 required
_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}
_global.search._types.HighlighterType
_types.WktGeoBounds
object
1 property 1 required
_types.aggregations.ChangePointAggregation
_types.mapping.RuntimeFieldType
string
_types.query_dsl.CombinedFieldsQuery
_types.TextEmbedding
object
2 properties 1 required
_types.RescorerRetriever
_types.query_dsl.DistanceFeatureQuery
_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.TopLeftBottomRightGeoBounds
object
2 properties 2 required
_types.query_dsl.IntervalsQuery
_types.NestedSortValue
object
4 properties 1 required
ml.put_trained_model.TrainedModelTree
object
4 properties 2 required
_global.search._types.SourceFilter
object
3 properties
_types.query_dsl.RankFeatureFunction
object
_types.QueryVectorBuilder
object
3 properties
_types.query_dsl.SpanNotQuery
ml._types.TotalFeatureImportanceClass
object
2 properties 2 required
_types.aggregations.MovingAverageAggregationBase
_types.Ids
_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.Metadata
object
_types.aggregations.AverageAggregation
_types.GeoDistanceType
string
_types.TokenPruningConfig
object
3 properties
_types.TopRightBottomLeftGeoBounds
object
2 properties 2 required
_types.query_dsl.QueryBase
object
2 properties
_types.query_dsl.PercolateQuery
_types.query_dsl.IntervalsWildcard
object
3 properties 1 required
_types.aggregations.TermsExclude
_types.query_dsl.WrapperQuery
_types.query_dsl.FieldValueFactorScoreFunction
object
4 properties 1 required
_types.aggregations.TermsAggregationExecutionHint
string
ml._types.TopClassEntry
object
3 properties 3 required
ml._types.TrainedModelEntities
object
5 properties 5 required
_types.aggregations.SerialDifferencingAggregation
ml._types.ZeroShotClassificationInferenceOptions
object
Zero shot classification configuration options
6 properties 1 required
_types.query_dsl.QueryContainer
object
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
61 properties
ml._types.PredictedValue
ml._types.TrainedModelAssignmentRoutingTable
object
4 properties 3 required
_types.aggregations.MinimumInterval
string
_types.ScoreSort
object
1 property
_types.aggregations.BucketSortAggregation
_types.query_dsl.CommonTermsQuery
_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.KnnQuery
_types.Fuzziness
_types.EmptyObject
object
For empty Class assignments
_types.SortMode
string
_types.query_dsl.PinnedDoc
object
2 properties 1 required
_global.search._types.Rescore
_types.QueryVector
array
_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.query_dsl.DistanceFeatureQueryBase
_types.Name
string
_types.aggregations.SumBucketAggregation
_types.aggregations.Missing
_types.aggregations.DateHistogramAggregation
_types.query_dsl.RangeQueryBasedouble
_types.query_dsl.IdsQuery
_types.query_dsl.BoostingQuery
_global.search._types.HighlighterEncoder
string
_types.query_dsl.QueryStringQuery
_types.query_dsl.SpanWithinQuery
_types.MultiTermQueryRewrite
string
_types.aggregations.WeightedAverageValue
object
3 properties
_types.query_dsl.IntervalsRegexp
object
3 properties 1 required
_types.TransportAddress
string
_types.query_dsl.DecayFunctionBaseDateMathDuration
object
1 property
_global.search._types.InnerHits
object
17 properties
_types.query_dsl.SpanQuery
object
10 properties
_types.aggregations.TDigestExecutionHint
string
_global.search._types.RescoreQuery
object
4 properties 1 required
ml._types.XlmRobertaTokenizationConfig
_types.aggregations.MissingOrder
string
_types.ScriptLanguage
_types.query_dsl.SpanGapQuery
object
Can only be used as a clause in a spannear query.
_types.query_dsl.ExistsQuery
_types.RankBase
object
_types.RetrieverContainer
object
9 properties
_types.VersionString
string
_types.query_dsl.ParentIdQuery
_types.RelationName
string
_types.query_dsl.GeoPolygonQuery
_types.query_dsl.MatchAllQuery
_types.KnnRetriever
_types.mapping.ChunkRescorerChunkingSettings
object
6 properties 1 required
_types.aggregations.IpPrefixAggregation
_types.aggregations.MissingAggregation
_types.aggregations.MaxAggregation
_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
ml._types.TrainingPriority
string
_types.RRFRetriever
_types.InferenceString
object
3 properties 2 required
_global.search._types.HighlightField
_types.aggregations.SumAggregation
_types.aggregations.ExtendedStatsAggregation
_global.search._types.LearningToRank
object
2 properties 1 required
ml._types.TrainedModelInferenceClassImportance
object
2 properties 2 required
_types.ScriptSortType
string
_types.query_dsl.IntervalsContainer
object
8 properties
ml._types.RegressionInferenceOptions
object
2 properties
_types.mapping.RuntimeField
object
9 properties 1 required
_types.query_dsl.RandomScoreFunction
object
2 properties
_types.aggregations.MedianAbsoluteDeviationAggregation
_types.aggregations.RangeAggregation
_types.query_dsl.LikeDocument
object
8 properties
ml._types.CommonTokenizationConfig
object
5 properties
ml._types.TrainedModelConfigMetadata
object
4 properties
ml._types.TextEmbeddingInferenceUpdateOptions
object
2 properties
_types.aggregations.SamplerAggregation
_types.query_dsl.PinnedQuery
_global.search._types.HighlighterTagsSchema
string
_types.aggregations.IpRangeAggregationRange
object
3 properties
ml._types.QuestionAnsweringInferenceOptions
object
Question answering inference options
4 properties
_types.ScriptSort
object
5 properties 1 required
_types.query_dsl.FunctionScoreContainer
_types.aggregations.HoltWintersType
string
inference._types.EmbeddingContentFormat
string
_types.aggregations.RandomSamplerAggregation
_types.query_dsl.IntervalsAllOf
object
4 properties 1 required
_types.query_dsl.ShapeQuery
ml._types.DeploymentAllocationState
string
_types.aggregations.NormalizeAggregation
_types.aggregations.MovingAverageAggregation
_types.query_dsl.SimpleQueryStringFlags
Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX
_types.aggregations.CompositeDateHistogramAggregation
_types.Names
_types.aggregations.CardinalityAggregation
_types.query_dsl.RangeRelation
string
ml._types.TrainedModelDeploymentNodesStats
object
19 properties 3 required
_types.query_dsl.DecayFunction
_types.query_dsl.PrefixQuery
_global.search._types.SourceConfig
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
_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
_types.LatLonGeoLocation
object
2 properties 2 required
_types.aggregations.PercentilesAggregation
_types.aggregations.NormalizeMethod
string
_types.aggregations.VariableWidthHistogramAggregation
object
5 properties
_types.aggregations.RateAggregation
_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.aggregations.MultiTermsAggregation
_global.search._types.Highlight
_types.query_dsl.SpanFieldMaskingQuery
ml._types.TrainedModelAssignmentTaskParameters
object
10 properties 9 required
ml._types.TrainedModelDeploymentAllocationStatus
object
3 properties 3 required
ml._types.TextClassificationInferenceUpdateOptions
object
4 properties
_types.aggregations.GeoLinePoint
object
1 property 1 required
_types.aggregations.AdjacencyMatrixAggregation
_types.ScalarValue
A scalar value.
_types.query_dsl.ScriptQuery
ml._types.RoutingState
string
_types.query_dsl.RangeQueryBaseDateMath
ml._types.TokenizationConfigContainer
object
Tokenization options stored in inference configuration
5 properties
_types.query_dsl.RangeQuery
_types.Distance
string
_types.aggregations.TopMetricsValue
object
1 property 1 required
_types.aggregations.CumulativeSumAggregation
_types.aggregations.GeoTileGridAggregation
_types.query_dsl.DecayFunctionBase
object
1 property
_types.query_dsl.GeoDistanceFeatureQuery
_global.search._types.HighlighterFragmenter
string
_types.FieldValue
A field value.
_types.RankContainer
object
1 property
_types.query_dsl.IntervalsPrefix
object
3 properties 1 required
_types.aggregations.BucketAggregationBase
Base type for bucket aggregations. These aggregations also accept sub-aggregations.
_types.aggregations.ChiSquareHeuristic
object
2 properties 2 required
_global.search._types.PointInTimeReference
object
2 properties 1 required
_types.query_dsl.MoreLikeThisQuery
_types.aggregations.CompositeTermsAggregation
ml._types.TextClassificationInferenceOptions
object
Text classification configuration options
5 properties
_types.query_dsl.RankFeatureFunctionSigmoid
ml._types.TrainedModelConfigInput
object
1 property 1 required
_types.RescoreVector
object
1 property 1 required
_types.aggregations.TermsAggregationCollectMode
string
_types.aggregations.WeightedAverageAggregation
_types.AcknowledgedResponseBase
object
1 property 1 required
_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
ml._types.AdaptiveAllocationsSettings
object
3 properties 1 required
_types.aggregations.FrequentItemSetsField
object
3 properties 1 required
_types.aggregations.CategorizeTextAnalyzer
_types.query_dsl.ScriptScoreQuery
_types.aggregations.ReverseNestedAggregation
_types.aggregations.GeoHashGridAggregation
ml._types.TrainedModelConfig
object
21 properties 3 required
_types.query_dsl.NestedQuery
_types.query_dsl.TermQuery
_types.aggregations.EwmaModelSettings
object
1 property
_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
ml.put_trained_model.Input
object
1 property 1 required
_types.aggregations.RateMode
string
_types.aggregations.CompositeGeoTileGridAggregation
_types.aggregations.DerivativeAggregation
_types.aggregations.CompositeHistogramAggregation
ml._types.TextEmbeddingInferenceOptions
object
Text embedding inference options
4 properties
_types.aggregations.HdrMethod
object
1 property
ml._types.FillMaskInferenceOptions
object
Fill mask inference options
5 properties
_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.VersionNumber
number
_types.query_dsl.FunctionScoreMode
string
_types.query_dsl.GeoValidationMethod
string
_types.aggregations.BucketCorrelationFunctionCountCorrelation
object
1 property 1 required
_types.query_dsl.LongNumberRangeQuery
ml._types.TrainedModelLocationIndex
object
1 property 1 required
_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…
ml._types.NerInferenceUpdateOptions
object
2 properties
_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration
_types.query_dsl.TermRangeQuery
_types.aggregations.DateRangeExpression
object
3 properties
_types.aggregations.ValueType
string
_global.search._types.Suggester
object
1 property
_types.aggregations.GeoBoundsAggregation
_types.LinearRetriever
ml._types.InferenceConfigUpdateContainer
object
10 properties
_types.LookupQueryVectorBuilder
object
4 properties 3 required
_types.query_dsl.MatchNoneQuery
_types.query_dsl.UntypedDecayFunction
_types.aggregations.SimpleMovingAverageAggregation
_types.mapping.OnScriptError
string
ml._types.NlpTokenizationUpdateOptions
object
2 properties
_types.query_dsl.ZeroTermsQuery
string
_types.RetrieverBase
object
3 properties
_types.aggregations.TDigest
object
2 properties
_types.VersionType
string
_types.aggregations.RareTermsAggregation
_types.aggregations.GeoDistanceAggregation
_types.aggregations.ExtendedBoundsdouble
object
2 properties
_types.StandardRetriever
ml._types.TotalFeatureImportanceStatistics
object
3 properties 3 required
_types.aggregations.BucketScriptAggregation
ml.put_trained_model.Ensemble
object
5 properties 1 required
_types.aggregations.TermsInclude
_types.aggregations.LinearMovingAverageAggregation
ml._types.FillMaskInferenceUpdateOptions
object
3 properties
_types.aggregations.ValueCountAggregation
ml._types.TextExpansionInferenceOptions
object
Text expansion inference options
3 properties
_types.query_dsl.HasChildQuery
_types.query_dsl.DateDistanceFeatureQuery
_types.aggregations.GlobalAggregation
_types.aggregations.Aggregation
object
_types.aggregations.TimeSeriesAggregation
_types.query_dsl.SpanOrQuery
_types.query_dsl.BoolQuery
_types.SpecifiedDocument
object
2 properties 1 required
_types.query_dsl.SimpleQueryStringQuery
_types.aggregations.InferenceConfigContainer
object
2 properties
_types.SortCombinations
_types.aggregations.GapPolicy
string
_types.query_dsl.RangeQueryBasestring
_types.query_dsl.ScriptScoreFunction
object
1 property 1 required
_types.aggregations.DiversifiedSamplerAggregation
_types.aggregations.NestedAggregation
_types.aggregations.CalendarInterval
string
_types.ScriptSource
ml._types.PassThroughInferenceOptions
object
Pass through configuration options
3 properties
_types.aggregations.CompositeAggregateKey
object
_types.query_dsl.MatchQuery
_types.aggregations.CumulativeCardinalityAggregation
_types.query_dsl.SimpleQueryStringFlag
string
_types.query_dsl.WeightedTokensQuery
_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.aggregations.GeoCentroidAggregation
_types.query_dsl.IntervalsRange
object
6 properties
_global.search._types.ScriptRescore
object
1 property 1 required
_types.query_dsl.RankFeatureFunctionLogarithm
_types.query_dsl.GeoDistanceQuery
_types.query_dsl.GeoDecayFunction
_types.aggregations.BucketCorrelationFunction
object
1 property 1 required
ml.put_trained_model.TrainedModel
object
3 properties
_types.query_dsl.IntervalsMatch
object
6 properties 1 required
_types.aggregations.PercentilesBucketAggregation
_types.ChunkRescorer
object
2 properties
ml._types.LearningToRankConfig
object
3 properties 1 required
inference._types.EmbeddingContentType
string
_types.aggregations.IpRangeAggregation
ml.put_trained_model.TrainedModelTreeNode
object
9 properties 1 required
_types.aggregations.AggregateOrder
ml._types.DiscoveryNodeContent
object
9 properties 8 required
_types.aggregations.MinAggregation
ml._types.NlpRobertaTokenizationConfig
RoBERTa tokenization configuration options
_types.aggregations.CompositeAggregationSource
object
4 properties
_types.aggregations.HoltLinearModelSettings
object
2 properties
_types.UnitMillis
number
Time unit for milliseconds
ml.put_trained_model.FrequencyEncodingPreprocessor
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-ml-trained-model-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) ml trained model API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.