Skip to content

Commit

Permalink
[DOCS] Adds response body documentation to GET inference API (#53050)
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve committed Mar 3, 2020
1 parent b7957ec commit 07eda6c
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,13 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=include-model-definition]
include::{docdir}/ml/ml-shared.asciidoc[tag=size]


[[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}

Expand Down
65 changes: 64 additions & 1 deletion docs/reference/ml/ml-shared.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,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::background-persist-interval[]
Expand Down Expand Up @@ -1091,6 +1092,68 @@ that tokenizer but change the character or token filters, specify
`"tokenizer": "ml_classic"` in your `categorization_analyzer`.
end::tokenizer[]

tag::total-by-field-count[]
The number of `by` field values that were analyzed by the models. This value is
cumulative for all detectors in the job.
end::total-by-field-count[]

tag::total-category-count[]
The number of categories created by categorization.
end::total-category-count[]

tag::total-over-field-count[]
The number of `over` field values that were analyzed by the models. This value
is cumulative for all detectors in the job.
end::total-over-field-count[]

tag::total-partition-field-count[]
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`:::
(<<time-units,time units>>)
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
Expand Down

0 comments on commit 07eda6c

Please sign in to comment.