honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-04-01 12:58:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Fix from and size descriptions for model APIs (#62128)

Browse Source
This commit is contained in:
Lisa Cawley 2020-09-08 12:54:51 -07:00 committed by lcawl
parent b8e9a7125f
commit 78b955eb86
3 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc
View File

@ -59,11 +59,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models]
`from`:: `from`::
(Optional, integer) (Optional, integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from-models]
`size`:: `size`::
(Optional, integer) (Optional, integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size-models]
[role="child_attributes"] [role="child_attributes"]
[[ml-get-inference-stats-results]] [[ml-get-inference-stats-results]]

16
docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc
View File

@ -64,9 +64,15 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models]
Specifies whether the included model definition should be returned as a JSON map Specifies whether the included model definition should be returned as a JSON map
(`true`) or in a custom compressed format (`false`). Defaults to `true`. (`true`) or in a custom compressed format (`false`). Defaults to `true`.
`for_export`::
(Optional, boolean)
Indicates if certain fields should be removed from the model configuration on
retrieval. This allows the model to be in an acceptable format to be retrieved
and then added to another cluster. Default is false.
`from`:: `from`::
(Optional, integer) (Optional, integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from-models]
`include_model_definition`:: `include_model_definition`::
(Optional, boolean) (Optional, boolean)
@ -76,18 +82,12 @@ Otherwise, a bad request is returned.
`size`:: `size`::
(Optional, integer) (Optional, integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size-models]
`tags`:: `tags`::
(Optional, string) (Optional, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=tags] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=tags]
`for_export`::
(Optional, boolean)
Indicates if certain fields should be removed from the model configuration on
retrieval. This allows the model to be in an acceptable format to be retrieved
and then added to another cluster. Default is false.
[role="child_attributes"] [role="child_attributes"]
[[ml-get-inference-results]] [[ml-get-inference-results]]
== {api-response-body-title} == {api-response-body-title}

9
docs/reference/ml/ml-shared.asciidoc
View File

@ -691,6 +691,10 @@ tag::from[]
Skips the specified number of {dfanalytics-jobs}. The default value is `0`. Skips the specified number of {dfanalytics-jobs}. The default value is `0`.
end::from[] end::from[]
tag::from-models[]
Skips the specified number of models. The default value is `0`.
end::from-models[]
tag::function[] tag::function[]
The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, The analysis function that is used. For example, `count`, `rare`, `mean`, `min`,
`max`, and `sum`. For more information, see `max`, and `sum`. For more information, see
@ -1275,6 +1279,11 @@ Specifies the maximum number of {dfanalytics-jobs} to obtain. The default value
is `100`. is `100`.
end::size[] end::size[]
tag::size-models[]
Specifies the maximum number of models to obtain. The default value
is `100`.
end::size-models[]
tag::snapshot-id[] tag::snapshot-id[]
A numerical character string that uniquely identifies the model snapshot. A numerical character string that uniquely identifies the model snapshot.
end::snapshot-id[] end::snapshot-id[]