Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/ai-anomaly-detector

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AlignMode

AlignMode: "Inner" | "Outer"

Defines values for AlignMode.

AnomalyDetectorDetectAnomalyResponse

AnomalyDetectorDetectAnomalyResponse: AnomalyDetectorDetectAnomalyHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: AnomalyDetectorDetectAnomalyHeaders } }

Contains response data for the detectAnomaly operation.

AnomalyDetectorDetectChangePointResponse

AnomalyDetectorDetectChangePointResponse: DetectChangePointResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DetectChangePointResponse } }

Contains response data for the detectChangePoint operation.

AnomalyDetectorDetectEntireSeriesResponse

AnomalyDetectorDetectEntireSeriesResponse: DetectEntireResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DetectEntireResponse } }

Contains response data for the detectEntireSeries operation.

AnomalyDetectorDetectLastPointResponse

AnomalyDetectorDetectLastPointResponse: DetectLastPointResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DetectLastPointResponse } }

Contains response data for the detectLastPoint operation.

AnomalyDetectorErrorCodes

AnomalyDetectorErrorCodes: string

Defines values for AnomalyDetectorErrorCodes.
KnownAnomalyDetectorErrorCodes can be used interchangeably with AnomalyDetectorErrorCodes, this enum contains the known values that the service supports.

Known values supported by the service

InvalidCustomInterval
BadArgument
InvalidGranularity
InvalidPeriod
InvalidModelArgument
InvalidSeries
InvalidJsonFormat
RequiredGranularity
RequiredSeries
InvalidImputeMode
InvalidImputeFixedValue

AnomalyDetectorExportModelResponse

AnomalyDetectorExportModelResponse: { _response: coreHttp.HttpResponse; blobBody?: Promise<Blob>; readableStreamBody?: NodeJS.ReadableStream }

Contains response data for the exportModel operation.

Type declaration

  • _response: coreHttp.HttpResponse

    The underlying HTTP response.

  • Optional blobBody?: Promise<Blob>

    BROWSER ONLY

    The response body as a browser Blob. Always undefined in node.js.

  • Optional readableStreamBody?: NodeJS.ReadableStream

    NODEJS ONLY

    The response body as a node.js Readable stream. Always undefined in the browser.

AnomalyDetectorGetDetectionResultResponse

AnomalyDetectorGetDetectionResultResponse: DetectionResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DetectionResult } }

Contains response data for the getDetectionResult operation.

AnomalyDetectorGetMultivariateModelResponse

AnomalyDetectorGetMultivariateModelResponse: Model & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Model } }

Contains response data for the getMultivariateModel operation.

AnomalyDetectorLastDetectAnomalyResponse

AnomalyDetectorLastDetectAnomalyResponse: LastDetectionResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: LastDetectionResult } }

Contains response data for the lastDetectAnomaly operation.

AnomalyDetectorListMultivariateModelNextResponse

AnomalyDetectorListMultivariateModelNextResponse: ModelList & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ModelList } }

Contains response data for the listMultivariateModelNext operation.

AnomalyDetectorListMultivariateModelResponse

AnomalyDetectorListMultivariateModelResponse: ModelList & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ModelList } }

Contains response data for the listMultivariateModel operation.

AnomalyDetectorTrainMultivariateModelResponse

AnomalyDetectorTrainMultivariateModelResponse: AnomalyDetectorTrainMultivariateModelHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: AnomalyDetectorTrainMultivariateModelHeaders } }

Contains response data for the trainMultivariateModel operation.

DetectionStatus

DetectionStatus: "CREATED" | "RUNNING" | "READY" | "FAILED"

Defines values for DetectionStatus.

FillNAMethod

FillNAMethod: string

Defines values for FillNAMethod.
KnownFillNAMethod can be used interchangeably with FillNAMethod, this enum contains the known values that the service supports.

Known values supported by the service

Previous
Subsequent
Linear
Zero
Fixed
NotFill

ImputeMode

ImputeMode: string

Defines values for ImputeMode.
KnownImputeMode can be used interchangeably with ImputeMode, this enum contains the known values that the service supports.

