mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-27 00:27:25 -04:00
f56a0f4b66
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible. Relates to #79309, #31619
126 lines
3.2 KiB
Text
126 lines
3.2 KiB
Text
[role="xpack"]
|
|
[[ml-valid-detector]]
|
|
= Validate detectors API
|
|
++++
|
|
<titleabbrev>Validate detectors</titleabbrev>
|
|
++++
|
|
|
|
Validates detector configuration information.
|
|
|
|
[[ml-valid-detector-request]]
|
|
== {api-request-title}
|
|
|
|
`POST _ml/anomaly_detectors/_validate/detector`
|
|
|
|
[[ml-valid-detector-prereqs]]
|
|
== {api-prereq-title}
|
|
|
|
Requires the `manage_ml` cluster privilege. This privilege is included in the
|
|
`machine_learning_admin` built-in role.
|
|
|
|
[[ml-valid-detector-desc]]
|
|
== {api-description-title}
|
|
|
|
This API enables you to validate the detector configuration
|
|
before you create an {anomaly-job}.
|
|
|
|
[[ml-valid-detector-request-body]]
|
|
== {api-request-body-title}
|
|
|
|
`by_field_name`::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=by-field-name]
|
|
|
|
`custom_rules`::
|
|
+
|
|
--
|
|
(array)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules]
|
|
|
|
`analysis_config`.`detectors`.`custom_rules`.`actions`:::
|
|
(array)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-actions]
|
|
|
|
`analysis_config`.`detectors`.`custom_rules`.`scope`:::
|
|
(object)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope]
|
|
|
|
`analysis_config`.`detectors`.`custom_rules`.`scope`.`filter_id`::::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-id]
|
|
|
|
`analysis_config`.`detectors`.`custom_rules`.`scope`.`filter_type`::::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-type]
|
|
|
|
`analysis_config`.`detectors`.`custom_rules`.`conditions`:::
|
|
(array)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions]
|
|
|
|
`analysis_config`.`detectors`.`custom_rules`.`conditions`.`applies_to`::::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-applies-to]
|
|
|
|
`analysis_config`.`detectors`.`custom_rules`.`conditions`.`operator`::::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-operator]
|
|
|
|
`analysis_config`.`detectors`.`custom_rules`.`conditions`.`value`::::
|
|
(double)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-value]
|
|
--
|
|
|
|
`detector_description`::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-description]
|
|
|
|
`detector_index`::
|
|
(integer)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-index]
|
|
|
|
`exclude_frequent`::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-frequent]
|
|
|
|
`field_name`::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-field-name]
|
|
|
|
`function`::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=function]
|
|
|
|
`over_field_name`::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=over-field-name]
|
|
|
|
`partition_field_name`::
|
|
(string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=partition-field-name]
|
|
|
|
`use_null`::
|
|
(Boolean)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=use-null]
|
|
|
|
[[ml-valid-detector-example]]
|
|
== {api-examples-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST _ml/anomaly_detectors/_validate/detector
|
|
{
|
|
"function": "metric",
|
|
"field_name": "responsetime",
|
|
"by_field_name": "airline"
|
|
}
|
|
--------------------------------------------------
|
|
// TEST[skip:needs-licence]
|
|
|
|
When the validation completes, you receive the following results:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
----
|