elasticsearch/docs/reference/aggregations/bucket
David Roberts bfccd20155
[ML] Add a regex to the output of the categorize_text aggregation (#90723)
The new `regex` field in `categorize_text` output is created in
the same way as the `regex` field that appears in the category
definitions created by anomaly detection jobs that do categorization.

It consists of the terms that occur in the same order for every
message that matches the category, separated with a `.+?` wildcard.
It therefore matches the category messages and enforces the order
of the terms that occurred in the same order for all messages used
to create the category.

It is not recommended to use the regex as the primary mechanism for
searching for the original documents that were categorized. Search
using a regular expression is very slow. Instead the terms of the
category should be used to search for matching documents, as a
terms search can use the inverted index and hence be much faster.
However, there may be situations where it is useful to use the
`regex` field to test whether a small set of messages that have not
been indexed match the category.
2022-10-10 11:41:16 +01:00
..
adjacency-matrix-aggregation.asciidoc [DOCS] Reformat adjacency matrix agg reference (#70034) 2021-03-08 12:33:46 -05:00
autodatehistogram-aggregation.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
categorize-text-aggregation.asciidoc [ML] Add a regex to the output of the categorize_text aggregation (#90723) 2022-10-10 11:41:16 +01:00
children-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
composite-aggregation.asciidoc [DOCS] Fix typos in docs (#88226) 2022-07-05 11:02:29 +02:00
datehistogram-aggregation.asciidoc Remove deprecated date histo interval (#75000) 2021-07-20 13:08:45 -04:00
daterange-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
diversified-sampler-aggregation.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
filter-aggregation.asciidoc Update docs for filter agg (#72508) 2021-05-06 14:51:16 -04:00
filters-aggregation.asciidoc Update docs for filter agg (#72508) 2021-05-06 14:51:16 -04:00
frequent-items-aggregation.asciidoc [DOCS] Improves frequent items aggregation docs (#89122) 2022-08-08 15:46:29 +02:00
geodistance-aggregation.asciidoc Soft-deprecation of point/geo_point formats (#86835) 2022-05-17 23:46:43 +02:00
geohashgrid-aggregation.asciidoc Soft-deprecation of point/geo_point formats (#86835) 2022-05-17 23:46:43 +02:00
geohexgrid-aggregation.asciidoc Soft-deprecation of point/geo_point formats (#86835) 2022-05-17 23:46:43 +02:00
geotilegrid-aggregation.asciidoc Soft-deprecation of point/geo_point formats (#86835) 2022-05-17 23:46:43 +02:00
global-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
histogram-aggregation.asciidoc Update histogram-aggregation.asciidoc (#85356) 2022-03-28 12:27:32 -07:00
ipprefix-aggregation.asciidoc Add an aggregator for IPv4 and IPv6 subnets (#82410) 2022-01-28 11:59:07 +01:00
iprange-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
missing-aggregation.asciidoc Update JSON parser and snippets (#77983) 2021-09-20 11:08:26 +01:00
multi-terms-aggregation.asciidoc [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
nested-aggregation.asciidoc [DOCS] Add filter example to nested agg docs (#76118) 2021-08-05 09:48:28 -04:00
parent-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
random-sampler-aggregation.asciidoc Adding cardinality support for random_sampler agg (#86838) 2022-07-21 07:19:35 -04:00
range-aggregation.asciidoc [DOCS] Include index in range agg snippets (#77290) (#77568) 2021-09-10 12:36:05 -04:00
range-field-note.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
rare-terms-aggregation.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
reverse-nested-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
sampler-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
significantterms-aggregation.asciidoc [ML] add new normalize_above parameter to p_value significant terms heuristic (#78833) 2021-10-12 10:38:09 -04:00
significanttext-aggregation.asciidoc fix: use the correct field name when reading data from multi fields (#84752) 2022-03-11 17:11:26 +01:00
terms-aggregation.asciidoc Clarify risks around ordering terms aggregation (#86528) 2022-05-16 11:05:22 -04:00
variablewidthhistogram-aggregation.asciidoc Fix some typos in plugins & reference docs (#84667) 2022-03-07 12:29:58 -05:00