AnomalyDetectorClient class

Clientklasse für die Interaktion mit dem Azure Anomalieerkennung-Dienst.

Extends

Konstruktoren

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Erstellt eine instance von AnomalyDetectorClient.

Beispielverwendung:

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

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

Geerbte Eigenschaften

apiVersion
endpoint

Geerbte Methoden

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

Löscht ein vorhandenes multivariates Modell basierend auf der Modell-ID.

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

Übermittelt die Aufgabe zur Erkennung multivariater Anomalien mit der Modell-ID des trainierten Modells. Das Eingabeschema muss mit der Trainingsanforderung übereinstimmen. Dadurch wird die Anforderung asynchron ausgeführt und gibt eine Ergebnis-ID zur Abfrage des Erkennungsergebnisses zurück. Die Anfrage muss ein Quelllink sein, der auf einen extern zugänglichen Azure Storage-URI verweist (vorzugsweise auf einen Shared Access Signature-URI). Alle Zeitreihen, die zum Generieren des Modells verwendet werden, müssen in einer einzelnen Datei gezippt werden. Für jede Zeitreihe gibt die erste Spalte den Zeitstempel und die zweite Spalte den Wert an.

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

Bewerten der Änderungspunktbewertung jedes Reihenpunkts

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

Dieser Vorgang generiert ein Modell mit einer ganzen Reihe, wobei jeder Punkt mit demselben Modell erkannt wird. Bei dieser Methode werden Punkte vor und nach einem bestimmten Punkt verwendet, um zu ermitteln, ob es sich um eine Anomalie handelt. Die gesamte Erkennung kann dem Benutzer eine gesamt status der Zeitreihe geben.

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

Bei diesem Vorgang wird ein Modell generiert, indem die Punkte vor dem letzten Punkt verwendet werden. Hierbei werden nur zurückliegende Punkte genutzt, um zu ermitteln, ob der Zielpunkt eine Anomalie darstellt. Der neueste Punkterkennungsvorgang entspricht dem Szenario der Echtzeitüberwachung von Geschäftsmetriken.

exportModel(string, AnomalyDetectorExportModelOptionalParams)

Exportiert ein Modell für die Erkennung multivariater Anomalien basierend auf der Modell-ID.

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

Ruft das Ergebnis der Erkennung multivariater Anomalien basierend auf der von der DetectAnomalyAsync-API zurückgegebenen Ergebnis-ID ab.

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

Ruft ausführliche Informationen zum multivariaten Modell ab, einschließlich Trainingsstatus und der im Modell verwendeten Variablen.

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

Synchronisierte API für die Anomalieerkennung.

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

Listet die Modelle eines Abonnements auf.

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Senden Sie eine HTTP-Anforderung, die mit der angegebenen OperationSpec aufgefüllt wird.

sendRequest(RequestPrepareOptions | WebResourceLike)

Senden Sie die bereitgestellte httpRequest.

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

Erstellt und trainiert ein Modell für die Erkennung multivariater Anomalien. Die Anforderung muss einen Quellparameter zum Verweis auf einen extern zugänglichen Azure Storage-URI enthalten (vorzugsweise einen Shared Access Signature-URI). Alle Zeitreihen, die zum Generieren des Modells verwendet werden, müssen in einer einzelnen Datei gezippt werden. Jede Zeitreihe befindet sich in einer einzelnen CSV-Datei, bei der die erste Spalte den Zeitstempel und die zweite Spalte den Wert angibt.

Details zum Konstruktor

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Erstellt eine instance von AnomalyDetectorClient.

Beispielverwendung:

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)

Parameter

endpointUrl

string

URL zu einem Azure Anomalieerkennung-Dienstendpunkt

credential

TokenCredential | KeyCredential

Wird verwendet, um Anforderungen beim Dienst zu authentifizieren.

options
PipelineOptions

Wird zum Konfigurieren des Formularerkennung-Clients verwendet.

Geerbte Eigenschaftsdetails

apiVersion

apiVersion: string

Eigenschaftswert

string

Geerbt vonAnomalyDetector.apiVersion

endpoint

endpoint: string

Eigenschaftswert

string

Geerbt vonAnomalyDetector.endpoint

Details zur geerbten Methode

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

Löscht ein vorhandenes multivariates Modell basierend auf der Modell-ID.

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

Parameter

modelId

string

Modellbezeichner.

Gibt zurück

Promise<RestResponse>

Geerbt vonAnomalyDetector.deleteMultivariateModel

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

Übermittelt die Aufgabe zur Erkennung multivariater Anomalien mit der Modell-ID des trainierten Modells. Das Eingabeschema muss mit der Trainingsanforderung übereinstimmen. Dadurch wird die Anforderung asynchron ausgeführt und gibt eine Ergebnis-ID zur Abfrage des Erkennungsergebnisses zurück. Die Anfrage muss ein Quelllink sein, der auf einen extern zugänglichen Azure Storage-URI verweist (vorzugsweise auf einen Shared Access Signature-URI). Alle Zeitreihen, die zum Generieren des Modells verwendet werden, müssen in einer einzelnen Datei gezippt werden. Für jede Zeitreihe gibt die erste Spalte den Zeitstempel und die zweite Spalte den Wert an.

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

Parameter

modelId

string

Modellbezeichner.

