-
Notifications
You must be signed in to change notification settings - Fork 258
/
IAnomalyDetectorClient.xml
234 lines (234 loc) · 18.6 KB
/
IAnomalyDetectorClient.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
<Type Name="IAnomalyDetectorClient" FullName="Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient">
<TypeSignature Language="C#" Value="public interface IAnomalyDetectorClient : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IAnomalyDetectorClient implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient" />
<TypeSignature Language="VB.NET" Value="Public Interface IAnomalyDetectorClient
Implements IDisposable" />
<TypeSignature Language="F#" Value="type IAnomalyDetectorClient = interface
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>0.8.0.0</AssemblyVersion>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
The Anomaly Detector API detects anomalies automatically in time series
data. It supports two functionalities, one is for detecting the whole
series with model trained by the timeseries, another is detecting last
point with model trained by points before. By using this service,
business customers can discover incidents and establish a logic flow
for root cause analysis.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ChangePointDetectWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.ChangePointDetectResponse>> ChangePointDetectWithHttpMessagesAsync (Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.ChangePointDetectRequest body, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.ChangePointDetectResponse>> ChangePointDetectWithHttpMessagesAsync(class Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.ChangePointDetectRequest body, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.ChangePointDetectWithHttpMessagesAsync(Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.ChangePointDetectRequest,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ChangePointDetectWithHttpMessagesAsync (body As ChangePointDetectRequest, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of ChangePointDetectResponse))" />
<MemberSignature Language="F#" Value="abstract member ChangePointDetectWithHttpMessagesAsync : Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.ChangePointDetectRequest * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.ChangePointDetectResponse>>" Usage="iAnomalyDetectorClient.ChangePointDetectWithHttpMessagesAsync (body, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.ChangePointDetectResponse>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="body" Type="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.ChangePointDetectRequest" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="body">To be added.</param>
<param name="customHeaders">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Credentials">
<MemberSignature Language="C#" Value="public Microsoft.Rest.ServiceClientCredentials Credentials { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Rest.ServiceClientCredentials Credentials" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.Credentials" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Credentials As ServiceClientCredentials" />
<MemberSignature Language="F#" Value="member this.Credentials : Microsoft.Rest.ServiceClientCredentials" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.Credentials" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rest.ServiceClientCredentials</ReturnType>
</ReturnValue>
<Docs>
<summary>
Subscription credentials which uniquely identify client
subscription.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeserializationSettings">
<MemberSignature Language="C#" Value="public Newtonsoft.Json.JsonSerializerSettings DeserializationSettings { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Newtonsoft.Json.JsonSerializerSettings DeserializationSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.DeserializationSettings" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeserializationSettings As JsonSerializerSettings" />
<MemberSignature Language="F#" Value="member this.DeserializationSettings : Newtonsoft.Json.JsonSerializerSettings" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.DeserializationSettings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Newtonsoft.Json.JsonSerializerSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets json deserialization settings.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Endpoint">
<MemberSignature Language="C#" Value="public string Endpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Endpoint" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.Endpoint" />
<MemberSignature Language="VB.NET" Value="Public Property Endpoint As String" />
<MemberSignature Language="F#" Value="member this.Endpoint : string with get, set" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.Endpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Supported Cognitive Services endpoints (protocol and hostname, for
example: https://westus2.api.cognitive.microsoft.com).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EntireDetectWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse>> EntireDetectWithHttpMessagesAsync (Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request body, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse>> EntireDetectWithHttpMessagesAsync(class Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request body, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.EntireDetectWithHttpMessagesAsync(Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function EntireDetectWithHttpMessagesAsync (body As Request, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of EntireDetectResponse))" />
<MemberSignature Language="F#" Value="abstract member EntireDetectWithHttpMessagesAsync : Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse>>" Usage="iAnomalyDetectorClient.EntireDetectWithHttpMessagesAsync (body, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.EntireDetectResponse>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="body" Type="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="body">
Time series points and period if needed. Advanced model parameters
can also be set in the request.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Detect anomalies for the entire series in batch.
</summary>
<returns>To be added.</returns>
<remarks>
This operation generates a model using an entire series, each point
is detected with the same model. With this method, points before
and after a certain point are used to determine whether it is an
anomaly. The entire detection can give user an overall status of
the time series.
</remarks>
</Docs>
</Member>
<Member MemberName="LastDetectWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.LastDetectResponse>> LastDetectWithHttpMessagesAsync (Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request body, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.LastDetectResponse>> LastDetectWithHttpMessagesAsync(class Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request body, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.LastDetectWithHttpMessagesAsync(Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function LastDetectWithHttpMessagesAsync (body As Request, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of LastDetectResponse))" />
<MemberSignature Language="F#" Value="abstract member LastDetectWithHttpMessagesAsync : Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.LastDetectResponse>>" Usage="iAnomalyDetectorClient.LastDetectWithHttpMessagesAsync (body, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.LastDetectResponse>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="body" Type="Microsoft.Azure.CognitiveServices.AnomalyDetector.Models.Request" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="body">
Time series points and period if needed. Advanced model parameters
can also be set in the request.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Detect anomaly status of the latest point in time series.
</summary>
<returns>To be added.</returns>
<remarks>
This operation generates a model using points before the latest
one. With this method, only historical points are used to determine
whether the target point is an anomaly. The latest point detecting
operation matches the scenario of real-time monitoring of business
metrics.
</remarks>
</Docs>
</Member>
<Member MemberName="SerializationSettings">
<MemberSignature Language="C#" Value="public Newtonsoft.Json.JsonSerializerSettings SerializationSettings { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Newtonsoft.Json.JsonSerializerSettings SerializationSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.SerializationSettings" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SerializationSettings As JsonSerializerSettings" />
<MemberSignature Language="F#" Value="member this.SerializationSettings : Newtonsoft.Json.JsonSerializerSettings" Usage="Microsoft.Azure.CognitiveServices.AnomalyDetector.IAnomalyDetectorClient.SerializationSettings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.AnomalyDetector</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Newtonsoft.Json.JsonSerializerSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>
The base URI of the service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>