Skip to content

Commit 182dc4d

Browse files
committed
[DOCS] Fix from and size descriptions for model APIs (#62128)
1 parent e423c4b commit 182dc4d

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
@@ -59,11 +59,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models]
5959

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

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

6868
[role="child_attributes"]
6969
[[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
@@ -64,9 +64,15 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models]
6464
Specifies whether the included model definition should be returned as a JSON map
6565
(`true`) or in a custom compressed format (`false`). Defaults to `true`.
6666

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

7177
`include_model_definition`::
7278
(Optional, boolean)
@@ -76,18 +82,12 @@ Otherwise, a bad request is returned.
7682

7783
`size`::
7884
(Optional, integer)
79-
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size]
85+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size-models]
8086

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

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

docs/reference/ml/ml-shared.asciidoc

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

677+
tag::from-models[]
678+
Skips the specified number of models. The default value is `0`.
679+
end::from-models[]
680+
677681
tag::function[]
678682
The analysis function that is used. For example, `count`, `rare`, `mean`, `min`,
679683
`max`, and `sum`. For more information, see
@@ -1258,6 +1262,11 @@ Specifies the maximum number of {dfanalytics-jobs} to obtain. The default value
12581262
is `100`.
12591263
end::size[]
12601264

1265+
tag::size-models[]
1266+
Specifies the maximum number of models to obtain. The default value
1267+
is `100`.
1268+
end::size-models[]
1269+
12611270
tag::snapshot-id[]
12621271
A numerical character string that uniquely identifies the model snapshot.
12631272
end::snapshot-id[]

0 commit comments

Comments
 (0)