[DOCS] Fix titles for ML APIs (#63152) (#63207)

This commit is contained in:
Lisa Cawley 2020-10-02 14:01:01 -07:00 committed by GitHub
parent ade91a2d9d
commit 4de6104dae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
46 changed files with 131 additions and 125 deletions

View File

@ -5,12 +5,12 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Close {anomaly-job} API === Close {anomaly-jobs} API
Closes {anomaly-jobs} in the cluster. It accepts a +{request}+ object and responds with a +{response}+ object. Closes {anomaly-jobs} in the cluster. It accepts a +{request}+ object and responds with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Close {anomaly-job} request ==== Close {anomaly-jobs} request
A +{request}+ object gets created with an existing non-null `jobId`. A +{request}+ object gets created with an existing non-null `jobId`.
@ -27,7 +27,7 @@ which has not responded to its initial close request.
execution should wait for the job to be closed. execution should wait for the job to be closed.
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Close {anomaly-job} response ==== Close {anomaly-jobs} response
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]
-------------------------------------------------- --------------------------------------------------

View File

@ -5,13 +5,14 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete calendar event API === Delete calendar events API
Removes a scheduled event from an existing {ml} calendar. Removes a scheduled event from an existing {ml} calendar.
The API accepts a +{request}+ and responds The API accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Delete calendar event request ==== Delete calendar events request
A +{request}+ is constructed referencing a non-null A +{request}+ is constructed referencing a non-null
calendar ID, and eventId which to remove from the calendar calendar ID, and eventId which to remove from the calendar
@ -24,7 +25,7 @@ include-tagged::{doc-tests-file}[{api}-request]
<2> The eventId to remove from the calendar <2> The eventId to remove from the calendar
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Delete calendar event response ==== Delete calendar events response
The returned +{response}+ acknowledges the success of the request: The returned +{response}+ acknowledges the success of the request:

View File

@ -6,6 +6,7 @@
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete {anomaly-jobs} from calendar API === Delete {anomaly-jobs} from calendar API
Removes {anomaly-jobs} from an existing {ml} calendar. Removes {anomaly-jobs} from an existing {ml} calendar.
The API accepts a +{request}+ and responds The API accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.

View File

@ -5,13 +5,14 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete calendar API === Delete calendars API
Delete a {ml} calendar.
Deletes a {ml} calendar.
The API accepts a +{request}+ and responds The API accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Delete calendar request ==== Delete calendars request
A `DeleteCalendar` object requires a non-null `calendarId`. A `DeleteCalendar` object requires a non-null `calendarId`.
@ -22,7 +23,7 @@ include-tagged::{doc-tests-file}[{api}-request]
<1> Constructing a new request referencing an existing calendar <1> Constructing a new request referencing an existing calendar
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Delete calendar response ==== Delete calendars response
The returned +{response}+ object indicates the acknowledgement of the request: The returned +{response}+ object indicates the acknowledgement of the request:
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]

View File

@ -5,12 +5,12 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-delete-datafeed"] [id="{upid}-delete-datafeed"]
=== Delete datafeed API === Delete datafeeds API
Deletes an existing datafeed. Deletes an existing datafeed.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Delete datafeed request ==== Delete datafeeds request
A +{request}+ object requires a non-null `datafeedId` and can optionally set `force`. A +{request}+ object requires a non-null `datafeedId` and can optionally set `force`.
@ -24,7 +24,7 @@ stopping and deleting the datafeed. Defaults to `false`.
include::../execution.asciidoc[] include::../execution.asciidoc[]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Delete datafeed response ==== Delete datafeeds response
The returned +{response}+ object indicates the acknowledgement of the request: The returned +{response}+ object indicates the acknowledgement of the request:
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]

View File

@ -7,7 +7,8 @@
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete expired data API === Delete expired data API
Delete expired {ml} data.
Deletes expired {ml} data.
The API accepts a +{request}+ and responds The API accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.

View File

