Skip to content

Commit 1e6cdca

Browse files
authored
[DOCS] Fix from and size descriptions for model APIs (#62128)
1 parent 3937b20 commit 1e6cdca

File tree

3 files changed

+19
-10
lines changed

3 files changed

+19
-10
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models]
6060

6161
`from`::
6262
(Optional, integer)
63-
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from]
63+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from-models]
6464

6565
`size`::
6666
(Optional, integer)
67-
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size]
67+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size-models]
6868

6969
[role="child_attributes"]
7070
[[ml-get-inference-stats-results]]

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

+8-8
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,15 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models]
6565
Specifies whether the included model definition should be returned as a JSON map
6666
(`true`) or in a custom compressed format (`false`). Defaults to `true`.
6767

68+
`for_export`::
69+
(Optional, boolean)
70+
Indicates if certain fields should be removed from the model configuration on
71+
retrieval. This allows the model to be in an acceptable format to be retrieved
72+
and then added to another cluster. Default is false.
73+
6874
`from`::
6975
(Optional, integer)
70-
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from]
76+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from-models]
7177

7278
`include_model_definition`::
7379
(Optional, boolean)
@@ -77,18 +83,12 @@ Otherwise, a bad request is returned.
7783

7884
`size`::
7985
(Optional, integer)
80-
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size]
86+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size-models]
8187

8288
`tags`::
8389
(Optional, string)
8490
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=tags]
8591

86-
`for_export`::
87-
(Optional, boolean)
88-
Indicates if certain fields should be removed from the model configuration on
89-
retrieval. This allows the model to be in an acceptable format to be retrieved
90-
and then added to another cluster. Default is false.
91-
9292
[role="child_attributes"]
9393
[[ml-get-inference-results]]
9494
== {api-response-body-title}

docs/reference/ml/ml-shared.asciidoc

+9
Original file line numberDiff line numberDiff line change
@@ -696,6 +696,10 @@ tag::from[]
696696
Skips the specified number of {dfanalytics-jobs}. The default value is `0`.
697697
end::from[]
698698

699+
tag::from-models[]
700+
Skips the specified number of models. The default value is `0`.
701+
end::from-models[]
702+
699703
tag::function[]
700704
The analysis function that is used. For example, `count`, `rare`, `mean`, `min`,
701705
`max`, and `sum`. For more information, see
@@ -1280,6 +1284,11 @@ Specifies the maximum number of {dfanalytics-jobs} to obtain. The default value
12801284
is `100`.
12811285
end::size[]
12821286

1287+
tag::size-models[]
1288+
Specifies the maximum number of models to obtain. The default value
1289+
is `100`.
1290+
end::size-models[]
1291+
12831292
tag::snapshot-id[]
12841293
Identifier for the model snapshot.
12851294
end::snapshot-id[]

0 commit comments

Comments
 (0)