你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

AnomalyDetectorClient class

用于与 Azure 异常检测器服务交互的客户端类。

扩展

构造函数

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

创建 AnomalyDetectorClient 的实例。

示例用法:

import { AnomalyDetectorClient, AzureKeyCredential } from "@azure/ai-anomaly-detector";

const client = new AnomalyDetectorClient(
   "<service endpoint>",
   new AzureKeyCredential("<api key>")
);

继承属性

apiVersion
endpoint

继承的方法

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

根据 modelId 删除现有多变量模型

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

使用 modelId 的训练模型提交检测多变量异常任务,输入架构应与训练请求相同。 因此,请求将以异步方式完成,并返回用于查询检测结果的 resultId。请求应该是一个源链接,用于指示外部可访问的 Azure 存储 URI(最好是共享访问签名 URI)。 生成模型时所用的所有时序都必须压缩到一个文件中。 每个时序将如下所示:第一列是时间戳,第二列是值。

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

评估每个系列点的更改点分数

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

此操作生成一个包含整个序列的模型,每个点都用同一模型检测到。 使用此方法时,使用某个点前后的点来确定它是否为异常。 整个检测可以为用户提供时序的总体状态。

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

此操作在最新点之前使用点生成模型。 使用此方法时,仅使用历史点来确定目标点是否为异常。 最新检测操作与实时监视业务指标的方案匹配。

exportModel(string, AnomalyDetectorExportModelOptionalParams)

基于 modelId 导出多变量异常情况检测模型

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

基于 DetectAnomalyAsync api 返回的 resultId 获取多变量异常检测结果

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

获取多变量模型的详细信息,包括模型中使用的训练状态和变量。

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

用于异常情况检测的同步 API。

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

列出订阅的模型

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

发送使用提供的 OperationSpec 填充的 HTTP 请求。

sendRequest(RequestPrepareOptions | WebResourceLike)

发送提供的 httpRequest。

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

创建和训练多变量异常情况检测模型。 请求必须包含源参数,以指示外部可访问的 Azure 存储 URI(最好是共享访问签名 URI)。 生成模型时所用的所有时序都必须压缩到一个文件中。 每个时序将位于一个 CSV 文件中,其中第一列是时间戳,第二列是值。

构造函数详细信息

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

创建 AnomalyDetectorClient 的实例。

示例用法:

import { AnomalyDetectorClient, AzureKeyCredential } from "@azure/ai-anomaly-detector";

const client = new AnomalyDetectorClient(
   "<service endpoint>",
   new AzureKeyCredential("<api key>")
);
new AnomalyDetectorClient(endpointUrl: string, credential: TokenCredential | KeyCredential, options?: PipelineOptions)

参数

endpointUrl

string

指向 Azure 异常检测器服务终结点的 URL

credential

TokenCredential | KeyCredential

用于对服务的请求进行身份验证。

options
PipelineOptions

用于配置表单识别器客户端。

继承属性详细信息

apiVersion

apiVersion: string

属性值

string

继承自AnomalyDetector.apiVersion

endpoint

endpoint: string

属性值

string

继承自AnomalyDetector.endpoint

继承的方法详细信息

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

根据 modelId 删除现有多变量模型

function deleteMultivariateModel(modelId: string, options?: AnomalyDetectorDeleteMultivariateModelOptionalParams): Promise<RestResponse>

参数

modelId

string

模型标识符。

返回

Promise<RestResponse>

继承自AnomalyDetector.deleteMultivariateModel

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

使用 modelId 的训练模型提交检测多变量异常任务,输入架构应与训练请求相同。 因此,请求将以异步方式完成,并返回用于查询检测结果的 resultId。请求应该是一个源链接,用于指示外部可访问的 Azure 存储 URI(最好是共享访问签名 URI)。 生成模型时所用的所有时序都必须压缩到一个文件中。 每个时序将如下所示:第一列是时间戳,第二列是值。

function detectAnomaly(modelId: string, body: DetectionRequest, options?: AnomalyDetectorDetectAnomalyOptionalParams): Promise<AnomalyDetectorDetectAnomalyResponse>

参数

modelId

string

模型标识符。

body
DetectionRequest

检测异常请求

返回

继承自AnomalyDetector.detectAnomaly

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

评估每个系列点的更改点分数