@ -5,13 +5,14 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete filter API === Delete filters API
Delete a {ml} filter.
Deletes a {ml} filter.
The API accepts a +{request}+ and responds The API accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Delete filter request ==== Delete filters request
A +{request}+ object requires a non-null `filterId`. A +{request}+ object requires a non-null `filterId`.
@ -22,7 +23,7 @@ include-tagged::{doc-tests-file}[{api}-request]
<1> Constructing a new request referencing an existing filter <1> Constructing a new request referencing an existing filter
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Delete filter response ==== Delete filters response
The returned +{response}+ object indicates the acknowledgement of the request: The returned +{response}+ object indicates the acknowledgement of the request:
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]

View File

@ -5,15 +5,14 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete forecast API === Delete forecasts API
The delete forecast API provides the ability to delete a {ml} job's Deletes forecasts from an {anomaly-job}.
forecast in the cluster.
It accepts a +{request}+ object and responds It accepts a +{request}+ object and responds
with an +{response}+ object. with an +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Delete forecast request ==== Delete forecasts request
A +{request}+ object gets created with an existing non-null `jobId`. A +{request}+ object gets created with an existing non-null `jobId`.
All other fields are optional for the request. All other fields are optional for the request.
@ -39,7 +38,7 @@ include-tagged::{doc-tests-file}[{api}-request-options]
request finds no forecasts. It defaults to `true` request finds no forecasts. It defaults to `true`
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Delete forecast response ==== Delete forecasts response
An +{response}+ contains an acknowledgement of the forecast(s) deletion An +{response}+ contains an acknowledgement of the forecast(s) deletion

View File

@ -5,12 +5,12 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete {anomaly-job} API === Delete {anomaly-jobs} API
Deletes an {anomaly-job} that exists in the cluster. Deletes an {anomaly-job} that exists in the cluster.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Delete {anomaly-job} request ==== Delete {anomaly-jobs} request
A +{request}+ object requires a non-null `jobId` and can optionally set `force`. A +{request}+ object requires a non-null `jobId` and can optionally set `force`.
@ -40,7 +40,7 @@ before returning. Defaults to `true`.
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Delete {anomaly-job} response ==== Delete {anomaly-jobs} response
The returned +{response}+ object indicates the acknowledgement of the job The returned +{response}+ object indicates the acknowledgement of the job
deletion or the deletion task depending on whether the request was set to wait deletion or the deletion task depending on whether the request was set to wait

View File

@ -5,10 +5,12 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete model snapshot API === Delete model snapshots API
Deletes an existing model snapshot.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Delete model snapshot request ==== Delete model snapshots request
A +{request}+ object requires both a non-null `jobId` and a non-null `snapshotId`. A +{request}+ object requires both a non-null `jobId` and a non-null `snapshotId`.
@ -21,7 +23,7 @@ include-tagged::{doc-tests-file}[{api}-request]
include::../execution.asciidoc[] include::../execution.asciidoc[]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Delete model snapshot response ==== Delete model snapshots response
The returned +{response}+ object indicates the acknowledgement of the request: The returned +{response}+ object indicates the acknowledgement of the request:
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]

View File

@ -5,7 +5,7 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Delete trained model API === Delete trained models API
experimental::[] experimental::[]
@ -13,7 +13,7 @@ Deletes a previously saved trained model.
The API accepts a +{request}+ object and returns a +{response}+. The API accepts a +{request}+ object and returns a +{response}+.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Delete trained model request ==== Delete trained models request
A +{request}+ requires a valid trained model ID. A +{request}+ requires a valid trained model ID.

View File

@ -9,7 +9,7 @@
experimental::[] experimental::[]
Evaluates the {ml} algorithm that ran on a {dataframe}. Evaluates the {dfanalytics} for an annotated index.
The API accepts an +{request}+ object and returns an +{response}+. The API accepts an +{request}+ object and returns an +{response}+.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]

View File

