AnomalyDetectorClient class

パッケージ:

@azure/ai-anomaly-detector

Azure Anomaly Detector サービスと対話するためのクライアント クラス。

Extends

AnomalyDetector

コンストラクター

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 (できれば Shared Access Signature Uri) を示すソース リンクである必要があります。 モデルの生成に使用されるすべての時系列は、1 つのファイルに圧縮する必要があります。 各時系列は次のようになります。最初の列はタイムスタンプ、2 番目の列は値です。
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 (できれば Shared Access Signature Uri) を示すソース パラメーターが含まれている必要があります。 モデルの生成に使用されるすべての時系列は、1 つのファイルに圧縮する必要があります。 各時系列は、最初の列がタイムスタンプで、2 番目の列が値である単一の 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 Anomaly Detector サービス エンドポイントの URL

credential

TokenCredential | KeyCredential

サービスへの要求を認証するために使用されます。

options

PipelineOptions

Form Recognizer クライアントを構成するために使用します。

継承されたプロパティの詳細

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

モデル識別子。

options

AnomalyDetectorDeleteMultivariateModelOptionalParams

オプション パラメーター。

戻り値

Promise<RestResponse>

anomalyDetector.deleteMultivariateModel から継承

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

modelId のトレーニング済みモデルを使用して検出多変量異常タスクを送信します。入力スキーマはトレーニング要求と同じである必要があります。 したがって、要求は非同期的に完了し、検出結果を照会するための resultId を返します。要求は、外部からアクセス可能な Azure ストレージ URI (できれば Shared Access Signature Uri) を示すソース リンクである必要があります。 モデルの生成に使用されるすべての時系列は、1 つのファイルに圧縮する必要があります。 各時系列は次のようになります。最初の列はタイムスタンプ、2 番目の列は値です。

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

パラメーター

modelId

string

モデル識別子。

body

DetectionRequest

異常要求を検出する

options

AnomalyDetectorDetectAnomalyOptionalParams

オプション パラメーター。

戻り値

Promise<AnomalyDetectorDetectAnomalyResponse>

AnomalyDetector.detectAnomaly から継承された

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

すべての系列ポイントの変更ポイント スコアを評価する

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

パラメーター

body

DetectChangePointRequest

時系列のポイントと細分性が必要です。 必要に応じて、要求で高度なモデル パラメーターを設定することもできます。

options

AnomalyDetectorDetectChangePointOptionalParams

オプション パラメーター。

戻り値

Promise<AnomalyDetectorDetectChangePointResponse>

AnomalyDetector.detectChangePoint から継承された

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

この操作では、系列全体を含むモデルが生成され、各ポイントは同じモデルで検出されます。 この方法では、特定のポイントの前後のポイントを使用して、異常であるかどうかを判断します。 検出全体によって、ユーザーは時系列の全体的な状態を得ることができます。

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

パラメーター

body

DetectRequest

必要に応じて、時系列のポイントと期間。 要求で高度なモデル パラメーターを設定することもできます。

options

AnomalyDetectorDetectEntireSeriesOptionalParams

オプション パラメーター。

戻り値

Promise<AnomalyDetectorDetectEntireSeriesResponse>

AnomalyDetector.detectEntireSeries から継承された

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

この操作により、最新のポイントより前のポイントを使用してモデルが生成されます。 この方法では、ターゲット ポイントが異常であるかどうかを判断するために、履歴ポイントのみが使用されます。 最新のポイント検出操作は、ビジネス メトリックのリアルタイム監視のシナリオと一致します。

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

パラメーター

body

DetectRequest

必要に応じて、時系列のポイントと期間。 要求で高度なモデル パラメーターを設定することもできます。

options

AnomalyDetectorDetectLastPointOptionalParams

オプション パラメーター。

戻り値

Promise<AnomalyDetectorDetectLastPointResponse>

AnomalyDetector.detectLastPoint から継承された

exportModel(string, AnomalyDetectorExportModelOptionalParams)

modelId に基づいて多変量異常検出モデルをエクスポートする

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

パラメーター

modelId

string

モデル識別子。

options

AnomalyDetectorExportModelOptionalParams

オプション パラメーター。

戻り値

Promise<AnomalyDetectorExportModelResponse>

AnomalyDetector.exportModel から継承された

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

DetectAnomalyAsync api によって返される resultId に基づいて多変量異常検出結果を取得する

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

パラメーター

resultId

string

結果識別子。

options

AnomalyDetectorGetDetectionResultOptionalParams

オプション パラメーター。

戻り値

Promise<AnomalyDetectorGetDetectionResultResponse>

AnomalyDetector.getDetectionResult から継承された

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

モデルで使用されるトレーニングの状態や変数など、多変量モデルの詳細情報を取得します。

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

パラメーター

modelId

string

モデル識別子。

options

AnomalyDetectorGetMultivariateModelOptionalParams

オプション パラメーター。

戻り値

Promise<AnomalyDetectorGetMultivariateModelResponse>

AnomalyDetector.getMultivariateModel から継承された

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

異常検出用の同期された API。

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

パラメーター

modelId

string

モデル識別子。

body

LastDetectionRequest

最後の検出を要求します。

options

AnomalyDetectorLastDetectAnomalyOptionalParams

オプション パラメーター。

戻り値

Promise<AnomalyDetectorLastDetectAnomalyResponse>

AnomalyDetector.lastDetectAnomaly から継承された

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

サブスクリプションのモデルを一覧表示する

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

パラメーター

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>

パラメーター

options

RequestPrepareOptions | WebResourceLike

戻り値

Promise<HttpOperationResponse>

AnomalyDetector.sendRequest から継承された

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

多変量異常検出モデルを作成してトレーニングします。 要求には、外部からアクセス可能な Azure ストレージ URI (できれば Shared Access Signature Uri) を示すソース パラメーターが含まれている必要があります。 モデルの生成に使用されるすべての時系列は、1 つのファイルに圧縮する必要があります。 各時系列は、最初の列がタイムスタンプで、2 番目の列が値である単一の CSV ファイルに含まれます。

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

パラメーター

body

AnomalyDetectorClientModelInfo

トレーニング要求

options

AnomalyDetectorTrainMultivariateModelOptionalParams

オプション パラメーター。

戻り値

Promise<AnomalyDetectorTrainMultivariateModelResponse>

AnomalyDetector.trainMultivariateModelから継承