diff --git a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc index 25d488a17388a..ce8f7a44d8ab2 100644 --- a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc @@ -79,6 +79,14 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=size] (Optional, string) include::{docdir}/ml/ml-shared.asciidoc[tag=tags] + +[[ml-get-inference-results]] +==== {api-response-body-title} + +`trained_model_configs`:: +(array) +include::{docdir}/ml/ml-shared.asciidoc[tag=trained-model-configs] + [[ml-get-inference-response-codes]] ==== {api-response-codes-title} diff --git a/docs/reference/ml/ml-shared.asciidoc b/docs/reference/ml/ml-shared.asciidoc index 351557c40afa7..79a021f9cdb8f 100644 --- a/docs/reference/ml/ml-shared.asciidoc +++ b/docs/reference/ml/ml-shared.asciidoc @@ -134,7 +134,8 @@ analysis. You do not need to add fields with unsupported data types to end::analyzed-fields-excludes[] tag::analyzed-fields-includes[] -An array of strings that defines the fields that will be included in the analysis. +An array of strings that defines the fields that will be included in the +analysis. end::analyzed-fields-includes[] tag::assignment-explanation-anomaly-jobs[] @@ -1422,6 +1423,49 @@ The number of `partition` field values that were analyzed by the models. This value is cumulative for all detectors in the job. end::total-partition-field-count[] +tag::trained-model-configs[] +An array of trained model resources, which are sorted by the `model_id` value in +ascending order. + +`model_id`::: +(string) +Idetifier for the trained model. + +`created_by`::: +(string) +Information on the creator of the trained model. + +`version`::: +(string) +The {es} version number in which the trained model was created. + +`create_time`::: +(<>) +The time when the trained model was created. + +`tags`::: +(string) +A comma delimited string of tags. A {infer} model can have many tags, or none. + +`metadata`::: +(object) +An object containing metadata about the trained model. For example, models +created by {dfanalytics} contain an `analysis_config` and an `input` +object. + +`estimated_heap_memory_usage_bytes`::: +(integer) +The estimated heap usage in bytes to keep the trained model in memory. + +`estimated_operations`::: +(integer) +The estimated number of operations to use the trained model. + +`license_level`::: +(string) +The license level of the trained model. +end::trained-model-configs[] + tag::training-percent[] Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example