@ -9,13 +9,12 @@
experimental::[] experimental::[]
The Find File Structure API can be used to find the structure of a text file Determines the structure of a text file and other information that will be
and other information that will be useful to import its contents to an {es} useful to import its contents to an {es} index. It accepts a +{request}+ object
index. It accepts a +{request}+ object and responds and responds with a +{response}+ object.
with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Find File Structure Request ==== Find file structure request
A sample from the beginning of the file (or the entire file contents if A sample from the beginning of the file (or the entire file contents if
it's small) must be added to the +{request}+ object using the it's small) must be added to the +{request}+ object using the
@ -28,7 +27,7 @@ include-tagged::{doc-tests-file}[{api}-request]
<1> Create a new `FindFileStructureRequest` object <1> Create a new `FindFileStructureRequest` object
<2> Add the contents of `anInterestingFile` to the request <2> Add the contents of `anInterestingFile` to the request
==== Optional Arguments ==== Optional arguments
The following arguments are optional. The following arguments are optional.
@ -43,7 +42,7 @@ include-tagged::{doc-tests-file}[{api}-request-options]
include::../execution.asciidoc[] include::../execution.asciidoc[]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Find File Structure Response ==== Find file structure response
A +{response}+ contains information about the file structure, A +{response}+ contains information about the file structure,
as well as mappings and an ingest pipeline that could be used as well as mappings and an ingest pipeline that could be used

View File

@ -5,15 +5,14 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Flush job API === Flush jobs API
The flush job API provides the ability to flush a {ml} job's Flushes an anomaly detection job's datafeed in the cluster.
datafeed in the cluster.
It accepts a +{request}+ object and responds It accepts a +{request}+ object and responds
with a +{response}+ object. with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Flush job request ==== Flush jobs request
A +{request}+ object gets created with an existing non-null `jobId`. A +{request}+ object gets created with an existing non-null `jobId`.
All other fields are optional for the request. All other fields are optional for the request.
@ -41,7 +40,7 @@ to calculate interim results (requires `calc_interim` to be `true`)
<5> Set the skip time to skip a particular time value <5> Set the skip time to skip a particular time value
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Flush job response ==== Flush jobs response
A +{response}+ contains an acknowledgement and an optional end date for the A +{response}+ contains an acknowledgement and an optional end date for the
last finalized bucket last finalized bucket

View File

@ -5,15 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Forecast job API === Forecast jobs API
The forecast job API provides the ability to forecast a {ml} job's behavior based Forecasts a {ml} job's behavior based on historical data. It accepts a
on historical data. +{request}+ object and responds with a +{response}+ object.
It accepts a +{request}+ object and responds
with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Forecast job request ==== Forecast jobs request
A +{request}+ object gets created with an existing non-null `jobId`. A +{request}+ object gets created with an existing non-null `jobId`.
All other fields are optional for the request. All other fields are optional for the request.
@ -40,7 +38,7 @@ include-tagged::{doc-tests-file}[{api}-request-options]
automatically reduced to below that number. automatically reduced to below that number.
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Forecast job response ==== Forecast jobs response
A +{response}+ contains an acknowledgement and the forecast ID A +{response}+ contains an acknowledgement and the forecast ID

View File

@ -6,12 +6,13 @@
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Get calendar events API === Get calendar events API
Retrieves a calendar's events. Retrieves a calendar's events.
It accepts a +{request}+ and responds It accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Get calendars request ==== Get calendar events request
A +{request}+ requires a non-null calendar ID. A +{request}+ requires a non-null calendar ID.
Using the literal `_all` returns the events for all calendars. Using the literal `_all` returns the events for all calendars.
@ -54,7 +55,7 @@ include-tagged::{doc-tests-file}[{api}-jobid]
include::../execution.asciidoc[] include::../execution.asciidoc[]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Get calendars response ==== Get calendar events response
The returned +{response}+ contains the requested events: The returned +{response}+ contains the requested events:

View File

@ -6,6 +6,7 @@
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Get calendars API === Get calendars API
Retrieves one or more calendar objects. Retrieves one or more calendar objects.
It accepts a +{request}+ and responds It accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.

View File

@ -5,13 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Get datafeed API === Get datafeeds API
Retrieves configuration information about {ml} datafeeds in the cluster. Retrieves configuration information about {ml} datafeeds in the cluster.
It accepts a +{request}+ object and responds with a +{response}+ object. It accepts a +{request}+ object and responds with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Get datafeed request ==== Get datafeeds request
A +{request}+ object gets can have any number of `datafeedId` entries. However, A +{request}+ object gets can have any number of `datafeedId` entries. However,
they all must be non-null. An empty list is the same as requesting for all they all must be non-null. An empty list is the same as requesting for all
@ -27,7 +27,7 @@ contain wildcards.
(This includes `_all` string or when no datafeeds have been specified). (This includes `_all` string or when no datafeeds have been specified).
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Get datafeed response ==== Get datafeeds response
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]
-------------------------------------------------- --------------------------------------------------

