-
Notifications
You must be signed in to change notification settings - Fork 258
/
EntireDetectResponse.xml
345 lines (345 loc) · 21.9 KB
/
EntireDetectResponse.xml
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<Type Name="EntireDetectResponse" FullName="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse">
<TypeSignature Language="C#" Value="public class EntireDetectResponse" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EntireDetectResponse extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse" />
<TypeSignature Language="VB.NET" Value="Public Class EntireDetectResponse" />
<TypeSignature Language="F#" Value="type EntireDetectResponse = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>0.8.0.0</AssemblyVersion>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EntireDetectResponse ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the EntireDetectResponse class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EntireDetectResponse (int period, System.Collections.Generic.IList<double> expectedValues, System.Collections.Generic.IList<double> upperMargins, System.Collections.Generic.IList<double> lowerMargins, System.Collections.Generic.IList<bool> isAnomaly, System.Collections.Generic.IList<bool> isNegativeAnomaly, System.Collections.Generic.IList<bool> isPositiveAnomaly);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 period, class System.Collections.Generic.IList`1<float64> expectedValues, class System.Collections.Generic.IList`1<float64> upperMargins, class System.Collections.Generic.IList`1<float64> lowerMargins, class System.Collections.Generic.IList`1<bool> isAnomaly, class System.Collections.Generic.IList`1<bool> isNegativeAnomaly, class System.Collections.Generic.IList`1<bool> isPositiveAnomaly) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.#ctor(System.Int32,System.Collections.Generic.IList{System.Double},System.Collections.Generic.IList{System.Double},System.Collections.Generic.IList{System.Double},System.Collections.Generic.IList{System.Boolean},System.Collections.Generic.IList{System.Boolean},System.Collections.Generic.IList{System.Boolean})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (period As Integer, expectedValues As IList(Of Double), upperMargins As IList(Of Double), lowerMargins As IList(Of Double), isAnomaly As IList(Of Boolean), isNegativeAnomaly As IList(Of Boolean), isPositiveAnomaly As IList(Of Boolean))" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse : int * System.Collections.Generic.IList<double> * System.Collections.Generic.IList<double> * System.Collections.Generic.IList<double> * System.Collections.Generic.IList<bool> * System.Collections.Generic.IList<bool> * System.Collections.Generic.IList<bool> -> Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse" Usage="new Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse (period, expectedValues, upperMargins, lowerMargins, isAnomaly, isNegativeAnomaly, isPositiveAnomaly)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="period" Type="System.Int32" />
<Parameter Name="expectedValues" Type="System.Collections.Generic.IList<System.Double>" />
<Parameter Name="upperMargins" Type="System.Collections.Generic.IList<System.Double>" />
<Parameter Name="lowerMargins" Type="System.Collections.Generic.IList<System.Double>" />
<Parameter Name="isAnomaly" Type="System.Collections.Generic.IList<System.Boolean>" />
<Parameter Name="isNegativeAnomaly" Type="System.Collections.Generic.IList<System.Boolean>" />
<Parameter Name="isPositiveAnomaly" Type="System.Collections.Generic.IList<System.Boolean>" />
</Parameters>
<Docs>
<param name="period">Frequency extracted from the series, zero
means no recurrent pattern has been found.</param>
<param name="expectedValues">ExpectedValues contain expected value
for each input point. The index of the array is consistent with the
input series.</param>
<param name="upperMargins">UpperMargins contain upper margin of
each input point. UpperMargin is used to calculate upperBoundary,
which equals to expectedValue + (100 - marginScale)*upperMargin.
Anomalies in response can be filtered by upperBoundary and
lowerBoundary. By adjusting marginScale value, less significant
anomalies can be filtered in client side. The index of the array is
consistent with the input series.</param>
<param name="lowerMargins">LowerMargins contain lower margin of
each input point. LowerMargin is used to calculate lowerBoundary,
which equals to expectedValue - (100 - marginScale)*lowerMargin.
Points between the boundary can be marked as normal ones in client
side. The index of the array is consistent with the input
series.</param>
<param name="isAnomaly">IsAnomaly contains anomaly properties for
each input point. True means an anomaly either negative or positive
has been detected. The index of the array is consistent with the
input series.</param>
<param name="isNegativeAnomaly">IsNegativeAnomaly contains anomaly
status in negative direction for each input point. True means a
negative anomaly has been detected. A negative anomaly means the
point is detected as an anomaly and its real value is smaller than
the expected one. The index of the array is consistent with the
input series.</param>
<param name="isPositiveAnomaly">IsPositiveAnomaly contain anomaly
status in positive direction for each input point. True means a
positive anomaly has been detected. A positive anomaly means the
point is detected as an anomaly and its real value is larger than
the expected one. The index of the array is consistent with the
input series.</param>
<summary>
Initializes a new instance of the EntireDetectResponse class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExpectedValues">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<double> ExpectedValues { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<float64> ExpectedValues" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.ExpectedValues" />
<MemberSignature Language="VB.NET" Value="Public Property ExpectedValues As IList(Of Double)" />
<MemberSignature Language="F#" Value="member this.ExpectedValues : System.Collections.Generic.IList<double> with get, set" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.ExpectedValues" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="expectedValues")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="expectedValues")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets expectedValues contain expected value for each input
point. The index of the array is consistent with the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAnomaly">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<bool> IsAnomaly { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<bool> IsAnomaly" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.IsAnomaly" />
<MemberSignature Language="VB.NET" Value="Public Property IsAnomaly As IList(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsAnomaly : System.Collections.Generic.IList<bool> with get, set" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.IsAnomaly" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="isAnomaly")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="isAnomaly")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets isAnomaly contains anomaly properties for each input
point. True means an anomaly either negative or positive has been
detected. The index of the array is consistent with the input
series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsNegativeAnomaly">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<bool> IsNegativeAnomaly { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<bool> IsNegativeAnomaly" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.IsNegativeAnomaly" />
<MemberSignature Language="VB.NET" Value="Public Property IsNegativeAnomaly As IList(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsNegativeAnomaly : System.Collections.Generic.IList<bool> with get, set" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.IsNegativeAnomaly" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="isNegativeAnomaly")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="isNegativeAnomaly")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets isNegativeAnomaly contains anomaly status in negative
direction for each input point. True means a negative anomaly has
been detected. A negative anomaly means the point is detected as an
anomaly and its real value is smaller than the expected one. The
index of the array is consistent with the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsPositiveAnomaly">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<bool> IsPositiveAnomaly { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<bool> IsPositiveAnomaly" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.IsPositiveAnomaly" />
<MemberSignature Language="VB.NET" Value="Public Property IsPositiveAnomaly As IList(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsPositiveAnomaly : System.Collections.Generic.IList<bool> with get, set" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.IsPositiveAnomaly" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="isPositiveAnomaly")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="isPositiveAnomaly")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets isPositiveAnomaly contain anomaly status in positive
direction for each input point. True means a positive anomaly has
been detected. A positive anomaly means the point is detected as an
anomaly and its real value is larger than the expected one. The
index of the array is consistent with the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LowerMargins">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<double> LowerMargins { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<float64> LowerMargins" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.LowerMargins" />
<MemberSignature Language="VB.NET" Value="Public Property LowerMargins As IList(Of Double)" />
<MemberSignature Language="F#" Value="member this.LowerMargins : System.Collections.Generic.IList<double> with get, set" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.LowerMargins" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="lowerMargins")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="lowerMargins")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets lowerMargins contain lower margin of each input point.
LowerMargin is used to calculate lowerBoundary, which equals to
expectedValue - (100 - marginScale)*lowerMargin. Points between the
boundary can be marked as normal ones in client side. The index of
the array is consistent with the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Period">
<MemberSignature Language="C#" Value="public int Period { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Period" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.Period" />
<MemberSignature Language="VB.NET" Value="Public Property Period As Integer" />
<MemberSignature Language="F#" Value="member this.Period : int with get, set" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.Period" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="period")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="period")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets frequency extracted from the series, zero means no
recurrent pattern has been found.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpperMargins">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<double> UpperMargins { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<float64> UpperMargins" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.UpperMargins" />
<MemberSignature Language="VB.NET" Value="Public Property UpperMargins As IList(Of Double)" />
<MemberSignature Language="F#" Value="member this.UpperMargins : System.Collections.Generic.IList<double> with get, set" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.UpperMargins" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="upperMargins")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="upperMargins")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets upperMargins contain upper margin of each input point.
UpperMargin is used to calculate upperBoundary, which equals to
expectedValue + (100 - marginScale)*upperMargin. Anomalies in
response can be filtered by upperBoundary and lowerBoundary. By
adjusting marginScale value, less significant anomalies can be
filtered in client side. The index of the array is consistent with
the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="entireDetectResponse.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>