Evaluate a trained model
- POST /_ml/trained_models/{model_id}/_infer
Path Parameters
-
model_idstring Idrequired -
The unique identifier of the trained model.
Query Parameters
-
timeoutstring Duration · default: 10s Controls the amount of time to wait for inference results.
Request
-
docsstring to objectrequired -
An array of objects to pass to the model for inference. The objects should contain a fields matching your configured trained model input. Typically, for NLP models, the field name is
text_field. Currently, for NLP models, only a single value is allowed. -
inference_configInferenceConfigUpdateContainer -
The inference configuration updates to apply on the API call
-
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_classificationTextClassificationInferenceUpdateOptions -
Text classification configuration for inference.
-
num_top_classesnumber -
Specifies the number of top class predictions to return. Defaults to 0.
-
tokenizationNlpTokenizationUpdateOptions -
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.
-
classification_labelsstring -
Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels
-
zero_shot_classificationZeroShotClassificationInferenceUpdateOptions -
Zeroshot classification configuration for inference.
-
tokenizationNlpTokenizationUpdateOptions -
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.
-
multi_labelboolean -
Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value.
-
labelsstringrequired -
The labels to predict.
-
fill_maskFillMaskInferenceUpdateOptions -
Fill mask configuration for inference.
-
num_top_classesnumber -
Specifies the number of top class predictions to return. Defaults to 0.
-
tokenizationNlpTokenizationUpdateOptions -
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.
-
nerNerInferenceUpdateOptions -
Named entity recognition configuration for inference.
-
tokenizationNlpTokenizationUpdateOptions -
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.
-
pass_throughPassThroughInferenceUpdateOptions -
Pass through configuration for inference.
-
tokenizationNlpTokenizationUpdateOptions -
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.
-
text_embeddingTextEmbeddingInferenceUpdateOptions -
Text embedding configuration for inference.
-
tokenizationNlpTokenizationUpdateOptions -
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
text_expansionTextExpansionInferenceUpdateOptions -
Text expansion configuration for inference.
-
tokenizationNlpTokenizationUpdateOptions -
results_fieldstring -
The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
-
question_answeringQuestionAnsweringInferenceUpdateOptions -
Question answering configuration for inference
-
questionstringrequired -
The question to answer given the inference context
-
num_top_classesnumber -
Specifies the number of top class predictions to return. Defaults to 0.
-
tokenizationNlpTokenizationUpdateOptions -
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 for extraction
Response
-
inference_resultsInferenceResponseResultrequired -
entitiesTrainedModelEntities -
If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities.
-
class_namestringrequired -
class_probabilitynumberrequired -
entitystringrequired -
start_posnumberrequired -
end_posnumberrequired -
is_truncatedboolean -
Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property is present only when it is true.
-
predicted_valueoneOfnullable -
If the model is trained for a text classification or zero shot classification task, the response is the predicted class. For named entity recognition (NER) tasks, it contains the annotated text output. For fill mask tasks, it contains the top prediction for replacing the mask token. For text embedding tasks, it contains the raw numerical text embedding values. For regression models, its a numerical value For classification models, it may be an integer, double, boolean or string depending on prediction type
-
predicted_value_sequencestring -
For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted value. Additionally
-
prediction_probabilitynumber -
Specifies a probability for the predicted value.
-
prediction_scorenumber -
Specifies a confidence score for the predicted value.
-
top_classesTopClassEntry -
For fill mask, text classification, and zero shot classification tasks, the response contains a list of top class entries.
-
class_namestringrequired -
class_probabilitynumberrequired -
class_scorenumberrequired -
warningstring -
If the request failed, the response contains the reason for the failure.
-
feature_importanceTrainedModelInferenceFeatureImportance -
The feature importance for the inference results. Relevant only for classification or regression models
-
feature_namestringrequired -
importancenumber -
classesTrainedModelInferenceClassImportance -
class_namestringrequired -
importancenumberrequired