View File

@ -5,7 +5,7 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== ML get info API === Get {ml} info API
Provides defaults and limits used internally by {ml}. Provides defaults and limits used internally by {ml}.
These may be useful to a user interface that needs to interpret machine learning These may be useful to a user interface that needs to interpret machine learning
@ -15,7 +15,7 @@ with the default value.
It accepts a +{request}+ object and responds with a +{response}+ object. It accepts a +{request}+ object and responds with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Get info request ==== Get {ml} info request
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]
-------------------------------------------------- --------------------------------------------------
@ -24,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request]
<1> Constructing a new request. <1> Constructing a new request.
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== ML get info response ==== Get {ml} info response
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]
-------------------------------------------------- --------------------------------------------------

View File

@ -11,7 +11,7 @@ Retrieves statistics for any number of {anomaly-jobs} in the cluster.
It accepts a +{request}+ object and responds with a +{response}+ object. It accepts a +{request}+ object and responds with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Get job stats request ==== Get {anomaly-job} stats request
A `GetJobsStatsRequest` object can have any number of `jobId` A `GetJobsStatsRequest` object can have any number of `jobId`
entries. However, they all must be non-null. An empty list is the same as entries. However, they all must be non-null. An empty list is the same as
@ -29,7 +29,7 @@ wildcards.
include::../execution.asciidoc[] include::../execution.asciidoc[]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Get job stats response ==== Get {anomaly-job} stats response
The returned +{response}+ contains the requested job statistics: The returned +{response}+ contains the requested job statistics:
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]

View File

@ -5,13 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Open {anomaly-job} API === Open {anomaly-jobs} API
Opens {anomaly-jobs} in the cluster. It accepts a +{request}+ object and Opens {anomaly-jobs} in the cluster. It accepts a +{request}+ object and
responds with a +{response}+ object. responds with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Open {anomaly-job} request ==== Open {anomaly-jobs} request
An +{request}+ object gets created with an existing non-null `jobId`. An +{request}+ object gets created with an existing non-null `jobId`.
@ -24,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request]
execution should wait for the job to be opened. execution should wait for the job to be opened.
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Open {anomaly-job} response ==== Open {anomaly-jobs} response
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]
-------------------------------------------------- --------------------------------------------------

View File

@ -5,14 +5,15 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Post calendar event API === Post calendar events API
Adds new ScheduledEvents to an existing {ml} calendar. Adds new ScheduledEvents to an existing {ml} calendar.
The API accepts a +{request}+ and responds The API accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Post calendar event request ==== Post calendar events request
A +{request}+ is constructed with a calendar ID object A +{request}+ is constructed with a calendar ID object
and a non-empty list of scheduled events. and a non-empty list of scheduled events.
@ -26,7 +27,7 @@ include-tagged::{doc-tests-file}[{api}-request]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Post calendar event response ==== Post calendar events response
The returned +{response}+ contains the added `ScheduledEvent` objects: The returned +{response}+ contains the added `ScheduledEvent` objects:

View File

@ -7,8 +7,7 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Post data API === Post data API
The post data API provides the ability to post data to an open Posts data to an open {ml} job in the cluster.
{ml} job in the cluster.
It accepts a +{request}+ object and responds It accepts a +{request}+ object and responds
with a +{response}+ object. with a +{response}+ object.

View File