Known values supported by the service

auto
previous
linear
fixed
zero
notFill

ModelStatus

ModelStatus: "CREATED" | "RUNNING" | "READY" | "FAILED"

Defines values for ModelStatus.

TimeGranularity

TimeGranularity: "yearly" | "monthly" | "weekly" | "daily" | "hourly" | "minutely" | "secondly" | "microsecond" | "none"

Defines values for TimeGranularity.

Variables

Const API_KEY_HEADER_NAME

API_KEY_HEADER_NAME: "Ocp-Apim-Subscription-Key" = "Ocp-Apim-Subscription-Key"

Const AnomalyDetectorLoggingAllowedHeaderNames

AnomalyDetectorLoggingAllowedHeaderNames: string[] = ["apim-request-id","Location","Operation-Location","Strict-Transport-Security","X-Content-Type-Options","x-envoy-upstream-service-time","Ocp-Apim-Subscription-Key",]

Const AnomalyDetectorLoggingAllowedQueryParameters

AnomalyDetectorLoggingAllowedQueryParameters: string[] = ["includeTextDetails","includeKeys","op",]

Const DEFAULT_COGNITIVE_SCOPE

DEFAULT_COGNITIVE_SCOPE: "https://cognitiveservices.azure.com/.default" = "https://cognitiveservices.azure.com/.default"

Const SDK_VERSION

SDK_VERSION: string = "3.0.0-beta.5"

Const createSpan

createSpan: any = createSpanFunction({namespace: "Microsoft.CognitiveServices",packagePrefix: "Azure.CognitiveServices.AnomalyDetector"})

Const logger

logger: any = createClientLogger("ai-anomaly-detector")

The @azure/logger configuration for this package.

Const packageName

packageName: "@azure/ai-form-recognizer" = "@azure/ai-form-recognizer"

Const packageVersion

packageVersion: "3.0.0-beta.5" = "3.0.0-beta.5"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Functions

createAnomalyDetectorAzureKeyCredentialPolicy

  • createAnomalyDetectorAzureKeyCredentialPolicy(credential: KeyCredential): RequestPolicyFactory
  • Create an HTTP pipeline policy to authenticate a request using an AzureKeyCredential for Azure Anomaly Detector

    Parameters

    • credential: KeyCredential

    Returns RequestPolicyFactory

Object literals

Const AlignPolicy

AlignPolicy: object

type

type: object

className

className: string = "AlignPolicy"

name

name: string = "Composite"

modelProperties

modelProperties: object

alignMode

alignMode: object

serializedName

serializedName: string = "alignMode"

type

type: object

allowedValues

allowedValues: string[] = ["Inner", "Outer"]

name

name: string = "Enum"

fillNAMethod

fillNAMethod: object

serializedName

serializedName: string = "fillNAMethod"

type

type: object

name

name: string = "String"

paddingValue

paddingValue: object

serializedName

serializedName: string = "paddingValue"

type

type: object

name

name: string = "Number"

Const AnomalyDetectorDeleteMultivariateModelExceptionHeaders

AnomalyDetectorDeleteMultivariateModelExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorDeleteMultivariateModelExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorDetectAnomalyExceptionHeaders

AnomalyDetectorDetectAnomalyExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorDetectAnomalyExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorDetectAnomalyHeaders

AnomalyDetectorDetectAnomalyHeaders: object

type

type: object

className

className: string = "AnomalyDetectorDetectAnomalyHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

Const AnomalyDetectorDetectChangePointExceptionHeaders

AnomalyDetectorDetectChangePointExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorDetectChangePointExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorDetectEntireSeriesExceptionHeaders

AnomalyDetectorDetectEntireSeriesExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorDetectEntireSeriesExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorDetectLastPointExceptionHeaders

AnomalyDetectorDetectLastPointExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorDetectLastPointExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorError

AnomalyDetectorError: object

type

type: object

className

className: string = "AnomalyDetectorError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const AnomalyDetectorExportModelExceptionHeaders

AnomalyDetectorExportModelExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorExportModelExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorGetDetectionResultExceptionHeaders

AnomalyDetectorGetDetectionResultExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorGetDetectionResultExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorGetMultivariateModelExceptionHeaders

AnomalyDetectorGetMultivariateModelExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorGetMultivariateModelExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorLastDetectAnomalyExceptionHeaders

AnomalyDetectorLastDetectAnomalyExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorLastDetectAnomalyExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorListMultivariateModelExceptionHeaders

AnomalyDetectorListMultivariateModelExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorListMultivariateModelExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorListMultivariateModelNextExceptionHeaders

AnomalyDetectorListMultivariateModelNextExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorListMultivariateModelNextExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorTrainMultivariateModelExceptionHeaders

AnomalyDetectorTrainMultivariateModelExceptionHeaders: object

type

type: object

className

className: string = "AnomalyDetectorTrainMultivariateModelExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AnomalyDetectorTrainMultivariateModelHeaders

AnomalyDetectorTrainMultivariateModelHeaders: object

type

type: object

className

className: string = "AnomalyDetectorTrainMultivariateModelHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

Const AnomalyInterpretation

AnomalyInterpretation: object

type

type: object

className

className: string = "AnomalyInterpretation"

name

name: string = "Composite"

modelProperties

modelProperties: object

contributionScore

contributionScore: object

serializedName

serializedName: string = "contributionScore"

type

type: object

name

name: string = "Number"

correlationChanges

correlationChanges: object

serializedName

serializedName: string = "correlationChanges"

type

type: object

className

className: string = "CorrelationChanges"

name

name: string = "Composite"

variable

variable: object

serializedName

serializedName: string = "variable"

type

type: object

name

name: string = "String"

Const AnomalyState

AnomalyState: object

type

type: object

className

className: string = "AnomalyState"

name

name: string = "Composite"

modelProperties

modelProperties: object

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

timestamp

timestamp: object

required

required: boolean = true

serializedName

serializedName: string = "timestamp"

type

type: object

name

name: string = "DateTime"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

className

className: string = "AnomalyValue"

name

name: string = "Composite"

Const AnomalyValue

AnomalyValue: object

type

type: object

className

className: string = "AnomalyValue"

name

name: string = "Composite"

modelProperties

modelProperties: object

interpretation

interpretation: object

serializedName

serializedName: string = "interpretation"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "AnomalyInterpretation"

name

name: string = "Composite"

isAnomaly

isAnomaly: object

required

required: boolean = true

serializedName

serializedName: string = "isAnomaly"

type

type: object

name

name: string = "Boolean"

score

score: object

required

required: boolean = true

serializedName

serializedName: string = "score"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 2

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

severity

severity: object

required

required: boolean = true

serializedName

serializedName: string = "severity"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

Const CorrelationChanges

CorrelationChanges: object

type

type: object

className

className: string = "CorrelationChanges"

name

name: string = "Composite"

modelProperties

modelProperties: object

changedValues

changedValues: object

serializedName

serializedName: string = "changedValues"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

changedVariables

changedVariables: object

serializedName

serializedName: string = "changedVariables"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const DetectChangePointRequest

DetectChangePointRequest: object

type

type: object

className

className: string = "DetectChangePointRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

customInterval

customInterval: object

serializedName

serializedName: string = "customInterval"

type

type: object

name

name: string = "Number"

granularity

granularity: object

required

required: boolean = true

serializedName

serializedName: string = "granularity"

type

type: object

allowedValues

allowedValues: string[] = ["yearly","monthly","weekly","daily","hourly","minutely","secondly","microsecond","none"]

name

name: string = "Enum"

period

period: object

serializedName

serializedName: string = "period"

type

type: object

name

name: string = "Number"

series

series: object

required

required: boolean = true

serializedName

serializedName: string = "series"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TimeSeriesPoint"

name

name: string = "Composite"

stableTrendWindow

stableTrendWindow: object

serializedName

serializedName: string = "stableTrendWindow"

type

type: object

name

name: string = "Number"

threshold

threshold: object

serializedName

serializedName: string = "threshold"

type

type: object

name

name: string = "Number"

Const DetectChangePointResponse

