mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
[DOCS] Reformats ML update APIs (#45253)
This commit is contained in:
Lisa Cawley
GitHub
parent
1cc4aa176f
commit
46912c8f3d
7 changed files with 64 additions and 65 deletions
|
|
@ -4,14 +4,13 @@
|
|||
:response: PutFilterResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Update Filter API
|
||||
=== Update filter API
|
||||
|
||||
The Update Filter API can be used to update an existing {ml} filter
|
||||
in the cluster. The API accepts a +{request}+ object
|
||||
as a request and returns a +{response}+.
|
||||
Updates an existing {ml} filter in the cluster. The API accepts a +{request}+
|
||||
object as a request and returns a +{response}+.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Update Filter Request
|
||||
==== Update filter request
|
||||
|
||||
A +{request}+ requires the following argument:
|
||||
|
||||
|
|
@ -19,28 +18,28 @@ A +{request}+ requires the following argument:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> The id of the existing {ml} filter
|
||||
<1> The id of the existing {ml} filter.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-description]
|
||||
--------------------------------------------------
|
||||
<1> The updated description of the {ml} filter
|
||||
<1> The updated description of the {ml} filter.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-add-items]
|
||||
--------------------------------------------------
|
||||
<1> The list of items to add to the {ml} filter
|
||||
<1> The list of items to add to the {ml} filter.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-remove-items]
|
||||
--------------------------------------------------
|
||||
<1> The list of items to remove from the {ml} filter
|
||||
<1> The list of items to remove from the {ml} filter.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
|
|
@ -54,4 +53,4 @@ the updated {ml} filter if it has been successfully updated.
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The updated `MlFilter`
|
||||
<1> The updated `MlFilter`.
|
||||
|
|
|
|||
|
|
@ -4,14 +4,13 @@
|
|||
:response: PutJobResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Update Job API
|
||||
=== Update {anomaly-job} API
|
||||
|
||||
The Update Job API provides the ability to update a {ml} job.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Provides the ability to update an {anomaly-job}.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Update Job Request
|
||||
==== Update {anomaly-job} request
|
||||
|
||||
An +{request}+ object gets created with a `JobUpdate` object.
|
||||
|
||||
|
|
@ -19,43 +18,44 @@ An +{request}+ object gets created with a `JobUpdate` object.
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing a `JobUpdate` object
|
||||
<1> Constructing a new request referencing a `JobUpdate` object.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
|
||||
The `JobUpdate` object has many optional arguments with which to update an existing {ml}
|
||||
job. An existing, non-null `jobId` must be referenced in its creation.
|
||||
The `JobUpdate` object has many optional arguments with which to update an
|
||||
existing {anomaly-job}. An existing, non-null `jobId` must be referenced in its
|
||||
creation.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-options]
|
||||
--------------------------------------------------
|
||||
<1> Mandatory, non-null `jobId` referencing an existing {ml} job
|
||||
<2> Updated description
|
||||
<3> Updated analysis limits
|
||||
<4> Updated background persistence interval
|
||||
<5> Updated analysis config's categorization filters
|
||||
<6> Updated detectors through the `JobUpdate.DetectorUpdate` object
|
||||
<7> Updated group membership
|
||||
<8> Updated result retention
|
||||
<9> Updated model plot configuration
|
||||
<10> Updated model snapshot retention setting
|
||||
<11> Updated custom settings
|
||||
<12> Updated renormalization window
|
||||
<1> Mandatory, non-null `jobId` referencing an existing {anomaly-job}.
|
||||
<2> Updated description.
|
||||
<3> Updated analysis limits.
|
||||
<4> Updated background persistence interval.
|
||||
<5> Updated analysis config's categorization filters.
|
||||
<6> Updated detectors through the `JobUpdate.DetectorUpdate` object.
|
||||
<7> Updated group membership.
|
||||
<8> Updated result retention.
|
||||
<9> Updated model plot configuration.
|
||||
<10> Updated model snapshot retention setting.
|
||||
<11> Updated custom settings.
|
||||
<12> Updated renormalization window.
|
||||
|
||||
Included with these options are specific optional `JobUpdate.DetectorUpdate` updates.
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-detector-options]
|
||||
--------------------------------------------------
|
||||
<1> The index of the detector. `O` means unknown
|
||||
<2> The optional description of the detector
|
||||
<3> The `DetectionRule` rules that apply to this detector
|
||||
<1> The index of the detector. `O` means unknown.
|
||||
<2> The optional description of the detector.
|
||||
<3> The `DetectionRule` rules that apply to this detector.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Update Job Response
|
||||
==== Update {anomaly-job} response
|
||||
|
||||
A +{response}+ contains the updated `Job` object
|
||||
|
||||
|
|
@ -63,4 +63,4 @@ A +{response}+ contains the updated `Job` object
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> `getResponse()` returns the updated `Job` object
|
||||
<1> `getResponse()` returns the updated `Job` object.
|
||||
|
|
|
|||
|
|
@ -4,14 +4,13 @@
|
|||
:response: UpdateModelSnapshotResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Update Model Snapshot API
|
||||
=== Update model snapshot API
|
||||
|
||||
The Update Model Snapshot API provides the ability to update a {ml} model snapshot.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Provides the ability to update a {ml} model snapshot.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Update Model Snapshot Request
|
||||
==== Update model snapshot request
|
||||
|
||||
A +{request}+ requires the following arguments:
|
||||
|
||||
|
|
@ -19,9 +18,10 @@ A +{request}+ requires the following arguments:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing existing `jobId` and `snapshotId` values.
|
||||
<1> Constructing a new request referencing existing `jobId` and `snapshotId`
|
||||
values.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
|
||||
The following arguments are optional:
|
||||
|
||||
|
|
@ -29,19 +29,19 @@ The following arguments are optional:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-description]
|
||||
--------------------------------------------------
|
||||
<1> The updated description of the {ml} model snapshot
|
||||
<1> The updated description of the {ml} model snapshot.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-retain]
|
||||
--------------------------------------------------
|
||||
<1> The updated `retain` property of the {ml} model snapshot
|
||||
<1> The updated `retain` property of the {ml} model snapshot.
|
||||
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Update Job Response
|
||||
==== Update model snapshot response
|
||||
|
||||
A +{response}+ contains an acknowledgement of the update request and the full representation of the updated `ModelSnapshot` object
|
||||
|
||||
|
|
@ -49,5 +49,5 @@ A +{response}+ contains an acknowledgement of the update request and the full re
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> An acknowledgement of the request
|
||||
<2> The updated `ModelSnapshot`
|
||||
<1> An acknowledgement of the request.
|
||||
<2> The updated `ModelSnapshot`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue