Get trained model configuration info
- GET /_ml/trained_models/{model_id}
- GET /_ml/trained_models
- Cluster privileges:
monitor_ml
Path Parameters
-
model_idId | Idoptional -
The unique identifier of the trained model or a model alias.
You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.
Leave it out to use
/_ml/trained_models.
Query Parameters
-
allow_no_matchboolean · default: true Specifies what to do when the request:
- Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches.
If true, it returns an empty array when there are no matches and the subset of results when there are partial matches.
-
decompress_definitionboolean · default: true Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).
-
exclude_generatedboolean · default: false Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.
-
fromnumber · default: 0 Skips the specified number of models.
-
includeInclude A comma delimited string of optional fields to include in the response body.
Supported values include:
definition: Includes the model definition.feature_importance_baseline: Includes the baseline for feature importance values.hyperparameters: Includes the information about hyperparameters used to train the model. This information consists of the value, the absolute and relative importance of the hyperparameter as well as an indicator of whether it was specified by the user or tuned during hyperparameter optimization.total_feature_importance: Includes the total feature importance for the training data set. The baseline and total feature importance values are returned in the metadata field in the response body.definition_status: Includes the model definition status.
-
Values:
definitionfeature_importance_baselinehyperparameterstotal_feature_importancedefinition_status -
include_model_definitionbooleandeprecated parameter is deprecated! Use [include=definition] instead
-
sizenumber · default: 100 Specifies the maximum number of models to obtain.
A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned.
Response
-
countnumberrequired -
trained_model_configsTrainedModelConfigrequired -
An array of trained model resources, which are sorted by the model_id value in ascending order.
-
model_idstring Idrequired -
Identifier for the trained model.
-
model_typeTrainedModelType -
The model type
Supported values include:
tree_ensemble: The model definition is an ensemble model of decision trees.lang_ident: A special type reserved for language identification models.pytorch: The stored definition is a PyTorch (specifically a TorchScript) model. Currently only NLP models are supported.
-
Values:
tree_ensemblelang_identpytorch -
A comma delimited string of tags. A trained model can have many tags, or none.
-
versionstring -
The Elasticsearch version number in which the trained model was created.
-
compressed_definitionstring -
created_bystring -
Information on the creator of the trained model.
-
create_timeDateTime -
The time when the trained model was created.
-
default_field_mapmap string to string -
Any field map described in the inference configuration takes precedence.
-
descriptionstring -
The free-text description of the trained model.
-
estimated_heap_memory_usage_bytesnumber -
The estimated heap usage in bytes to keep the trained model in memory.
-
estimated_operationsnumber -
The estimated number of operations to use the trained model.
-
fully_definedboolean -
True if the full model definition is present.
-
inference_configInferenceConfigCreateContainer -
The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required.
-
regressionRegressionInferenceOptions -
Regression configuration for inference.
-
results_fieldstring Field -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
num_top_feature_importance_valuesnumber · default: 0 -
Specifies the maximum number of feature importance values per document.
-
classificationClassificationInferenceOptions -
Classification configuration for inference.
-
num_top_classesnumber -
Specifies the number of top class predictions to return. Defaults to 0.
-
num_top_feature_importance_valuesnumber · default: 0 -
Specifies the maximum number of feature importance values per document.
-
prediction_field_typestring -
Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.
-
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
top_classes_results_fieldstring -
Specifies the field to which the top classes are written. Defaults to top_classes.
-
text_classificationTextClassificationInferenceOptions -
Text classification configuration for inference.
-
num_top_classesnumber -
Specifies the number of top class predictions to return. Defaults to 0.
-
tokenizationTokenizationConfigContainer -
The tokenization options
-
bertNlpBertTokenizationConfig -
Indicates BERT tokenization and its options
-
do_lower_caseboolean · default: false -
Should the tokenizer lower case the text
-
max_sequence_lengthnumber · default: 512 -
Maximum input sequence length for the model
-
spannumber · default: -1 -
Tokenization spanning options. Special value of -1 indicates no spanning takes place
-
truncateTokenizationTruncate · default: first -
Should tokenization input be automatically truncated before sending to the model for inference
-
Values:
firstsecondnone -
with_special_tokensboolean · default: true -
Is tokenization completed with special tokens
-
bert_jaNlpBertTokenizationConfig -
Indicates BERT Japanese tokenization and its options
-
do_lower_caseboolean · default: false -
Should the tokenizer lower case the text
-
max_sequence_lengthnumber · default: 512 -
Maximum input sequence length for the model
-
spannumber · default: -1 -
Tokenization spanning options. Special value of -1 indicates no spanning takes place
-
truncateTokenizationTruncate · default: first -
Should tokenization input be automatically truncated before sending to the model for inference
-
Values:
firstsecondnone -
with_special_tokensboolean · default: true -
Is tokenization completed with special tokens
-
mpnetNlpBertTokenizationConfig -
Indicates MPNET tokenization and its options
-
do_lower_caseboolean · default: false -
Should the tokenizer lower case the text
-
max_sequence_lengthnumber · default: 512 -
Maximum input sequence length for the model
-
spannumber · default: -1 -
Tokenization spanning options. Special value of -1 indicates no spanning takes place
-
truncateTokenizationTruncate · default: first -
Should tokenization input be automatically truncated before sending to the model for inference
-
Values:
firstsecondnone -
with_special_tokensboolean · default: true -
Is tokenization completed with special tokens
-
robertaNlpRobertaTokenizationConfig -
Indicates RoBERTa tokenization and its options
-
do_lower_caseboolean · default: false -
Should the tokenizer lower case the text
-
max_sequence_lengthnumber · default: 512 -
Maximum input sequence length for the model
-
spannumber · default: -1 -
Tokenization spanning options. Special value of -1 indicates no spanning takes place
-
truncateTokenizationTruncate · default: first -
Should tokenization input be automatically truncated before sending to the model for inference
-
Values:
firstsecondnone -
with_special_tokensboolean · default: true -
Is tokenization completed with special tokens
-
add_prefix_spaceboolean · default: false -
Should the tokenizer prefix input with a space character
-
xlm_robertaXlmRobertaTokenizationConfig -
do_lower_caseboolean · default: false -
Should the tokenizer lower case the text
-
max_sequence_lengthnumber · default: 512 -
Maximum input sequence length for the model
-
spannumber · default: -1 -
Tokenization spanning options. Special value of -1 indicates no spanning takes place
-
truncateTokenizationTruncate · default: first -
Should tokenization input be automatically truncated before sending to the model for inference
-
Values:
firstsecondnone -
with_special_tokensboolean · default: true -
Is tokenization completed with special tokens
-
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
classification_labelsstring -
Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels
-
vocabularyVocabulary -
indexstring IndexNamerequired -
zero_shot_classificationZeroShotClassificationInferenceOptions -
Zeroshot classification configuration for inference.
-
tokenizationTokenizationConfigContainer -
The tokenization options to update when inferring
-
hypothesis_templatestring · default: "This example is {}." -
Hypothesis template used when tokenizing labels for prediction
-
classification_labelsstringrequired -
The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction
-
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
multi_labelboolean · default: false -
Indicates if more than one true label exists.
-
labelsstring -
The labels to predict.
-
fill_maskFillMaskInferenceOptions -
Fill mask configuration for inference.
-
mask_tokenstring -
The string/token which will be removed from incoming documents and replaced with the inference prediction(s). In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, otherwise the request will fail.
-
num_top_classesnumber -
Specifies the number of top class predictions to return. Defaults to 0.
-
tokenizationTokenizationConfigContainer -
The tokenization options to update when inferring
-
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
vocabularyVocabulary -
indexstring IndexNamerequired -
learning_to_rankLearningToRankConfig -
default_paramsmap string to object -
feature_extractorsstring to FeatureExtractor -
num_top_feature_importance_valuesnumberrequired -
nerNerInferenceOptions -
Named entity recognition configuration for inference.
-
tokenizationTokenizationConfigContainer -
The tokenization options
-
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
classification_labelsstring -
The token classification labels. Must be IOB formatted tags
-
vocabularyVocabulary -
indexstring IndexNamerequired -
pass_throughPassThroughInferenceOptions -
Pass through configuration for inference.
-
tokenizationTokenizationConfigContainer -
The tokenization options
-
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
vocabularyVocabulary -
indexstring IndexNamerequired -
text_embeddingTextEmbeddingInferenceOptions -
Text embedding configuration for inference.
-
embedding_sizenumber -
The number of dimensions in the embedding output
-
tokenizationTokenizationConfigContainer -
The tokenization options
-
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
vocabularyVocabulary -
indexstring IndexNamerequired -
text_expansionTextExpansionInferenceOptions -
Text expansion configuration for inference.
-
tokenizationTokenizationConfigContainer -
The tokenization options
-
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
vocabularyVocabulary -
indexstring IndexNamerequired -
question_answeringQuestionAnsweringInferenceOptions -
Question answering configuration for inference.
-
num_top_classesnumber -
Specifies the number of top class predictions to return. Defaults to 0.
-
tokenizationTokenizationConfigContainer -
The tokenization options to update when inferring
-
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
max_answer_lengthnumber -
The maximum answer length to consider
-
inputTrainedModelConfigInputrequired -
The input field names for the model definition.
-
field_namesstring Fieldrequired -
An array of input field names for the model.
-
license_levelstring -
The license level of the trained model.
-
metadataTrainedModelConfigMetadata -
An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects.
-
model_aliasesstring -
feature_importance_baselinemap string to string -
An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.
-
hyperparametersHyperparameter -
List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.
-
absolute_importancenumber -
A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.
-
namestring Namerequired -
Name of the hyperparameter.
-
relative_importancenumber -
A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.
-
suppliedbooleanrequired -
Indicates if the hyperparameter is specified by the user (true) or optimized (false).
-
valuenumberrequired -
The value of the hyperparameter, either optimized or specified by the user.
-
total_feature_importanceTotalFeatureImportance -
An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.
-
feature_namestring Namerequired -
The feature for which this importance was calculated.
-
importanceTotalFeatureImportanceStatisticsrequired -
A collection of feature importance statistics related to the training data set for this particular feature.
-
mean_magnitudenumberrequired -
The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature.
-
maxnumberrequired -
The maximum importance value across all the training data for this feature.
-
minnumberrequired -
The minimum importance value across all the training data for this feature.
-
classesTotalFeatureImportanceClassrequired -
If the trained model is a classification model, feature importance statistics are gathered per target class value.
-
class_namestring Namerequired -
The target class value. Could be a string, boolean, or number.
-
importanceTotalFeatureImportanceStatisticsrequired -
A collection of feature importance statistics related to the training data set for this particular feature.
-
mean_magnitudenumberrequired -
The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature.
-
maxnumberrequired -
The maximum importance value across all the training data for this feature.
-
minnumberrequired -
The minimum importance value across all the training data for this feature.
-
model_size_bytesnumber | string ByteSize -
model_packageModelPackageConfig -
create_timeEpochTimeUnitMillis -
descriptionstring -
inference_configmap string to object -
metadataMetadata -
minimum_versionstring -
model_repositorystring -
model_typestring -
packaged_model_idstring Idrequired -
platform_architecturestring -
prefix_stringsTrainedModelPrefixStrings -
sizenumber | string ByteSize -
sha256string -
vocabulary_filestring -
locationTrainedModelLocation -
platform_architecturestring -
prefix_stringsTrainedModelPrefixStrings