DetectChangePointResponse: object

type

type: object

className

className: string = "DetectChangePointResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidenceScores

confidenceScores: object

serializedName

serializedName: string = "confidenceScores"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

isChangePoint

isChangePoint: object

serializedName

serializedName: string = "isChangePoint"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Boolean"

period

period: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "period"

type

type: object

name

name: string = "Number"

Const DetectEntireResponse

DetectEntireResponse: object

type

type: object

className

className: string = "DetectEntireResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

expectedValues

expectedValues: object

required

required: boolean = true

serializedName

serializedName: string = "expectedValues"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

isAnomaly

isAnomaly: object

required

required: boolean = true

serializedName

serializedName: string = "isAnomaly"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Boolean"

isNegativeAnomaly

isNegativeAnomaly: object

required

required: boolean = true

serializedName

serializedName: string = "isNegativeAnomaly"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Boolean"

isPositiveAnomaly

isPositiveAnomaly: object

required

required: boolean = true

serializedName

serializedName: string = "isPositiveAnomaly"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Boolean"

lowerMargins

lowerMargins: object

required

required: boolean = true

serializedName

serializedName: string = "lowerMargins"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

period

period: object

required

required: boolean = true

serializedName

serializedName: string = "period"

type

type: object

name

name: string = "Number"

severity

severity: object

serializedName

serializedName: string = "severity"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

upperMargins

upperMargins: object

required

required: boolean = true

serializedName

serializedName: string = "upperMargins"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

Const DetectLastPointResponse

DetectLastPointResponse: object

type

type: object

className

className: string = "DetectLastPointResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

expectedValue

expectedValue: object

required

required: boolean = true

serializedName

serializedName: string = "expectedValue"

type

type: object

name

name: string = "Number"

isAnomaly

isAnomaly: object

required

required: boolean = true

serializedName

serializedName: string = "isAnomaly"

type

type: object

name

name: string = "Boolean"

isNegativeAnomaly

isNegativeAnomaly: object

required

required: boolean = true

serializedName

serializedName: string = "isNegativeAnomaly"

type

type: object

name

name: string = "Boolean"

isPositiveAnomaly

isPositiveAnomaly: object

required

required: boolean = true

serializedName

serializedName: string = "isPositiveAnomaly"

type

type: object

name

name: string = "Boolean"

lowerMargin

lowerMargin: object

required

required: boolean = true

serializedName

serializedName: string = "lowerMargin"

type

type: object

name

name: string = "Number"

period

period: object

required

required: boolean = true

serializedName

serializedName: string = "period"

type

type: object

name

name: string = "Number"

severity

severity: object

serializedName

serializedName: string = "severity"

type

type: object

name

name: string = "Number"

suggestedWindow

suggestedWindow: object

required

required: boolean = true

serializedName

serializedName: string = "suggestedWindow"

type

type: object

name

name: string = "Number"

upperMargin

upperMargin: object

required

required: boolean = true

serializedName

serializedName: string = "upperMargin"

type

type: object

name

name: string = "Number"

Const DetectRequest

DetectRequest: object

type

type: object

className

className: string = "DetectRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

customInterval

customInterval: object

serializedName

serializedName: string = "customInterval"

type

type: object

name

name: string = "Number"

granularity

granularity: object

serializedName

serializedName: string = "granularity"

type

type: object

allowedValues

allowedValues: string[] = ["yearly","monthly","weekly","daily","hourly","minutely","secondly","microsecond","none"]

name

name: string = "Enum"

imputeFixedValue

imputeFixedValue: object

serializedName

serializedName: string = "imputeFixedValue"

type

type: object

name

name: string = "Number"

imputeMode

imputeMode: object

serializedName

serializedName: string = "imputeMode"

type

type: object

name

name: string = "String"

maxAnomalyRatio

maxAnomalyRatio: object

serializedName

serializedName: string = "maxAnomalyRatio"

type

type: object

name

name: string = "Number"

period

period: object

serializedName

serializedName: string = "period"

type

type: object

name

name: string = "Number"

sensitivity

sensitivity: object

serializedName