@ -5,14 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Preview datafeed API === Preview datafeeds API
The preview datafeed API provides the ability to preview a {ml} datafeed's data Previews a {ml} datafeed's data in the cluster. It accepts a +{request}+ object
in the cluster. It accepts a +{request}+ object and responds and responds with a +{response}+ object.
with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Preview datafeed request ==== Preview datafeeds request
A +{request}+ object is created referencing a non-null `datafeedId`. A +{request}+ object is created referencing a non-null `datafeedId`.
@ -23,7 +22,7 @@ include-tagged::{doc-tests-file}[{api}-request]
<1> Constructing a new request referencing an existing `datafeedId` <1> Constructing a new request referencing an existing `datafeedId`
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Preview datafeed response ==== Preview datafeeds response
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]
-------------------------------------------------- --------------------------------------------------

View File

@ -6,6 +6,7 @@
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Put {anomaly-jobs} in calendar API === Put {anomaly-jobs} in calendar API
Adds {anomaly-jobs} jobs to an existing {ml} calendar. Adds {anomaly-jobs} jobs to an existing {ml} calendar.
The API accepts a +{request}+ and responds The API accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.

View File

@ -5,13 +5,14 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Put calendar API === Put calendars API
Creates a new {ml} calendar. Creates a new {ml} calendar.
The API accepts a +{request}+ and responds The API accepts a +{request}+ and responds
with a +{response}+ object. with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Put calendar request ==== Put calendars request
A +{request}+ is constructed with a calendar object A +{request}+ is constructed with a calendar object
@ -23,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Put Calendar Response ==== Put calendars response
The returned +{response}+ contains the created calendar: The returned +{response}+ contains the created calendar:

View File

@ -5,13 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Put datafeed API === Put datafeeds API
Creates a new {ml} datafeed in the cluster. The API accepts a +{request}+ object Creates a new {ml} datafeed in the cluster. The API accepts a +{request}+ object
as a request and returns a +{response}+. as a request and returns a +{response}+.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Put datafeed request ==== Put datafeeds request
A +{request}+ requires the following argument: A +{request}+ requires the following argument:

View File

@ -5,14 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Put filter API === Put filters API
The put filter API can be used to create a new {ml} filter Creates a new {ml} filter in the cluster. The API accepts a +{request}+ object
in the cluster. The API accepts a +{request}+ object
as a request and returns a +{response}+. as a request and returns a +{response}+.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Put filter request ==== Put filters request
A +{request}+ requires the following argument: A +{request}+ requires the following argument:

View File

@ -5,13 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Put {anomaly-job} API === Put {anomaly-jobs} API
Creates a new {anomaly-job} in the cluster. The API accepts a +{request}+ object Creates a new {anomaly-job} in the cluster. The API accepts a +{request}+ object
as a request and returns a +{response}+. as a request and returns a +{response}+.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Put {anomaly-job} request ==== Put {anomaly-jobs} request
A +{request}+ requires the following argument: A +{request}+ requires the following argument:

View File

@ -5,7 +5,9 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Put trained model API === Put trained models API
experimental:[]
experimental::[] experimental::[]
@ -13,7 +15,7 @@ Creates a new trained model for inference.
The API accepts a +{request}+ object as a request and returns a +{response}+. The API accepts a +{request}+ object as a request and returns a +{response}+.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Put trained model request ==== Put trained models request
A +{request}+ requires the following argument: A +{request}+ requires the following argument:

View File

@ -6,14 +6,14 @@
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Revert model snapshot API === Revert model snapshots API
The revert model snapshot API provides the ability to revert to a previous {ml} model snapshot. Reverts to a previous {ml} model snapshot.
It accepts a +{request}+ object and responds It accepts a +{request}+ object and responds
with a +{response}+ object. with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Revert model snapshot request ==== Revert model snapshots request
A +{request}+ requires the following arguments: A +{request}+ requires the following arguments:

View File

@ -7,7 +7,7 @@
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Set upgrade mode API === Set upgrade mode API
The set upgrade mode API temporarily halts all {ml} job and {dfeed} tasks when `enabled=true`. Their Temporarily halts all {ml} job and {dfeed} tasks when `enabled=true`. Their
reported states remain unchanged. Consequently, when exiting upgrade mode the halted {ml} jobs and reported states remain unchanged. Consequently, when exiting upgrade mode the halted {ml} jobs and
{dfeeds} will return to their previous state. {dfeeds} will return to their previous state.

