Skip to content

Commit 716cb1f

Browse files
[ML][DOCS] Refer to rules feature as custom rules (#32785)
1 parent 85e9cf9 commit 716cb1f

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

x-pack/docs/en/ml/detector-custom-rules.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[role="xpack"]
22
[[ml-configuring-detector-custom-rules]]
3-
=== Customizing detectors with rules and filters
3+
=== Customizing detectors with custom rules
44

5-
<<ml-rules,Rules and filters>> enable you to change the behavior of anomaly
5+
<<ml-rules,Custom rules>> enable you to change the behavior of anomaly
66
detectors based on domain-specific knowledge.
77

8-
Rules describe _when_ a detector should take a certain _action_ instead
8+
Custom rules describe _when_ a detector should take a certain _action_ instead
99
of following its default behavior. To specify the _when_ a rule uses
1010
a `scope` and `conditions`. You can think of `scope` as the categorical
1111
specification of a rule, while `conditions` are the numerical part.
@@ -14,7 +14,7 @@ scope and conditions.
1414

1515
Let us see how those can be configured by examples.
1616

17-
==== Specifying rule scope
17+
==== Specifying custom rule scope
1818

1919
Let us assume we are configuring a job in order to detect DNS data exfiltration.
2020
Our data contain fields "subdomain" and "highest_registered_domain".
@@ -127,7 +127,7 @@ PUT _xpack/ml/anomaly_detectors/scoping_multiple_fields
127127
Such a detector will skip results when the values of all 3 scoped fields
128128
are included in the referenced filters.
129129

130-
==== Specifying rule conditions
130+
==== Specifying custom rule conditions
131131

132132
Imagine a detector that looks for anomalies in CPU utilization.
133133
Given a machine that is idle for long enough, small movement in CPU could
@@ -206,17 +206,17 @@ PUT _xpack/ml/anomaly_detectors/rule_with_range
206206
----------------------------------
207207
// CONSOLE
208208

209-
==== Rules in the life-cycle of a job
209+
==== Custom rules in the life-cycle of a job
210210

211-
Rules only affect results created after the rules were applied.
211+
Custom rules only affect results created after the rules were applied.
212212
Let us imagine that we have configured a job and it has been running
213213
for some time. After observing its results we decide that we can employ
214214
rules in order to get rid of some uninteresting results. We can use
215215
the {ref}/ml-update-job.html[update job API] to do so. However, the rule we
216216
added will only be in effect for any results created from the moment we added
217217
the rule onwards. Past results will remain unaffected.
218218

219-
==== Using rules VS filtering data
219+
==== Using custom rules VS filtering data
220220

221221
It might appear like using rules is just another way of filtering the data
222222
that feeds into a job. For example, a rule that skips results when the

x-pack/docs/en/rest-api/ml/filterresource.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ A filter resource has the following properties:
1313
`items`::
1414
(array of strings) An array of strings which is the filter item list.
1515

16-
For more information, see {stack-ov}/ml-rules.html[Machine learning rules and filters].
16+
For more information, see {stack-ov}/ml-rules.html[Machine learning custom rules].

x-pack/docs/en/rest-api/ml/get-filter.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Retrieves filters.
1818
===== Description
1919

2020
You can get a single filter or all filters. For more information, see
21-
{stack-ov}/ml-rules.html[Machine learning rules and filters].
21+
{stack-ov}/ml-rules.html[Machine learning custom rules].
2222

2323

2424
==== Path Parameters

x-pack/docs/en/rest-api/ml/jobresource.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ NOTE: The `field_name` cannot contain double quotes or backslashes.
265265
when there is no value for the by or partition fields. The default value is `false`.
266266

267267
`custom_rules`::
268-
(array) An array of rule objects, which enable customizing how the detector works.
268+
(array) An array of custom rule objects, which enable customizing how the detector works.
269269
For example, a rule may dictate to the detector conditions under which results should be skipped.
270270
For more information see <<ml-detector-custom-rule,detector custom rule objects>>. +
271271
+
@@ -420,7 +420,7 @@ For more information, see
420420
{stack-ov}/ml-rules.html[Custom rules] enable you to customize the way detectors
421421
operate.
422422

423-
A rule has the following properties:
423+
A custom rule has the following properties:
424424

425425
`actions`::
426426
(array) The set of actions to be triggered when the rule applies.

0 commit comments

Comments
 (0)