serializedName: string = "sensitivity"

type

type: object

name

name: string = "Number"

series

series: object

required

required: boolean = true

serializedName

serializedName: string = "series"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TimeSeriesPoint"

name

name: string = "Composite"

Const DetectionRequest

DetectionRequest: object

type

type: object

className

className: string = "DetectionRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

required

required: boolean = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: string = "DateTime"

source

source: object

required

required: boolean = true

serializedName

serializedName: string = "source"

type

type: object

name

name: string = "String"

startTime

startTime: object

required

required: boolean = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: string = "DateTime"

Const DetectionResult

DetectionResult: object

type

type: object

className

className: string = "DetectionResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

resultId

resultId: object

required

required: boolean = true

serializedName

serializedName: string = "resultId"

type

type: object

name

name: string = "Uuid"

results

results: object

required

required: boolean = true

serializedName

serializedName: string = "results"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "AnomalyState"

name

name: string = "Composite"

summary

summary: object

serializedName

serializedName: string = "summary"

type

type: object

className

className: string = "DetectionResultSummary"

name

name: string = "Composite"

Const DetectionResultSummary

DetectionResultSummary: object

type

type: object

className

className: string = "DetectionResultSummary"

name

name: string = "Composite"

modelProperties

modelProperties: object

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

setupInfo

setupInfo: object

serializedName

serializedName: string = "setupInfo"

type

type: object

className

className: string = "DetectionRequest"

name

name: string = "Composite"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["CREATED", "RUNNING", "READY", "FAILED"]

name

name: string = "Enum"

variableStates

variableStates: object

serializedName

serializedName: string = "variableStates"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "VariableState"

name

name: string = "Composite"

Const DiagnosticsInfo

DiagnosticsInfo: object

type

type: object

className

className: string = "DiagnosticsInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

modelState

modelState: object

serializedName

serializedName: string = "modelState"

type

type: object

className

className: string = "ModelState"

name

name: string = "Composite"

variableStates

variableStates: object

serializedName

serializedName: string = "variableStates"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "VariableState"

name

name: string = "Composite"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const LastDetectionRequest

LastDetectionRequest: object

type

type: object

className

className: string = "LastDetectionRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

detectingPoints

detectingPoints: object

required

required: boolean = true

serializedName

serializedName: string = "detectingPoints"

type

type: object

name

name: string = "Number"

variables

variables: object

required

required: boolean = true

serializedName

serializedName: string = "variables"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "VariableValues"

name

name: string = "Composite"

Const LastDetectionResult

LastDetectionResult: object

type

type: object

className

className: string = "LastDetectionResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

results

results: object

serializedName

serializedName: string = "results"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "AnomalyState"

name

name: string = "Composite"

variableStates

variableStates: object

serializedName

serializedName: string = "variableStates"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "VariableState"

name

name: string = "Composite"

Const Model

Model: object

type

type: object

className

className: string = "Model"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdTime

createdTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdTime"

type

type: object

name

name: string = "DateTime"

lastUpdatedTime

lastUpdatedTime: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedTime"

type

type: object

name

name: string = "DateTime"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

name: string = "Uuid"

modelInfo

modelInfo: object

serializedName

serializedName: string = "modelInfo"

type

type: object

className

className: string = "ModelInfo"

name

name: string = "Composite"

Const ModelInfo

ModelInfo: object

type

type: object

className

className: string = "ModelInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

alignPolicy

alignPolicy: object

serializedName

serializedName: string = "alignPolicy"

type

type: object

className

className: string = "AlignPolicy"

name

name: string = "Composite"

diagnosticsInfo

diagnosticsInfo: object

serializedName

serializedName: string = "diagnosticsInfo"

type

type: object

className

className: string = "DiagnosticsInfo"

name

name: string = "Composite"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 24

type

type: object

name

name: string = "String"

endTime

endTime: object

required

required: boolean = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: string = "DateTime"

errors

errors: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

slidingWindow

slidingWindow: object

serializedName

serializedName: string = "slidingWindow"

type

type: object

name

name: string = "Number"

source

source: object

required

required: boolean = true

serializedName

