Share via

@azure-rest/ai-anomaly-detector package

Interfaces

AlignPolicy

An optional field, indicating the manner to align multiple variables.
AlignPolicyOutput

An optional field, indicating the manner to align multiple variables.
AnomalyDetectionModelOutput

Response of getting a model.
AnomalyDetectorErrorOutput

Error information returned by the API.
AnomalyDetectorRestClientOptions
AnomalyInterpretationOutput

Interpretation of the anomalous timestamp.
AnomalyStateOutput

Anomaly status and information.
AnomalyValueOutput

Detailed information of the anomalous timestamp.
CorrelationChangesOutput

Correlation changes among the anomalous variables
DeleteMultivariateModel
DeleteMultivariateModel204Response

There is no content to send for this request, but the headers may be useful.
DeleteMultivariateModelDefaultHeaders
DeleteMultivariateModelDefaultResponse
DetectMultivariateBatchAnomaly
DetectMultivariateBatchAnomaly202Headers
DetectMultivariateBatchAnomaly202Response

The request has been accepted for processing, but processing has not yet completed.
DetectMultivariateBatchAnomalyBodyParam
DetectMultivariateBatchAnomalyDefaultHeaders
DetectMultivariateBatchAnomalyDefaultResponse
DetectMultivariateLastAnomaly
DetectMultivariateLastAnomaly200Response

The request has succeeded.
DetectMultivariateLastAnomalyBodyParam
DetectMultivariateLastAnomalyDefaultHeaders
DetectMultivariateLastAnomalyDefaultResponse
DetectUnivariateChangePoint
DetectUnivariateChangePoint200Response

The request has succeeded.
DetectUnivariateChangePointBodyParam
DetectUnivariateChangePointDefaultHeaders
DetectUnivariateChangePointDefaultResponse
DetectUnivariateEntireSeries
DetectUnivariateEntireSeries200Response

The request has succeeded.
DetectUnivariateEntireSeriesBodyParam
DetectUnivariateEntireSeriesDefaultHeaders
DetectUnivariateEntireSeriesDefaultResponse
DetectUnivariateLastPoint
DetectUnivariateLastPoint200Response

The request has succeeded.
DetectUnivariateLastPointBodyParam
DetectUnivariateLastPointDefaultHeaders
DetectUnivariateLastPointDefaultResponse
DiagnosticsInfo

Diagnostics information to help inspect the states of model or variable.
DiagnosticsInfoOutput

Diagnostics information to help inspect the states of model or variable.
ErrorResponse

ErrorResponse contains code and message that shows the error information.
ErrorResponseOutput

ErrorResponse contains code and message that shows the error information.
GetMultivariateBatchDetectionResult
GetMultivariateBatchDetectionResult200Response

The request has succeeded.
GetMultivariateBatchDetectionResultDefaultHeaders
GetMultivariateBatchDetectionResultDefaultResponse
GetMultivariateModel200Response

The request has succeeded.
GetMultivariateModelDefaultHeaders
GetMultivariateModelDefaultResponse
ListMultivariateModels200Response

The request has succeeded.
ListMultivariateModelsDefaultHeaders
ListMultivariateModelsDefaultResponse
ListMultivariateModelsQueryParam
ListMultivariateModelsQueryParamProperties
ModelInfo

Training result of a model including its status, errors and diagnostics information.
ModelInfoOutput

Training result of a model including its status, errors and diagnostics information.
ModelListOutput

Response of listing models.
ModelState

Model status.
ModelStateOutput

Model status.
MultivariateBatchDetectionOptions

Detection request for batch inference. This is an asynchronous inference which will need another API to get detection results.
MultivariateBatchDetectionOptionsOutput

Detection request for batch inference. This is an asynchronous inference which will need another API to get detection results.
MultivariateBatchDetectionResultSummaryOutput

Multivariate anomaly detection status.
MultivariateDetectionResultOutput

Detection results for the given resultId.
MultivariateLastDetectionOptions

Request of last detection.
MultivariateLastDetectionResultOutput

Results of last detection.
PagingOptions

Options for the paging helper
Routes
TimeSeriesPoint

The definition of input timeseries points.
TrainMultivariateModel
TrainMultivariateModel201Headers
TrainMultivariateModel201Response

The request has succeeded and a new resource has been created as a result.
TrainMultivariateModelBodyParam
TrainMultivariateModelDefaultHeaders
TrainMultivariateModelDefaultResponse
UnivariateChangePointDetectionOptions

The request of change point detection.
UnivariateChangePointDetectionResultOutput

The response of change point detection.
UnivariateDetectionOptions

The request of entire or last anomaly detection.
UnivariateEntireDetectionResultOutput

The response of entire anomaly detection.
UnivariateLastDetectionResultOutput

The response of last anomaly detection.
VariableState

Variable Status.
VariableStateOutput

Variable Status.
VariableValues

Variable values.

Type Aliases

AnomalyDetectorRestClient
DeleteMultivariateModelParameters
DetectMultivariateBatchAnomalyParameters
DetectMultivariateLastAnomalyParameters
DetectUnivariateChangePointParameters
DetectUnivariateEntireSeriesParameters
DetectUnivariateLastPointParameters
GetArrayType

Helper type to extract the type of an array
GetMultivariateBatchDetectionResultParameters
GetMultivariateModelParameters
GetPage

The type of a custom function that defines how to get a page and a link to the next one if any.
ListMultivariateModelsParameters
PaginateReturn

Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
TrainMultivariateModelParameters