View File

@ -13,7 +13,7 @@ Starts an existing {dfanalytics-job}.
It accepts a +{request}+ object and responds with a +{response}+ object. It accepts a +{request}+ object and responds with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Start {dfanalytics-job} request ==== Start {dfanalytics-jobs} request
A +{request}+ object requires a {dfanalytics-job} ID. A +{request}+ object requires a {dfanalytics-job} ID.
@ -26,7 +26,7 @@ include-tagged::{doc-tests-file}[{api}-request]
include::../execution.asciidoc[] include::../execution.asciidoc[]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Start {dfanalytics-job} response ==== Start {dfanalytics-jobs} response
The returned +{response}+ object acknowledges the {dfanalytics-job} has started. The returned +{response}+ object acknowledges the {dfanalytics-job} has started.

View File

@ -5,13 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Start {dfeed} API === Start {dfeeds} API
Starts a {ml} {dfeed} in the cluster. It accepts a +{request}+ object and Starts a {ml} {dfeed} in the cluster. It accepts a +{request}+ object and
responds with a +{response}+ object. responds with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Start {dfeed} request ==== Start {dfeeds} request
A +{request}+ object is created referencing a non-null `datafeedId`. A +{request}+ object is created referencing a non-null `datafeedId`.
All other fields are optional for the request. All other fields are optional for the request.
@ -41,7 +41,7 @@ the analysis starts from the earliest time for which data is available.
<3> Set the timeout for the request <3> Set the timeout for the request
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Start {dfeed} response ==== Start {dfeeds} response
["source","java",subs="attributes,callouts,macros"] ["source","java",subs="attributes,callouts,macros"]
-------------------------------------------------- --------------------------------------------------

View File

@ -5,14 +5,14 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Stop datafeed API === Stop datafeeds API
The stop datafeed API provides the ability to stop a {ml} datafeed in the cluster. Stops a {ml} datafeed in the cluster.
It accepts a +{request}+ object and responds It accepts a +{request}+ object and responds
with a +{response}+ object. with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Stop datafeed request ==== Stop datafeeds request
A +{request}+ object is created referencing any number of non-null `datafeedId` entries. A +{request}+ object is created referencing any number of non-null `datafeedId` entries.
Wildcards and `_all` are also accepted. Wildcards and `_all` are also accepted.

View File

@ -5,13 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Update datafeed API === Update datafeeds API
Updates a {ml} datafeed in the cluster. The API accepts a +{request}+ object Updates a {ml} datafeed in the cluster. The API accepts a +{request}+ object
as a request and returns a +{response}+. as a request and returns a +{response}+.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Update datafeed request ==== Update datafeeds request
A +{request}+ requires the following argument: A +{request}+ requires the following argument:
@ -22,7 +22,7 @@ include-tagged::{doc-tests-file}[{api}-request]
<1> The updated configuration of the {ml} datafeed <1> The updated configuration of the {ml} datafeed
[id="{upid}-{api}-config"] [id="{upid}-{api}-config"]
==== Updated datafeed arguments ==== Updated datafeeds arguments
A `DatafeedUpdate` requires an existing non-null `datafeedId` and A `DatafeedUpdate` requires an existing non-null `datafeedId` and
allows updating various settings. allows updating various settings.

View File

@ -5,13 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Update filter API === Update filters API
Updates an existing {ml} filter in the cluster. The API accepts a +{request}+ Updates an existing {ml} filter in the cluster. The API accepts a +{request}+
object as a request and returns a +{response}+. object as a request and returns a +{response}+.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Update filter request ==== Update filters request
A +{request}+ requires the following argument: A +{request}+ requires the following argument:

View File

