Skip to content

Add anomaly score explanation for ML get records endpoint #1983

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.

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

Merged
merged 7 commits into from
Nov 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
148 changes: 145 additions & 3 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

47 changes: 47 additions & 0 deletions specification/ml/_types/Anomaly.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ import { DurationValue, EpochTime, UnitMillis, UnitSeconds } from '@_types/Time'

export class Anomaly {
actual?: double[]
/**
* Information about the factors impacting the initial anomaly score.
*/
anomaly_score_explanation?: AnomalyExplanation
bucket_span: DurationValue<UnitSeconds>
by_field_name?: string
by_field_value?: string
Expand Down Expand Up @@ -67,3 +71,46 @@ export class Influence {
influencer_field_name: string
influencer_field_values: string[]
}

export class AnomalyExplanation {
/**
* Impact from the duration and magnitude of the detected anomaly relative to the historical average.
*/
anomaly_characteristics_impact?: integer
/**
* Length of the detected anomaly in the number of buckets.
*/
anomaly_length?: integer
/**
* Type of the detected anomaly: `spike` or `dip`.
*/
anomaly_type?: string
/**
* Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced.
*/
high_variance_penalty?: boolean
/**
* If the bucket contains fewer samples than expected, the score is reduced.
*/
incomplete_bucket_penalty?: boolean
/**
* Lower bound of the 95% confidence interval.
*/
lower_confidence_bound?: double
/**
* Impact of the deviation between actual and typical values in the past 12 buckets.
*/
multi_bucket_impact?: integer
/**
* Impact of the deviation between actual and typical values in the current bucket.
*/
single_bucket_impact?: integer
/**
* Typical (expected) value for this bucket.
*/
typical_value?: double
/**
* Upper bound of the 95% confidence interval.
*/
upper_confidence_bound?: double
}