function detectChangePoint(body: DetectChangePointRequest, options?: AnomalyDetectorDetectChangePointOptionalParams): Promise<AnomalyDetectorDetectChangePointResponse>

参数

body
DetectChangePointRequest

需要时序点和粒度。 如果需要,还可以在请求中设置高级模型参数。

返回

继承自AnomalyDetector.detectChangePoint

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

此操作生成一个包含整个序列的模型,每个点都用同一模型检测到。 使用此方法时,使用某个点前后的点来确定它是否为异常。 整个检测可以为用户提供时序的总体状态。

function detectEntireSeries(body: DetectRequest, options?: AnomalyDetectorDetectEntireSeriesOptionalParams): Promise<AnomalyDetectorDetectEntireSeriesResponse>

参数

body
DetectRequest

如果需要,时序点和时间段。 还可以在请求中设置高级模型参数。

返回

继承自AnomalyDetector.detectEntireSeries

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

此操作在最新点之前使用点生成模型。 使用此方法时,仅使用历史点来确定目标点是否为异常。 最新检测操作与实时监视业务指标的方案匹配。

function detectLastPoint(body: DetectRequest, options?: AnomalyDetectorDetectLastPointOptionalParams): Promise<AnomalyDetectorDetectLastPointResponse>

参数

body
DetectRequest

如果需要,时序点和时间段。 还可以在请求中设置高级模型参数。

返回

继承自AnomalyDetector.detectLastPoint

exportModel(string, AnomalyDetectorExportModelOptionalParams)

基于 modelId 导出多变量异常情况检测模型

function exportModel(modelId: string, options?: AnomalyDetectorExportModelOptionalParams): Promise<AnomalyDetectorExportModelResponse>

参数

modelId

string

模型标识符。

返回

继承自AnomalyDetector.exportModel

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

基于 DetectAnomalyAsync api 返回的 resultId 获取多变量异常检测结果

function getDetectionResult(resultId: string, options?: AnomalyDetectorGetDetectionResultOptionalParams): Promise<AnomalyDetectorGetDetectionResultResponse>

参数

resultId

string

结果标识符。

返回

继承自AnomalyDetector.getDetectionResult

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

获取多变量模型的详细信息,包括模型中使用的训练状态和变量。

function getMultivariateModel(modelId: string, options?: AnomalyDetectorGetMultivariateModelOptionalParams): Promise<AnomalyDetectorGetMultivariateModelResponse>

参数

modelId

string

模型标识符。

返回

继承自AnomalyDetector.getMultivariateModel

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

用于异常情况检测的同步 API。

function lastDetectAnomaly(modelId: string, body: LastDetectionRequest, options?: AnomalyDetectorLastDetectAnomalyOptionalParams): Promise<AnomalyDetectorLastDetectAnomalyResponse>

参数

modelId

string

模型标识符。

body
LastDetectionRequest

请求上次检测。

返回

继承自AnomalyDetector.lastDetectAnomaly

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

列出订阅的模型

function listMultivariateModel(options?: AnomalyDetectorListMultivariateModelOptionalParams): PagedAsyncIterableIterator<AnomalyDetectorClientModelSnapshot, AnomalyDetectorClientModelSnapshot[], PageSettings>

参数

返回

继承自AnomalyDetector.listMultivariateModel

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

发送使用提供的 OperationSpec 填充的 HTTP 请求。

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

参数

operationArguments
OperationArguments

将从中填充 HTTP 请求的模板化值的参数。

operationSpec
OperationSpec

用于填充 httpRequest 的 OperationSpec。

callback

ServiceCallback<any>

收到响应时要调用的回调。

返回

Promise<RestResponse>

继承自AnomalyDetector.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

发送提供的 httpRequest。

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

参数

返回

继承自AnomalyDetector.sendRequest

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

创建和训练多变量异常情况检测模型。 请求必须包含源参数,以指示外部可访问的 Azure 存储 URI(最好是共享访问签名 URI)。 生成模型时所用的所有时序都必须压缩到一个文件中。 每个时序将位于一个 CSV 文件中,其中第一列是时间戳,第二列是值。

function trainMultivariateModel(body: AnomalyDetectorClientModelInfo, options?: AnomalyDetectorTrainMultivariateModelOptionalParams): Promise<AnomalyDetectorTrainMultivariateModelResponse>

参数

body
AnomalyDetectorClientModelInfo

培训请求

返回

继承自AnomalyDetector.trainMultivariateModel