Functions

default(string, KeyCredential, AnomalyDetectorRestClientOptions)

Initialize a new instance of the class AnomalyDetectorRestClient class.
isUnexpected(DetectUnivariateEntireSeries200Response | DetectUnivariateEntireSeriesDefaultResponse)
isUnexpected(DetectUnivariateLastPoint200Response | DetectUnivariateLastPointDefaultResponse)
isUnexpected(DetectUnivariateChangePoint200Response | DetectUnivariateChangePointDefaultResponse)
isUnexpected(GetMultivariateBatchDetectionResult200Response | GetMultivariateBatchDetectionResultDefaultResponse)
isUnexpected(TrainMultivariateModel201Response | TrainMultivariateModelDefaultResponse)
isUnexpected(ListMultivariateModels200Response | ListMultivariateModelsDefaultResponse)
isUnexpected(DeleteMultivariateModel204Response | DeleteMultivariateModelDefaultResponse)
isUnexpected(GetMultivariateModel200Response | GetMultivariateModelDefaultResponse)
isUnexpected(DetectMultivariateBatchAnomaly202Response | DetectMultivariateBatchAnomalyDefaultResponse)
isUnexpected(DetectMultivariateLastAnomaly200Response | DetectMultivariateLastAnomalyDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(string, KeyCredential, AnomalyDetectorRestClientOptions)

Initialize a new instance of the class AnomalyDetectorRestClient class.

function default(Endpoint: string, credentials: KeyCredential, options?: AnomalyDetectorRestClientOptions): AnomalyDetectorRestClient

Parameters

Endpoint

string

type: string

credentials
KeyCredential

type: KeyCredential

options
AnomalyDetectorRestClientOptions

Returns

AnomalyDetectorRestClient

isUnexpected(DetectUnivariateEntireSeries200Response | DetectUnivariateEntireSeriesDefaultResponse) 

function isUnexpected(response: DetectUnivariateEntireSeries200Response | DetectUnivariateEntireSeriesDefaultResponse): response

Parameters

response

DetectUnivariateEntireSeries200Response | DetectUnivariateEntireSeriesDefaultResponse

Returns

response

isUnexpected(DetectUnivariateLastPoint200Response | DetectUnivariateLastPointDefaultResponse) 

function isUnexpected(response: DetectUnivariateLastPoint200Response | DetectUnivariateLastPointDefaultResponse): response

Parameters

response

DetectUnivariateLastPoint200Response | DetectUnivariateLastPointDefaultResponse

Returns

response

isUnexpected(DetectUnivariateChangePoint200Response | DetectUnivariateChangePointDefaultResponse) 

function isUnexpected(response: DetectUnivariateChangePoint200Response | DetectUnivariateChangePointDefaultResponse): response

Parameters

response

DetectUnivariateChangePoint200Response | DetectUnivariateChangePointDefaultResponse

Returns

response

isUnexpected(GetMultivariateBatchDetectionResult200Response | GetMultivariateBatchDetectionResultDefaultResponse) 

function isUnexpected(response: GetMultivariateBatchDetectionResult200Response | GetMultivariateBatchDetectionResultDefaultResponse): response

Parameters

response

GetMultivariateBatchDetectionResult200Response | GetMultivariateBatchDetectionResultDefaultResponse

Returns

response

isUnexpected(TrainMultivariateModel201Response | TrainMultivariateModelDefaultResponse) 

function isUnexpected(response: TrainMultivariateModel201Response | TrainMultivariateModelDefaultResponse): response

Parameters

response

TrainMultivariateModel201Response | TrainMultivariateModelDefaultResponse

Returns

response

isUnexpected(ListMultivariateModels200Response | ListMultivariateModelsDefaultResponse) 

function isUnexpected(response: ListMultivariateModels200Response | ListMultivariateModelsDefaultResponse): response

Parameters

response

ListMultivariateModels200Response | ListMultivariateModelsDefaultResponse

Returns

response

isUnexpected(DeleteMultivariateModel204Response | DeleteMultivariateModelDefaultResponse) 

function isUnexpected(response: DeleteMultivariateModel204Response | DeleteMultivariateModelDefaultResponse): response

Parameters

response

DeleteMultivariateModel204Response | DeleteMultivariateModelDefaultResponse

Returns

response

isUnexpected(GetMultivariateModel200Response | GetMultivariateModelDefaultResponse) 

function isUnexpected(response: GetMultivariateModel200Response | GetMultivariateModelDefaultResponse): response

Parameters

response

GetMultivariateModel200Response | GetMultivariateModelDefaultResponse

Returns

response

isUnexpected(DetectMultivariateBatchAnomaly202Response | DetectMultivariateBatchAnomalyDefaultResponse) 

function isUnexpected(response: DetectMultivariateBatchAnomaly202Response | DetectMultivariateBatchAnomalyDefaultResponse): response

Parameters

response

DetectMultivariateBatchAnomaly202Response | DetectMultivariateBatchAnomalyDefaultResponse

Returns

response

isUnexpected(DetectMultivariateLastAnomaly200Response | DetectMultivariateLastAnomalyDefaultResponse) 

function isUnexpected(response: DetectMultivariateLastAnomaly200Response | DetectMultivariateLastAnomalyDefaultResponse): response

Parameters

response

DetectMultivariateLastAnomaly200Response | DetectMultivariateLastAnomalyDefaultResponse

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client
Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator to iterate the elements