mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
[DOCS] Updates terms in machine learning get APIs (#44986)
This commit is contained in:
Lisa Cawley
GitHub
parent
27531b3330
commit
285f2e0625
23 changed files with 230 additions and 221 deletions
|
|
@ -4,14 +4,14 @@
|
|||
:response: GetBucketsResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Buckets API
|
||||
=== Get buckets API
|
||||
|
||||
The Get Buckets API retrieves one or more bucket results.
|
||||
Retrieves one or more bucket results.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Buckets Request
|
||||
==== Get buckets request
|
||||
|
||||
A +{request}+ object gets created with an existing non-null `jobId`.
|
||||
|
||||
|
|
@ -19,9 +19,9 @@ A +{request}+ object gets created with an existing non-null `jobId`.
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing an existing `jobId`
|
||||
<1> Constructing a new request referencing an existing `jobId`.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
|
|
@ -82,7 +82,7 @@ include-tagged::{doc-tests-file}[{api}-start]
|
|||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Buckets Response
|
||||
==== Get buckets response
|
||||
|
||||
The returned +{response}+ contains the requested buckets:
|
||||
|
||||
|
|
@ -90,5 +90,5 @@ The returned +{response}+ contains the requested buckets:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of buckets that were matched
|
||||
<2> The buckets retrieved
|
||||
<1> The count of buckets that were matched.
|
||||
<2> The buckets retrieved.
|
||||
|
|
@ -4,13 +4,13 @@
|
|||
:response: GetCalendarEventsResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Calendar Events API
|
||||
Retrieves a calendars events.
|
||||
=== Get calendar events API
|
||||
Retrieves a calendar's events.
|
||||
It accepts a +{request}+ and responds
|
||||
with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Calendars Request
|
||||
==== Get calendars request
|
||||
|
||||
A +{request}+ requires a non-null calendar ID.
|
||||
Using the literal `_all` returns the events for all calendars.
|
||||
|
|
@ -19,9 +19,9 @@ Using the literal `_all` returns the events for all calendars.
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request for the specified calendarId
|
||||
<1> Constructing a new request for the specified calendarId.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
|
||||
|
|
@ -48,12 +48,12 @@ include-tagged::{doc-tests-file}[{api}-end]
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-jobid]
|
||||
--------------------------------------------------
|
||||
<1> Get events for the job. When this option is used calendar_id must be `_all`
|
||||
<1> Get events for the job. When this option is used calendar_id must be `_all`.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get calendars Response
|
||||
==== Get calendars response
|
||||
|
||||
The returned +{response}+ contains the requested events:
|
||||
|
||||
|
|
@ -61,5 +61,5 @@ The returned +{response}+ contains the requested events:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of events that were matched
|
||||
<2> The events retrieved
|
||||
<1> The count of events that were matched.
|
||||
<2> The events retrieved.
|
||||
|
|
@ -4,44 +4,45 @@
|
|||
:response: GetCalendarsResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Calendars API
|
||||
=== Get calendars API
|
||||
Retrieves one or more calendar objects.
|
||||
It accepts a +{request}+ and responds
|
||||
with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Calendars Request
|
||||
==== Get calendars request
|
||||
|
||||
By default a +{request}+ with no calendar Id set will return all
|
||||
By default, a +{request}+ with no calendar ID set will return all
|
||||
calendars. Using the literal `_all` also returns all calendars.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request for all calendars
|
||||
<1> Constructing a new request for all calendars.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-id]
|
||||
--------------------------------------------------
|
||||
<1> Construct a request for the single calendar `holidays`
|
||||
<1> Construct a request for the single calendar `holidays`.
|
||||
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-page]
|
||||
--------------------------------------------------
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of calendars to skip.
|
||||
`size` specifies the maximum number of calendars to get. Defaults to `0` and `100` respectively.
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of
|
||||
calendars to skip. `size` specifies the maximum number of calendars to get.
|
||||
Defaults to `0` and `100` respectively.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get calendars Response
|
||||
==== Get calendars response
|
||||
|
||||
The returned +{response}+ contains the requested calendars:
|
||||
|
||||
|
|
@ -49,5 +50,5 @@ The returned +{response}+ contains the requested calendars:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of calendars that were matched
|
||||
<2> The calendars retrieved
|
||||
<1> The count of calendars that were matched.
|
||||
<2> The calendars retrieved.
|
||||
|
|
@ -4,14 +4,13 @@
|
|||
:response: GetCategoriesResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Categories API
|
||||
=== Get categories API
|
||||
|
||||
The Get Categories API retrieves one or more category results.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Retrieves one or more category results.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Categories Request
|
||||
==== Get categories request
|
||||
|
||||
A +{request}+ object gets created with an existing non-null `jobId`.
|
||||
|
||||
|
|
@ -19,28 +18,29 @@ A +{request}+ object gets created with an existing non-null `jobId`.
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing an existing `jobId`
|
||||
<1> Constructing a new request referencing an existing `jobId`.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-category-id]
|
||||
--------------------------------------------------
|
||||
<1> The id of the category to get. Otherwise it will return all categories.
|
||||
<1> The ID of the category to get. Otherwise, it will return all categories.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-page]
|
||||
--------------------------------------------------
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of categories to skip.
|
||||
`size` specifies the maximum number of categories to get. Defaults to `0` and `100` respectively.
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of
|
||||
categories to skip. `size` specifies the maximum number of categories to get.
|
||||
Defaults to `0` and `100` respectively.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Categories Response
|
||||
==== Get categories response
|
||||
|
||||
The returned +{response}+ contains the requested categories:
|
||||
|
||||
|
|
@ -48,5 +48,5 @@ The returned +{response}+ contains the requested categories:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of categories that were matched
|
||||
<2> The categories retrieved
|
||||
<1> The count of categories that were matched.
|
||||
<2> The categories retrieved.
|
||||
|
|
@ -4,37 +4,36 @@
|
|||
:response: GetDatafeedStatsResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Datafeed Stats API
|
||||
=== Get datafeed stats API
|
||||
|
||||
The Get Datafeed Stats API provides the ability to get any number of
|
||||
{ml} datafeed's statistics in the cluster.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Retrieves any number of {ml} datafeeds' statistics in the cluster.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Datafeed Stats Request
|
||||
==== Get datafeed stats request
|
||||
|
||||
A +{request}+ object can have any number of `datafeedId`
|
||||
entries. However, they all must be non-null. An empty list is the same as
|
||||
requesting statistics for all datafeeds.
|
||||
A +{request}+ object can have any number of `datafeedId` entries. However, they
|
||||
all must be non-null. An empty list is the same as requesting statistics for all
|
||||
datafeeds.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing existing `datafeedIds`, can contain wildcards
|
||||
<1> Constructing a new request referencing existing `datafeedIds`. It can
|
||||
contain wildcards.
|
||||
<2> Whether to ignore if a wildcard expression matches no datafeeds.
|
||||
(This includes `_all` string or when no datafeeds have been specified)
|
||||
(This includes `_all` string or when no datafeeds have been specified).
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Datafeed Stats Response
|
||||
==== Get datafeed stats response
|
||||
The returned +{response}+ contains the requested datafeed statistics:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> `count()` indicates the number of datafeeds statistics found
|
||||
<2> `datafeedStats()` is the collection of {ml} `DatafeedStats` objects found
|
||||
<1> `count()` indicates the number of datafeeds statistics found.
|
||||
<2> `datafeedStats()` is the collection of {ml} `DatafeedStats` objects found.
|
||||
|
|
@ -4,34 +4,35 @@
|
|||
:response: GetDatafeedResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Datafeed API
|
||||
=== Get datafeed API
|
||||
|
||||
The Get Datafeed API provides the ability to get {ml} datafeeds in the cluster.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Retrieves configuration information about {ml} datafeeds in the cluster.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Datafeed Request
|
||||
==== Get datafeed request
|
||||
|
||||
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 datafeeds.
|
||||
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
|
||||
datafeeds.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing existing `datafeedIds`, can contain wildcards
|
||||
<1> Constructing a new request referencing existing `datafeedIds`. It can
|
||||
contain wildcards.
|
||||
<2> Whether to ignore if a wildcard expression matches no datafeeds.
|
||||
(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"]
|
||||
==== Get Datafeed Response
|
||||
==== Get datafeed response
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of retrieved datafeeds
|
||||
<2> The retrieved datafeeds
|
||||
<1> The count of retrieved datafeeds.
|
||||
<2> The retrieved datafeeds.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -4,14 +4,13 @@
|
|||
:response: GetFiltersResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Filters API
|
||||
=== Get filters API
|
||||
|
||||
The Get Filters API retrieves one or more filter results.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Retrieves one or more filter results.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Filters Request
|
||||
==== Get filters request
|
||||
|
||||
A +{request}+ object gets created.
|
||||
|
||||
|
|
@ -19,16 +18,16 @@ A +{request}+ object gets created.
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request
|
||||
<1> Constructing a new request.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-filter-id]
|
||||
--------------------------------------------------
|
||||
<1> The id of the filter to get. Otherwise it will return all filters.
|
||||
<1> The ID of the filter to get. Otherwise, it will return all filters.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
|
|
@ -40,7 +39,7 @@ include-tagged::{doc-tests-file}[{api}-page-params]
|
|||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Filters Response
|
||||
==== Get filters response
|
||||
|
||||
The returned +{response}+ contains the requested filters:
|
||||
|
||||
|
|
@ -48,5 +47,5 @@ The returned +{response}+ contains the requested filters:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of filters that were matched
|
||||
<2> The filters retrieved
|
||||
<1> The count of filters that were matched.
|
||||
<2> The filters retrieved.
|
||||
|
|
@ -4,14 +4,13 @@
|
|||
:response: GetInfluencersResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Influencers API
|
||||
=== Get influencers API
|
||||
|
||||
The Get Influencers API retrieves one or more influencer results.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Retrieves one or more influencer results.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Influencers Request
|
||||
==== Get influencers request
|
||||
|
||||
A +{request}+ object gets created with an existing non-null `jobId`.
|
||||
|
||||
|
|
@ -19,9 +18,9 @@ A +{request}+ object gets created with an existing non-null `jobId`.
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing an existing `jobId`
|
||||
<1> Constructing a new request referencing an existing `jobId`.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
|
|
@ -46,14 +45,16 @@ include-tagged::{doc-tests-file}[{api}-exclude-interim]
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-influencer-score]
|
||||
--------------------------------------------------
|
||||
<1> Influencers with influencer_score greater or equal than this value will be returned.
|
||||
<1> Influencers with `influencer_score` greater than or equal to this value will
|
||||
be returned.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-page]
|
||||
--------------------------------------------------
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of influencers to skip.
|
||||
`size` specifies the maximum number of influencers to get. Defaults to `0` and `100` respectively.
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of
|
||||
influencers to skip. `size` specifies the maximum number of influencers to get.
|
||||
Defaults to `0` and `100` respectively.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
|
|
@ -70,7 +71,7 @@ include-tagged::{doc-tests-file}[{api}-start]
|
|||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Influencers Response
|
||||
==== Get influencers response
|
||||
|
||||
The returned +{response}+ contains the requested influencers:
|
||||
|
||||
|
|
@ -78,5 +79,5 @@ The returned +{response}+ contains the requested influencers:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of influencers that were matched
|
||||
<2> The influencers retrieved
|
||||
<1> The count of influencers that were matched.
|
||||
<2> The influencers retrieved.
|
||||
|
|
@ -4,30 +4,31 @@
|
|||
:response: MlInfoResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== ML Get Info API
|
||||
=== ML get info API
|
||||
|
||||
The ML Get 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
|
||||
configurations where certain fields are missing because the end user was happy with the default value.
|
||||
configurations where certain fields are missing because the end user was happy
|
||||
with the default value.
|
||||
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Info Request
|
||||
==== Get info request
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request
|
||||
<1> Constructing a new request.
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== ML Get Info Response
|
||||
==== ML get info response
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> `info` from the +{response}+ contains ml info details
|
||||
<1> `info` from the +{response}+ contains {ml} info details.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -4,37 +4,36 @@
|
|||
:response: GetJobStatsResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Job Stats API
|
||||
=== Get {anomaly-job} stats API
|
||||
|
||||
The Get Job Stats API provides the ability to get any number of
|
||||
{ml} job's statistics in the cluster.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Retrieves statistics for any number of {anomaly-jobs} in the cluster.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Job Stats Request
|
||||
==== Get job stats request
|
||||
|
||||
A `GetJobsStatsRequest` object can have any number of `jobId`
|
||||
entries. However, they all must be non-null. An empty list is the same as
|
||||
requesting statistics for all jobs.
|
||||
requesting statistics for all {anomaly-jobs}.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing existing `jobIds`, can contain wildcards
|
||||
<2> Whether to ignore if a wildcard expression matches no jobs.
|
||||
(This includes `_all` string or when no jobs have been specified)
|
||||
<1> Constructing a new request referencing existing `jobIds`. It can contain
|
||||
wildcards.
|
||||
<2> Whether to ignore if a wildcard expression matches no {anomaly-jobs}.
|
||||
(This includes `_all` string or when no jobs have been specified).
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Job Stats Response
|
||||
==== Get job stats response
|
||||
The returned +{response}+ contains the requested job statistics:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> `getCount()` indicates the number of jobs statistics found
|
||||
<2> `getJobStats()` is the collection of {ml} `JobStats` objects found
|
||||
<1> `getCount()` indicates the number of jobs statistics found.
|
||||
<2> `getJobStats()` is the collection of {ml} `JobStats` objects found.
|
||||
|
|
@ -4,35 +4,35 @@
|
|||
:response: GetJobResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Job API
|
||||
=== Get {anomaly-jobs} API
|
||||
|
||||
The Get Job API provides the ability to get {ml} jobs in the cluster.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Retrieves configuration information for {anomaly-jobs} in the cluster.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Job Request
|
||||
==== Get {anomaly-jobs} request
|
||||
|
||||
A +{request}+ object gets can have any number of `jobId` or `groupName`
|
||||
entries. However, they all must be non-null. An empty list is the same as
|
||||
requesting for all jobs.
|
||||
requesting for all {anomaly-jobs}.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing existing `jobIds`, can contain wildcards
|
||||
<2> Whether to ignore if a wildcard expression matches no jobs.
|
||||
(This includes `_all` string or when no jobs have been specified)
|
||||
<1> Constructing a new request referencing existing `jobIds`. It can contain
|
||||
wildcards.
|
||||
<2> Whether to ignore if a wildcard expression matches no {anomaly-jobs}.
|
||||
(This includes `_all` string or when no jobs have been specified).
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Job Response
|
||||
==== Get {anomaly-jobs} response
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> `getCount()` from the +{response}+ indicates the number of jobs found
|
||||
<2> `getJobs()` is the collection of {ml} `Job` objects found
|
||||
<1> `getCount()` from the +{response}+ indicates the number of jobs found.
|
||||
<2> `getJobs()` is the collection of {ml} `Job` objects found.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -4,14 +4,13 @@
|
|||
:response: GetModelSnapshotsResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Model Snapshots API
|
||||
=== Get model snapshots API
|
||||
|
||||
The Get Model Snapshots API retrieves one or more model snapshot results.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Retrieves one or more model snapshot results.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Model Snapshots Request
|
||||
==== Get model snapshots request
|
||||
|
||||
A +{request}+ object gets created with an existing non-null `jobId`.
|
||||
|
||||
|
|
@ -19,16 +18,16 @@ A +{request}+ object gets created with an existing non-null `jobId`.
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing an existing `jobId`
|
||||
<1> Constructing a new request referencing an existing `jobId`.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-snapshot-id]
|
||||
--------------------------------------------------
|
||||
<1> The id of the snapshot to get. Otherwise it will return all snapshots.
|
||||
<1> The ID of the snapshot to get. Otherwise, it will return all snapshots.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
|
|
@ -58,13 +57,14 @@ include-tagged::{doc-tests-file}[{api}-start]
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-page]
|
||||
--------------------------------------------------
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of snapshots to skip.
|
||||
`size` specifies the maximum number of snapshots to retrieve. Defaults to `0` and `100` respectively.
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of
|
||||
snapshots to skip. `size` specifies the maximum number of snapshots to retrieve.
|
||||
Defaults to `0` and `100` respectively.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Model Snapshots Response
|
||||
==== Get model snapshots response
|
||||
|
||||
The returned +{response}+ contains the requested snapshots:
|
||||
|
||||
|
|
@ -72,5 +72,5 @@ The returned +{response}+ contains the requested snapshots:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of snapshots that were matched
|
||||
<2> The snapshots retrieved
|
||||
<1> The count of snapshots that were matched.
|
||||
<2> The snapshots retrieved.
|
||||
|
|
@ -4,15 +4,15 @@
|
|||
:response: GetOverallBucketsResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Overall Buckets API
|
||||
=== Get overall buckets API
|
||||
|
||||
The Get Overall Buckets API retrieves overall bucket results that
|
||||
summarize the bucket results of multiple jobs.
|
||||
Retrieves overall bucket results that summarize the bucket results of multiple
|
||||
{anomaly-jobs}.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Overall Buckets Request
|
||||
==== Get overall buckets request
|
||||
|
||||
A +{request}+ object gets created with one or more `jobId`.
|
||||
|
||||
|
|
@ -22,14 +22,15 @@ include-tagged::{doc-tests-file}[{api}-request]
|
|||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing job IDs `jobId1` and `jobId2`.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-bucket-span]
|
||||
--------------------------------------------------
|
||||
<1> The span of the overall buckets. Must be greater or equal to the jobs' largest `bucket_span`.
|
||||
<1> The span of the overall buckets. Must be greater or equal to the jobs'
|
||||
largest `bucket_span`.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
|
|
@ -41,14 +42,16 @@ include-tagged::{doc-tests-file}[{api}-end]
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-exclude-interim]
|
||||
--------------------------------------------------
|
||||
<1> If `true`, interim results will be excluded. Overall buckets are interim if any of the job buckets
|
||||
within the overall bucket interval are interim. Defaults to `false`.
|
||||
<1> If `true`, interim results will be excluded. Overall buckets are interim if
|
||||
any of the job buckets within the overall bucket interval are interim. Defaults
|
||||
to `false`.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-overall-score]
|
||||
--------------------------------------------------
|
||||
<1> Overall buckets with overall scores greater or equal than this value will be returned.
|
||||
<1> Overall buckets with overall scores greater or equal than this value will be
|
||||
returned.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
|
|
@ -60,12 +63,13 @@ include-tagged::{doc-tests-file}[{api}-start]
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-top-n]
|
||||
--------------------------------------------------
|
||||
<1> The number of top job bucket scores to be used in the `overall_score` calculation. Defaults to `1`.
|
||||
<1> The number of top job bucket scores to be used in the `overall_score`
|
||||
calculation. Defaults to `1`.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Overall Buckets Response
|
||||
==== Get overall buckets response
|
||||
|
||||
The returned +{response}+ contains the requested buckets:
|
||||
|
||||
|
|
@ -73,5 +77,5 @@ The returned +{response}+ contains the requested buckets:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of overall buckets that were matched
|
||||
<2> The overall buckets retrieved
|
||||
<1> The count of overall buckets that were matched.
|
||||
<2> The overall buckets retrieved.
|
||||
|
|
@ -4,14 +4,13 @@
|
|||
:response: GetRecordsResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Records API
|
||||
=== Get records API
|
||||
|
||||
The Get Records API retrieves one or more record results.
|
||||
It accepts a +{request}+ object and responds
|
||||
with a +{response}+ object.
|
||||
Retrieves one or more record results.
|
||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Get Records Request
|
||||
==== Get records request
|
||||
|
||||
A +{request}+ object gets created with an existing non-null `jobId`.
|
||||
|
||||
|
|
@ -19,9 +18,9 @@ A +{request}+ object gets created with an existing non-null `jobId`.
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> Constructing a new request referencing an existing `jobId`
|
||||
<1> Constructing a new request referencing an existing `jobId`.
|
||||
|
||||
==== Optional Arguments
|
||||
==== Optional arguments
|
||||
The following arguments are optional:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
|
|
@ -46,8 +45,9 @@ include-tagged::{doc-tests-file}[{api}-exclude-interim]
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-page]
|
||||
--------------------------------------------------
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of records to skip.
|
||||
`size` specifies the maximum number of records to get. Defaults to `0` and `100` respectively.
|
||||
<1> The page parameters `from` and `size`. `from` specifies the number of
|
||||
records to skip. `size` specifies the maximum number of records to get. Defaults
|
||||
to `0` and `100` respectively.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
|
|
@ -70,7 +70,7 @@ include-tagged::{doc-tests-file}[{api}-start]
|
|||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Get Records Response
|
||||
==== Get records response
|
||||
|
||||
The returned +{response}+ contains the requested records:
|
||||
|
||||
|
|
@ -78,5 +78,5 @@ The returned +{response}+ contains the requested records:
|
|||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The count of records that were matched
|
||||
<2> The records retrieved
|
||||
<1> The count of records that were matched.
|
||||
<2> The records retrieved.
|
||||
Loading…
Add table
Add a link
Reference in a new issue