forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Adds cat trained model API documentation (elastic#52824)
- Loading branch information
1 parent
280d59c
commit 4a33352
Showing
3 changed files
with
129 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
[role="xpack"] | ||
[testenv="platinum"] | ||
[[cat-trained-model]] | ||
=== cat trained model API | ||
++++ | ||
<titleabbrev>cat trained model</titleabbrev> | ||
++++ | ||
|
||
Returns configuration and usage information about {infer} trained models. | ||
|
||
|
||
[[cat-trained-model-request]] | ||
==== {api-request-title} | ||
|
||
`GET /_cat/ml/trained_models` | ||
|
||
|
||
[[cat-trained-model-prereqs]] | ||
==== {api-prereq-title} | ||
|
||
If the {es} {security-features} are enabled, you must have the following | ||
privileges: | ||
|
||
* cluster: `monitor_ml` | ||
|
||
For more information, see <<security-privileges>> and | ||
{ml-docs}/setup.html[Set up {ml-features}]. | ||
|
||
|
||
//// | ||
[[cat-trained-model-desc]] | ||
==== {api-description-title} | ||
//// | ||
|
||
|
||
[[cat-trained-model-query-params]] | ||
==== {api-query-parms-title} | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] | ||
+ | ||
If you do not specify which columns to include, the API returns the default | ||
columns. If you explicitly specify one or more columns, it returns only the | ||
specified columns. | ||
+ | ||
Valid columns are: | ||
|
||
`create_time`, `ct`::: | ||
The time when the trained model was created. | ||
|
||
`created_by`, `c`, `createdBy`::: | ||
Information on the creator of the trained model. | ||
|
||
`data_frame_analytics_id`, `df`, `dataFrameAnalytics`::: | ||
Identifier for the {dfanalytics-job} that created the model. Only displayed if | ||
it is still available. | ||
|
||
`description`, `d`::: | ||
The description of the trained model. | ||
|
||
`heap_size`, `hs`, `modelHeapSize`::: | ||
(Default) | ||
The estimated heap size to keep the trained model in memory. | ||
|
||
`id`::: | ||
(Default) | ||
Idetifier for the trained model. | ||
|
||
`ingest.count`, `ic`, `ingestCount`::: | ||
The total number of documents that are processed by the model. | ||
|
||
`ingest.current`, `icurr`, `ingestCurrent`::: | ||
The total number of document that are currently being handled by the trained | ||
model. | ||
|
||
`ingest.failed`, `if`, `ingestFailed`::: | ||
The total number of failed ingest attempts with the trained model. | ||
|
||
`ingest.pipelines`, `ip`, `ingestPipelines`::: | ||
(Default) | ||
The total number of ingest pipelines that are referencing the trained model. | ||
|
||
`ingest.time`, `it`, `ingestTime`::: | ||
The total time that is spent processing documents with the trained model. | ||
|
||
`license`, `l`::: | ||
The license level of the trained model. | ||
|
||
`operations`, `o`, `modelOperations`::: | ||
(Default) | ||
The estimated number of operations to use the trained model. This number helps | ||
measuring the computational complexity of the model. | ||
|
||
`version`, `v`::: | ||
The {es} version number in which the trained model was created. | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=help] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=time] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] | ||
|
||
|
||
[[cat-trained-model-example]] | ||
==== {api-examples-title} | ||
|
||
[source,console] | ||
-------------------------------------------------- | ||
GET _cat/ml/trained_models?h=c,o,l,ct,v&v | ||
-------------------------------------------------- | ||
// TEST[skip:kibana sample data] | ||
|
||
|
||
[source,console-result] | ||
---- | ||
id created_by operations license create_time version | ||
ddddd-1580216177138 _xpack 196 PLATINUM 2020-01-28T12:56:17.138Z 8.0.0 | ||
flight-regress-1580215685537 _xpack 102 PLATINUM 2020-01-28T12:48:05.537Z 8.0.0 | ||
lang_ident_model_1 _xpack 39629 BASIC 2019-12-05T12:28:34.594Z 7.6.0 | ||
---- | ||
// TESTRESPONSE[skip:kibana sample data] |
2 changes: 1 addition & 1 deletion
2
x-pack/plugin/src/test/resources/rest-api-spec/api/cat.ml_trained_models.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters