Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.5] [DOCS] Clarify description of geo_results (#91237) #91318

Merged
merged 2 commits into from
Nov 5, 2022
Merged

[8.5] [DOCS] Clarify description of geo_results (#91237) #91318

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4201396
[DOCS] Clarify description of geo_results (#91237)
lcawl Nov 4, 2022
849a608
[DOCS] Fix formatting
lcawl Nov 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 20 additions & 14 deletions docs/reference/ml/anomaly-detection/apis/get-record.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ default, the records are sorted by the `record_score` value.
(Optional, string) Returns records with timestamps after this time. Defaults to
`-1`, which means it is unset and results are not limited to specific timestamps.

[role="child_attributes"]
[[ml-get-record-request-body]]
== {api-request-body-title}

Expand All @@ -96,6 +97,7 @@ You can also specify the query parameters in the request body; the exception are
to `100`.
====

[role="child_attributes"]
[[ml-get-record-results]]
== {api-response-body-title}

Expand Down Expand Up @@ -142,15 +144,19 @@ configuration. For example, `max`.
(string) The description of the function in which the anomaly occurs, as
specified in the detector configuration.

`geo_results.actual_point`::
(string) The actual value for the bucket formatted as a `geo_point`. If the
detector function is `lat_long`, this is a comma delimited string of the
latitude and longitude.
`geo_results`::
(optional, object) If the detector function is `lat_long`, this object contains
comma delimited strings for the latitude and longitude of the actual and typical values.
+
.Properties of `geo_results`
[%collapsible%open]
====
`actual_point`::
(string) The actual value for the bucket formatted as a `geo_point`.

`geo_results.typical_point`::
(string) The typical value for the bucket formatted as a `geo_point`. If the
detector function is `lat_long`, this is a comma delimited string of the
latitude and longitude.
`typical_point`::
(string) The typical value for the bucket formatted as a `geo_point`.
====

`influencers`::
(array) If `influencers` was specified in the detector configuration, this array
Expand All @@ -169,6 +175,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
(string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

`multi_bucket_impact`::
(number) An indication of how strongly an anomaly is multi bucket or single
bucket. The value is on a scale of `-5.0` to `+5.0` where `-5.0` means the
anomaly is purely single bucket and `+5.0` means the anomaly is purely multi
bucket.

`over_field_name`::
(string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=over-field-name]
Expand All @@ -189,12 +201,6 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=partition-field-name]
of over 300 decimal places, so the `record_score` is provided as a
human-readable and friendly interpretation of this.

`multi_bucket_impact`::
(number) An indication of how strongly an anomaly is multi bucket or single
bucket. The value is on a scale of `-5.0` to `+5.0` where `-5.0` means the
anomaly is purely single bucket and `+5.0` means the anomaly is purely multi
bucket.

`record_score`::
(number) A normalized score between 0-100, which is based on the probability of
the anomalousness of this record. Unlike `initial_record_score`, this value will
Expand Down