-
Notifications
You must be signed in to change notification settings - Fork 258
/
com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.yml
119 lines (119 loc) · 8.65 KB
/
com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
### YamlMime:JavaType
uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult"
name: "UnivariateLastDetectionResult"
nameWithType: "UnivariateLastDetectionResult"
summary: "The response of last anomaly detection."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **UnivariateLastDetectionResult**"
methods:
- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getExpectedValue()"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getExpectedValue()"
name: "getExpectedValue()"
nameWithType: "UnivariateLastDetectionResult.getExpectedValue()"
summary: "Get the expected<wbr>Value property: Expected value of the latest point."
syntax: "public double getExpectedValue()"
desc: "Get the expectedValue property: Expected value of the latest point."
returns:
description: "the expectedValue value."
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getLowerMargin()"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getLowerMargin()"
name: "getLowerMargin()"
nameWithType: "UnivariateLastDetectionResult.getLowerMargin()"
summary: "Get the lower<wbr>Margin property: Lower margin of the latest point."
syntax: "public double getLowerMargin()"
desc: "Get the lowerMargin property: Lower margin of the latest point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)\\*lowerMargin."
returns:
description: "the lowerMargin value."
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getPeriod()"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getPeriod()"
name: "getPeriod()"
nameWithType: "UnivariateLastDetectionResult.getPeriod()"
summary: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found."
syntax: "public int getPeriod()"
desc: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found."
returns:
description: "the period value."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getSeverity()"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getSeverity()"
name: "getSeverity()"
nameWithType: "UnivariateLastDetectionResult.getSeverity()"
summary: "Get the severity property: The severity score for the last input point."
syntax: "public Double getSeverity()"
desc: "Get the severity property: The severity score for the last input point. The larger the value is, the more sever the anomaly is. For normal points, the \"severity\" is always 0."
returns:
description: "the severity value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getSuggestedWindow()"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getSuggestedWindow()"
name: "getSuggestedWindow()"
nameWithType: "UnivariateLastDetectionResult.getSuggestedWindow()"
summary: "Get the suggested<wbr>Window property: Suggested input series points needed for detecting the latest point."
syntax: "public int getSuggestedWindow()"
desc: "Get the suggestedWindow property: Suggested input series points needed for detecting the latest point."
returns:
description: "the suggestedWindow value."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getUpperMargin()"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getUpperMargin()"
name: "getUpperMargin()"
nameWithType: "UnivariateLastDetectionResult.getUpperMargin()"
summary: "Get the upper<wbr>Margin property: Upper margin of the latest point."
syntax: "public double getUpperMargin()"
desc: "Get the upperMargin property: Upper margin of the latest point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)\\*upperMargin. If the value of latest point is between upperBoundary and lowerBoundary, it should be treated as normal value. By adjusting marginScale value, anomaly status of latest point can be changed."
returns:
description: "the upperMargin value."
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isAnomaly()"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isAnomaly()"
name: "isAnomaly()"
nameWithType: "UnivariateLastDetectionResult.isAnomaly()"
summary: "Get the is<wbr>Anomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction."
syntax: "public boolean isAnomaly()"
desc: "Get the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction."
returns:
description: "the isAnomaly value."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isNegativeAnomaly()"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isNegativeAnomaly()"
name: "isNegativeAnomaly()"
nameWithType: "UnivariateLastDetectionResult.isNegativeAnomaly()"
summary: "Get the is<wbr>Negative<wbr>Anomaly property: Anomaly status in negative direction of the latest point."
syntax: "public boolean isNegativeAnomaly()"
desc: "Get the isNegativeAnomaly property: Anomaly status in negative direction of the latest point. True means the latest point is an anomaly and its real value is smaller than the expected one."
returns:
description: "the isNegativeAnomaly value."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isPositiveAnomaly()"
fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isPositiveAnomaly()"
name: "isPositiveAnomaly()"
nameWithType: "UnivariateLastDetectionResult.isPositiveAnomaly()"
summary: "Get the is<wbr>Positive<wbr>Anomaly property: Anomaly status in positive direction of the latest point."
syntax: "public boolean isPositiveAnomaly()"
desc: "Get the isPositiveAnomaly property: Anomaly status in positive direction of the latest point. True means the latest point is an anomaly and its real value is larger than the expected one."
returns:
description: "the isPositiveAnomaly value."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The response of last anomaly detection."
metadata: {}
package: "com.azure.ai.anomalydetector.models"
artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5