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

AnomalyDetectorErrorCodes

AnomalyDetectorErrorCodes: "InvalidCustomInterval" | "BadArgument" | "InvalidGranularity" | "InvalidPeriod" | "InvalidModelArgument" | "InvalidSeries" | "InvalidJsonFormat" | "RequiredGranularity" | "RequiredSeries" | string

Defines values for AnomalyDetectorErrorCodes.

GeneratedClientDetectChangePointResponse

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

Contains response data for the detectChangePoint operation.

GeneratedClientDetectEntireSeriesResponse

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

Contains response data for the detectEntireSeries operation.

GeneratedClientDetectLastPointResponse

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

Contains response data for the detectLastPoint operation.

Variables

Const API_KEY_HEADER_NAME

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

Const AnomalyDetectorLoggingAllowedHeaderNames

AnomalyDetectorLoggingAllowedHeaderNames: Object = ["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: Object = ["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-preview.2"

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.2" = "3.0.0-beta.2"

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 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 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: Object = ["yearly","monthly","weekly","daily","hourly","minutely","secondly"]

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

required

required: boolean = true

serializedName

serializedName: string = "confidenceScores"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

isChangePoint

isChangePoint: object

required

required: boolean = true

serializedName

serializedName: string = "isChangePoint"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Boolean"

period

period: object

required

required: 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"

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"

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

required

required: boolean = true

serializedName

serializedName: string = "granularity"

type

type: object

allowedValues

allowedValues: Object = ["yearly","monthly","weekly","daily","hourly","minutely","secondly"]

name

name: string = "Enum"

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 TimeSeriesPoint

TimeSeriesPoint: object

type

type: object

className

className: string = "TimeSeriesPoint"

name

name: string = "Composite"

modelProperties

modelProperties: object

timestamp

timestamp: object

required

required: boolean = true

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 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 body

body: object

mapper

mapper: any = DetectRequestMapper

parameterPath

parameterPath: string = "body"

Const body1

body1: object

mapper

mapper: any = DetectChangePointRequestMapper

parameterPath

parameterPath: string = "body"

Const contentType

contentType: object

parameterPath

parameterPath: Object = ["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 detectChangePointOperationSpec

detectChangePointOperationSpec: object

headerParameters

headerParameters: Object = [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: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DetectChangePointResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.AnomalyDetectorError

Const detectEntireSeriesOperationSpec

detectEntireSeriesOperationSpec: object

headerParameters

headerParameters: Object = [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: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DetectEntireResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.AnomalyDetectorError

Const detectLastPointOperationSpec

detectLastPointOperationSpec: object

headerParameters

headerParameters: Object = [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: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DetectLastPointResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.AnomalyDetectorError

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"

Generated using TypeDoc