serializedName: string = "source"

type

type: object

name

name: string = "String"

startTime

startTime: object

required

required: boolean = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: string = "DateTime"

status

status: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["CREATED", "RUNNING", "READY", "FAILED"]

name

name: string = "Enum"

Const ModelList

ModelList: object

type

type: object

className

className: string = "ModelList"

name

name: string = "Composite"

modelProperties

modelProperties: object

currentCount

currentCount: object

required

required: boolean = true

serializedName

serializedName: string = "currentCount"

type

type: object

name

name: string = "Number"

maxCount

maxCount: object

required

required: boolean = true

serializedName

serializedName: string = "maxCount"

type

type: object

name

name: string = "Number"

models

models: object

required

required: boolean = true

serializedName

serializedName: string = "models"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ModelSnapshot"

name

name: string = "Composite"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const ModelSnapshot

ModelSnapshot: object

type

type: object

className

className: string = "ModelSnapshot"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdTime

createdTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdTime"

type

type: object

name

name: string = "DateTime"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

lastUpdatedTime

lastUpdatedTime: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedTime"

type

type: object

name

name: string = "DateTime"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

name: string = "Uuid"

status

status: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["CREATED", "RUNNING", "READY", "FAILED"]

name

name: string = "Enum"

variablesCount

variablesCount: object

required

required: boolean = true

serializedName

serializedName: string = "variablesCount"

type

type: object

name

name: string = "Number"

Const ModelState

ModelState: object

type

type: object

className

className: string = "ModelState"

name

name: string = "Composite"

modelProperties

modelProperties: object

epochIds

epochIds: object

serializedName

serializedName: string = "epochIds"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

latenciesInSeconds

latenciesInSeconds: object

serializedName

serializedName: string = "latenciesInSeconds"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

trainLosses

trainLosses: object

serializedName

serializedName: string = "trainLosses"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

validationLosses

validationLosses: object

serializedName

serializedName: string = "validationLosses"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

Const TimeSeriesPoint

TimeSeriesPoint: object

type

type: object

className

className: string = "TimeSeriesPoint"

name

name: string = "Composite"

modelProperties

modelProperties: object

timestamp

timestamp: object

serializedName

serializedName: string = "timestamp"

type

type: object

name

name: string = "DateTime"

value

value: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Number"

Const VariableState

VariableState: object

type

type: object

className

className: string = "VariableState"

name

name: string = "Composite"

modelProperties

modelProperties: object

effectiveCount

effectiveCount: object

serializedName

serializedName: string = "effectiveCount"

type

type: object

name

name: string = "Number"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: string = "DateTime"

filledNARatio

filledNARatio: object

serializedName

serializedName: string = "filledNARatio"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: string = "DateTime"

variable

variable: object

serializedName

serializedName: string = "variable"

type

type: object

name

name: string = "String"

Const VariableValues

VariableValues: object

type

type: object

className

className: string = "VariableValues"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

timestamps

timestamps: object

required

required: boolean = true

serializedName

serializedName: string = "timestamps"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

values

values: object

required

required: boolean = true

serializedName

serializedName: string = "values"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const accept1

accept1: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/zip, application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

defaultValue

defaultValue: string = "v1.1-preview.1"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "ApiVersion"

type

type: object

name

name: string = "String"

Const body

body: object

mapper

mapper: any = DetectRequestMapper

parameterPath

parameterPath: string = "body"

Const body1

body1: object

mapper

mapper: any = DetectChangePointRequestMapper

parameterPath

parameterPath: string = "body"

Const body2

body2: object

mapper

mapper: any = ModelInfoMapper

parameterPath

parameterPath: string = "body"

Const body3

body3: object

mapper

mapper: any = DetectionRequestMapper

parameterPath

parameterPath: string = "body"

Const body4

body4: object

mapper

mapper: any = LastDetectionRequestMapper

parameterPath

parameterPath: string = "body"

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const deleteMultivariateModelOperationSpec

deleteMultivariateModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/multivariate/models/{modelId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.apiVersion,Parameters.modelId]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.AnomalyDetectorDeleteMultivariateModelExceptionHeaders