body
DetectionRequest

Erkennen einer Anomalieanforderung

options
AnomalyDetectorDetectAnomalyOptionalParams

Die Optionsparameter.

Gibt zurück

Geerbt vonAnomalyDetector.detectAnomaly

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

Bewerten der Änderungspunktbewertung jedes Reihenpunkts

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

Parameter

body
DetectChangePointRequest

Zeitreihenpunkte und Granularität sind erforderlich. Erweiterte Modellparameter können bei Bedarf auch in der Anforderung festgelegt werden.

options
AnomalyDetectorDetectChangePointOptionalParams

Die Optionsparameter.

Gibt zurück

Geerbt vonAnomalyDetector.detectChangePoint

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

Dieser Vorgang generiert ein Modell mit einer ganzen Reihe, wobei jeder Punkt mit demselben Modell erkannt wird. Bei dieser Methode werden Punkte vor und nach einem bestimmten Punkt verwendet, um zu ermitteln, ob es sich um eine Anomalie handelt. Die gesamte Erkennung kann dem Benutzer eine gesamt status der Zeitreihe geben.

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

Parameter

body
DetectRequest

Zeitreihenpunkte und punkt bei Bedarf. Erweiterte Modellparameter können auch in der Anforderung festgelegt werden.

options
AnomalyDetectorDetectEntireSeriesOptionalParams

Die Optionsparameter.

Gibt zurück

Geerbt vonAnomalyDetector.detectEntireSeries

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

Bei diesem Vorgang wird ein Modell generiert, indem die Punkte vor dem letzten Punkt verwendet werden. Hierbei werden nur zurückliegende Punkte genutzt, um zu ermitteln, ob der Zielpunkt eine Anomalie darstellt. Der neueste Punkterkennungsvorgang entspricht dem Szenario der Echtzeitüberwachung von Geschäftsmetriken.

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

Parameter

body
DetectRequest

Zeitreihenpunkte und punkt bei Bedarf. Erweiterte Modellparameter können auch in der Anforderung festgelegt werden.

options
AnomalyDetectorDetectLastPointOptionalParams

Die Optionsparameter.

Gibt zurück

Geerbt vonAnomalyDetector.detectLastPoint

exportModel(string, AnomalyDetectorExportModelOptionalParams)

Exportiert ein Modell für die Erkennung multivariater Anomalien basierend auf der Modell-ID.

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

Parameter

modelId

string

Modellbezeichner.

options
AnomalyDetectorExportModelOptionalParams

Die Optionsparameter.

Gibt zurück

Geerbt vonAnomalyDetector.exportModel

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

Ruft das Ergebnis der Erkennung multivariater Anomalien basierend auf der von der DetectAnomalyAsync-API zurückgegebenen Ergebnis-ID ab.

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

Parameter

resultId

string

Ergebnisbezeichner.

options
AnomalyDetectorGetDetectionResultOptionalParams

Die Optionsparameter.

Gibt zurück

Geerbt vonAnomalyDetector.getDetectionResult

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

Ruft ausführliche Informationen zum multivariaten Modell ab, einschließlich Trainingsstatus und der im Modell verwendeten Variablen.

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

Parameter

modelId

string

Modellbezeichner.

Gibt zurück

Geerbt vonAnomalyDetector.getMultivariateModel

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

Synchronisierte API für die Anomalieerkennung.

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

Parameter

modelId

string

Modellbezeichner.

body
LastDetectionRequest

Anforderung für die letzte Erkennung.

options
AnomalyDetectorLastDetectAnomalyOptionalParams

Die Optionsparameter.

Gibt zurück

Geerbt vonAnomalyDetector.lastDetectAnomaly

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

Listet die Modelle eines Abonnements auf.

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

Parameter

Gibt zurück

Geerbt vonAnomalyDetector.listMultivariateModel

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Senden Sie eine HTTP-Anforderung, die mit der angegebenen OperationSpec aufgefüllt wird.

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

Parameter

operationArguments
OperationArguments

Die Argumente, aus denen die Vorlagenwerte der HTTP-Anforderung aufgefüllt werden.

operationSpec
OperationSpec

Die OperationSpec, die zum Auffüllen von httpRequest verwendet werden soll.

callback

ServiceCallback<any>

Der Rückruf, der aufgerufen werden soll, wenn die Antwort empfangen wird.

Gibt zurück

Promise<RestResponse>

Geerbt vonAnomalyDetector.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Senden Sie die bereitgestellte httpRequest.

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

Parameter

Gibt zurück

Geerbt vonAnomalyDetector.sendRequest

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

Erstellt und trainiert ein Modell für die Erkennung multivariater Anomalien. Die Anforderung muss einen Quellparameter zum Verweis auf einen extern zugänglichen Azure Storage-URI enthalten (vorzugsweise einen Shared Access Signature-URI). Alle Zeitreihen, die zum Generieren des Modells verwendet werden, müssen in einer einzelnen Datei gezippt werden. Jede Zeitreihe befindet sich in einer einzelnen CSV-Datei, bei der die erste Spalte den Zeitstempel und die zweite Spalte den Wert angibt.

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

Parameter

body
AnomalyDetectorClientModelInfo

Schulungsanforderung

Gibt zurück

Geerbt vonAnomalyDetector.trainMultivariateModel