@ -5,13 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Update {anomaly-job} API === Update {anomaly-jobs} API
Provides the ability to update an {anomaly-job}. Provides the ability to update an {anomaly-job}.
It accepts a +{request}+ object and responds with a +{response}+ object. It accepts a +{request}+ object and responds with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Update {anomaly-job} request ==== Update {anomaly-jobs} request
An +{request}+ object gets created with a `JobUpdate` object. An +{request}+ object gets created with a `JobUpdate` object.
@ -56,7 +56,7 @@ include-tagged::{doc-tests-file}[{api}-detector-options]
include::../execution.asciidoc[] include::../execution.asciidoc[]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Update {anomaly-job} response ==== Update {anomaly-jobs} response
A +{response}+ contains the updated `Job` object A +{response}+ contains the updated `Job` object

View File

@ -5,13 +5,13 @@
-- --
[role="xpack"] [role="xpack"]
[id="{upid}-{api}"] [id="{upid}-{api}"]
=== Update model snapshot API === Update model snapshots API
Provides the ability to update a {ml} model snapshot. Updates a {ml} model snapshot.
It accepts a +{request}+ object and responds with a +{response}+ object. It accepts a +{request}+ object and responds with a +{response}+ object.
[id="{upid}-{api}-request"] [id="{upid}-{api}-request"]
==== Update model snapshot request ==== Update model snapshots request
A +{request}+ requires the following arguments: A +{request}+ requires the following arguments:
@ -42,7 +42,7 @@ include-tagged::{doc-tests-file}[{api}-retain]
include::../execution.asciidoc[] include::../execution.asciidoc[]
[id="{upid}-{api}-response"] [id="{upid}-{api}-response"]
==== Update model snapshot response ==== Update model snapshots response
A +{response}+ contains an acknowledgement of the update request and the full representation of the updated `ModelSnapshot` object A +{response}+ contains an acknowledgement of the update request and the full representation of the updated `ModelSnapshot` object

View File

@ -1,9 +1,9 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[ml-delete-calendar]] [[ml-delete-calendar]]
= Delete calendar API = Delete calendars API
++++ ++++
<titleabbrev>Delete calendar</titleabbrev> <titleabbrev>Delete calendars</titleabbrev>
++++ ++++
Deletes a calendar. Deletes a calendar.

View File

@ -1,9 +1,9 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[ml-delete-filter]] [[ml-delete-filter]]
= Delete filter API = Delete filters API
++++ ++++
<titleabbrev>Delete filter</titleabbrev> <titleabbrev>Delete filters</titleabbrev>
++++ ++++
Deletes a filter. Deletes a filter.

View File

@ -1,9 +1,9 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[ml-delete-forecast]] [[ml-delete-forecast]]
= Delete forecast API = Delete forecasts API
++++ ++++
<titleabbrev>Delete forecast</titleabbrev> <titleabbrev>Delete forecasts</titleabbrev>
++++ ++++
Deletes forecasts from a {ml} job. Deletes forecasts from a {ml} job.

View File

@ -1,9 +1,9 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[ml-put-calendar]] [[ml-put-calendar]]
= Create calendar API = Create calendars API
++++ ++++
<titleabbrev>Create calendar</titleabbrev> <titleabbrev>Create calendars</titleabbrev>
++++ ++++
Instantiates a calendar. Instantiates a calendar.

View File

@ -1,9 +1,9 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[ml-put-filter]] [[ml-put-filter]]
= Create filter API = Create filters API
++++ ++++
<titleabbrev>Create filter</titleabbrev> <titleabbrev>Create filters</titleabbrev>
++++ ++++
Instantiates a filter. Instantiates a filter.

View File

@ -1,9 +1,9 @@
[role="xpack"] [role="xpack"]
[testenv="platinum"] [testenv="platinum"]
[[ml-update-filter]] [[ml-update-filter]]
= Update filter API = Update filters API
++++ ++++
<titleabbrev>Update filter</titleabbrev> <titleabbrev>Update filters</titleabbrev>
++++ ++++
Updates the description of a filter, adds items, or removes items. Updates the description of a filter, adds items, or removes items.

View File

@ -5,7 +5,7 @@
[subs="attributes"] [subs="attributes"]
++++ ++++
<titleabbrev>Explain {dfanalytics} API</titleabbrev> <titleabbrev>Explain {dfanalytics}</titleabbrev>
++++ ++++
Explains a {dataframe-analytics-config}. Explains a {dataframe-analytics-config}.