Const detectAnomalyOperationSpec

detectAnomalyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/multivariate/models/{modelId}/detect"

requestBody

requestBody: any = Parameters.body3

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.apiVersion,Parameters.modelId]

responses

responses: object

201

201: object

headersMapper

headersMapper: any = Mappers.AnomalyDetectorDetectAnomalyHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.AnomalyDetectorDetectAnomalyExceptionHeaders

Const detectChangePointOperationSpec

detectChangePointOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/timeseries/changepoint/detect"

requestBody

requestBody: any = Parameters.body1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.apiVersion]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DetectChangePointResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.AnomalyDetectorError

headersMapper

headersMapper: any = Mappers.AnomalyDetectorDetectChangePointExceptionHeaders

Const detectEntireSeriesOperationSpec

detectEntireSeriesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/timeseries/entire/detect"

requestBody

requestBody: any = Parameters.body

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.apiVersion]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DetectEntireResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.AnomalyDetectorError

headersMapper

headersMapper: any = Mappers.AnomalyDetectorDetectEntireSeriesExceptionHeaders

Const detectLastPointOperationSpec

detectLastPointOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/timeseries/last/detect"

requestBody

requestBody: any = Parameters.body

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.apiVersion]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DetectLastPointResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.AnomalyDetectorError

headersMapper

headersMapper: any = Mappers.AnomalyDetectorDetectLastPointExceptionHeaders

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "Endpoint"

type

type: object

name

name: string = "String"

Const exportModelOperationSpec

exportModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/multivariate/models/{modelId}/export"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.apiVersion,Parameters.modelId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: object

serializedName

serializedName: string = "parsedResponse"

type

type: object

name

name: string = "Stream"

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.AnomalyDetectorExportModelExceptionHeaders

Const getDetectionResultOperationSpec

getDetectionResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/multivariate/results/{resultId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.apiVersion,Parameters.resultId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DetectionResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.AnomalyDetectorGetDetectionResultExceptionHeaders

Const getMultivariateModelOperationSpec

getMultivariateModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/multivariate/models/{modelId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.apiVersion,Parameters.modelId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Model

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.AnomalyDetectorGetMultivariateModelExceptionHeaders

Const lastDetectAnomalyOperationSpec

lastDetectAnomalyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/multivariate/models/{modelId}/last/detect"

requestBody

requestBody: any = Parameters.body4

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.apiVersion,Parameters.modelId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LastDetectionResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.AnomalyDetectorLastDetectAnomalyExceptionHeaders

Const listMultivariateModelNextOperationSpec

listMultivariateModelNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.skip, Parameters.top]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.apiVersion,Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ModelList

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.AnomalyDetectorListMultivariateModelNextExceptionHeaders

Const listMultivariateModelOperationSpec

listMultivariateModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/multivariate/models"

queryParameters

queryParameters: any[] = [Parameters.skip, Parameters.top]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.apiVersion]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ModelList

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.AnomalyDetectorListMultivariateModelExceptionHeaders

Const modelId

modelId: object

parameterPath

parameterPath: string = "modelId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

name: string = "Uuid"

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const resultId

resultId: object

parameterPath

parameterPath: string = "resultId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "resultId"

type

type: object

name

name: string = "Uuid"

Const skip

skip: object

parameterPath

parameterPath: string[] = ["options", "skip"]

mapper

mapper: object

serializedName

serializedName: string = "$skip"

type

type: object

name

name: string = "Number"

Const top

top: object

parameterPath

parameterPath: string[] = ["options", "top"]

mapper

mapper: object

defaultValue

defaultValue: number = 5

serializedName

serializedName: string = "$top"

type

type: object

name

name: string = "Number"

Const trainMultivariateModelOperationSpec

trainMultivariateModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/multivariate/models"

requestBody

requestBody: any = Parameters.body2

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.apiVersion]

responses

responses: object

201

201: object

headersMapper

headersMapper: any = Mappers.AnomalyDetectorTrainMultivariateModelHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.AnomalyDetectorTrainMultivariateModelExceptionHeaders

Generated using TypeDoc