Skip to content

Commit c3ec0f9

Browse files
authored
[DOCS] Rephrases sentence in data_description param of PUT job API docs (#104792) (#104810)
* [DOCS] Rephrase sentence in data_description param of PUT job API docs. * [DOCS] Further edits.
1 parent aa88698 commit c3ec0f9

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/reference/ml/ml-shared.asciidoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -430,16 +430,17 @@ end::daily-model-snapshot-retention-after-days[]
430430

431431
tag::data-description[]
432432
The data description defines the format of the input data when you send data to
433-
the job by using the <<ml-post-data,post data>> API. Note that when configure
434-
a {dfeed}, these properties are automatically set. When data is received via
435-
the <<ml-post-data,post data>> API, it is not stored in {es}. Only the results
436-
for {anomaly-detect} are retained.
433+
the job by using the <<ml-post-data,post data>> API. Note that when using a
434+
{dfeed}, only the `time_field` needs to be set, the rest of the properties are
435+
automatically set. When data is received via the <<ml-post-data,post data>> API,
436+
it is not stored in {es}. Only the results for {anomaly-detect} are retained.
437437
+
438438
.Properties of `data_description`
439439
[%collapsible%open]
440440
====
441441
`format`:::
442-
(string) Only `JSON` format is supported at this time.
442+
(string) Only `xcontent` format is supported at this time, and this is the
443+
default value.
443444

444445
`time_field`:::
445446
(string) The name of the field that contains the timestamp.

0 commit comments

Comments
 (0)