honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/ml/apis/get-ml-info.asciidoc

72 lines
1.8 KiB
Plaintext
Raw Normal View History

[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
[role="xpack"]
[testenv="platinum"]
[[get-ml-info]]
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
=== Get machine learning info API
[DOCS] Allow attribute substitution in titleabbrevs for Asciidoctor migration (#41574) * [DOCS] Replace attributes in titleabbrevs for Asciidoctor migration * [DOCS] Add [subs="attributes"] so attributes render in Asciidoctor * Revert "[DOCS] Replace attributes in titleabbrevs for Asciidoctor migration" This reverts commit 98f130257a7c71e9f6cddf5157af7886418338d8. * [DOCS] Fix merge conflict
2019-04-30 13:46:13 -04:00
[subs="attributes"]
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
++++
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
<titleabbrev>Get {ml} info</titleabbrev>
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
++++
Returns defaults and limits used by machine learning.
[DOCS] Adds anchors and attributes to ML APIs
2019-06-27 12:42:47 -04:00
[[get-ml-info-request]]
==== {api-request-title}
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
[ML] Deprecate X-Pack centric ML endpoints (#36315) This commit is part of our plan to deprecate and ultimately remove the use of _xpack in the REST APIs. Relates #35958
2018-12-07 15:34:11 -05:00
`GET _ml/info`
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
[DOCS] Adds anchors and attributes to ML APIs
2019-06-27 12:42:47 -04:00
[[get-ml-info-desc]]
==== {api-description-title}
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not specified,
meaning that the defaults should be used. This endpoint may be used to find out
what those defaults are.
[DOCS] Adds anchors and attributes to ML APIs
2019-06-27 12:42:47 -04:00
[[get-ml-info-prereqs]]
==== {api-prereq-title}
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
privileges to use this API. The `machine_learning_admin` and `machine_learning_user`
roles provide these privileges. For more information, see
[DOCS] Adds anchors and attributes to ML APIs
2019-06-27 12:42:47 -04:00
{stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles].
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
[DOCS] Adds anchors and attributes to ML APIs
2019-06-27 12:42:47 -04:00
[[get-ml-info-example]]
==== {api-examples-title}
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
The endpoint takes no arguments:
[source,js]
--------------------------------------------------
[ML] Deprecate X-Pack centric ML endpoints (#36315) This commit is part of our plan to deprecate and ultimately remove the use of _xpack in the REST APIs. Relates #35958
2018-12-07 15:34:11 -05:00
GET _ml/info
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
--------------------------------------------------
// CONSOLE
// TEST
This is a possible response:
[source,js]
----
{
"defaults" : {
"anomaly_detectors" : {
"model_memory_limit" : "1gb",
"categorization_examples_limit" : 4,
"model_snapshot_retention_days" : 1
},
"datafeeds" : {
"scroll_size" : 1000
}
},
ML: Adds set_upgrade_mode API endpoint (#37837) * ML: Add MlMetadata.upgrade_mode and API * Adding tests * Adding wait conditionals for the upgrade_mode call to return * Adding tests * adjusting format and tests * Adjusting wait conditions for api return and msgs * adjusting doc tests * adding upgrade mode tests to black list
2019-01-28 10:07:30 -05:00
"upgrade_mode": false,
Add native code info to ML info api (#43172) The machine learning feature of xpack has native binaries with a different commit id than the rest of code. It is currently exposed in the xpack info api. This commit adds that commit information to the ML info api, so that it may be removed from the info api.
2019-06-13 14:38:29 -04:00
"native_code" : {
"version": "7.0.0",
"build_hash": "99a07c016d5a73"
},
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
"limits" : { }
}
----
relax ML Info Docs expected response (#38993) the get-ml-info API documentation tested that the response show that ML's `upgrade_mode` was false. For reasons that may be true due to other tests running in parallel or not cleaning themselves up, this may not be guaranteed. Since the actual value here is not of importance, this commit relaxes the requirement that upgrade_mode be static.
2019-02-15 19:26:41 -05:00
// TESTRESPONSE[s/"upgrade_mode": false/"upgrade_mode": $body.upgrade_mode/]
Add native code info to ML info api (#43172) The machine learning feature of xpack has native binaries with a different commit id than the rest of code. It is currently exposed in the xpack info api. This commit adds that commit information to the ML info api, so that it may be removed from the info api.
2019-06-13 14:38:29 -04:00
// TESTRESPONSE[s/"version": "7.0.0",/"version": "$body.native_code.version",/]
// TESTRESPONSE[s/"build_hash": "99a07c016d5a73"/"build_hash": "$body.native_code.build_hash"/]