AnomalyDetectorClient class

Paket:

@azure/ai-anomaly-detector

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

Extends

AnomalyDetector

Konstruktoren

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Erstellt eine Instanz 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öschen eines vorhandenen multivariaten Modells gemäß der modelId
detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)	Senden Sie eine multivariate Anomaly-Aufgabe mit dem trainierten Modell von modelId, das Eingabeschema sollte mit der Schulungsanfrage identisch sein. Daher wird die Anforderung asynchron abgeschlossen und gibt eine resultId zum Abfragen des Erkennungsergebnisses zurück. Die Anforderung sollte ein Quelllink sein, um einen extern zugänglichen Azure-Speicher-URI (vorzugsweise einen URI für freigegebenen Zugriff) anzugeben. Alle Zeitreihen, die zum Generieren des Modells verwendet werden, müssen in eine einzelne Datei gezippt werden. Jede Zeitreihe lautet wie folgt: Die erste Spalte ist Zeitstempel und die zweite Spalte ist Wert.
detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)	Bewertung des Änderungspunkts jedes Datenreihenpunkts
detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)	Dieser Vorgang generiert ein Modell mit einer ganzen Datenreihe, jeder Punkt wird mit demselben Modell erkannt. Bei dieser Methode werden Punkte vor und nach einem bestimmten Punkt verwendet, um zu bestimmen, ob es sich um eine Anomalie handelt. Die gesamte Erkennung kann dem Benutzer einen Gesamtstatus der Zeitreihe geben.
detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)	Mit diesem Vorgang wird ein Modell mit Punkten vor dem neuesten generiert. Bei dieser Methode werden nur historische Punkte verwendet, um zu bestimmen, ob der Zielpunkt eine Anomalie ist. Der neueste Punkterkennungsvorgang entspricht dem Szenario der Echtzeitüberwachung von Geschäftsmetriken.
exportModel(string, AnomalyDetectorExportModelOptionalParams)	Exportieren des multivariaten Anomalieerkennungsmodells basierend auf modelId
getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)	Abrufen von multivariatem Anomalieerkennungsergebnis basierend auf resultId, die von der DetectAnomalyAsync-API zurückgegeben wird
getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)	Erhalten Sie detaillierte Informationen zum multivariaten Modell, einschließlich des Schulungsstatus und der variablen, die im Modell verwendet werden.
lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)	Synchronisierte API zur Anomalieerkennung.
listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)	Auflisten von Modellen eines Abonnements
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Senden Sie eine HTTP-Anforderung, die mit der bereitgestellten OperationSpec aufgefüllt wird.
sendRequest(RequestPrepareOptions | WebResourceLike)	Senden Sie die bereitgestellte httpRequest.
trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)	Erstellen und Trainieren eines multivariaten Anomalieerkennungsmodells. Die Anforderung muss einen Quellparameter enthalten, um einen extern zugänglichen Azure-Speicher-URI (vorzugsweise einen URI für freigegebenen Zugriff) anzugeben. Alle Zeitreihen, die zum Generieren des Modells verwendet werden, müssen in eine einzelne Datei gezippt werden. Jede Zeitreihe befindet sich in einer einzelnen CSV-Datei, in der die erste Spalte zeitstempel ist und die zweite Spalte ein Wert ist.

Details zum Konstruktor

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Erstellt eine Instanz 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 Anomaly Detector-Dienstendpunkt

credential

TokenCredential | KeyCredential

Wird verwendet, um Anforderungen an den Dienst zu authentifizieren.

options

PipelineOptions

Wird verwendet, um den Formularerkennungsclient zu konfigurieren.

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öschen eines vorhandenen multivariaten Modells gemäß der modelId

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

Parameter

modelId

string

Modellbezeichner.

options

AnomalyDetectorDeleteMultivariateModelOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<RestResponse>

Geerbt vonAnomalyDetector.deleteMultivariateModel

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

Senden Sie eine multivariate Anomaly-Aufgabe mit dem trainierten Modell von modelId, das Eingabeschema sollte mit der Schulungsanfrage identisch sein. Daher wird die Anforderung asynchron abgeschlossen und gibt eine resultId zum Abfragen des Erkennungsergebnisses zurück. Die Anforderung sollte ein Quelllink sein, um einen extern zugänglichen Azure-Speicher-URI (vorzugsweise einen URI für freigegebenen Zugriff) anzugeben. Alle Zeitreihen, die zum Generieren des Modells verwendet werden, müssen in eine einzelne Datei gezippt werden. Jede Zeitreihe lautet wie folgt: Die erste Spalte ist Zeitstempel und die zweite Spalte ist Wert.

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

Parameter

modelId

string

Modellbezeichner.

body

DetectionRequest

Anomalieanforderung erkennen

options

AnomalyDetectorDetectAnomalyOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AnomalyDetectorDetectAnomalyResponse>

geerbt vonAnomalyDetector.detectAnomaly

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

Bewertung des Änderungspunkts jedes Datenreihenpunkts

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

Promise<AnomalyDetectorDetectChangePointResponse>

geerbt vonAnomalyDetector.detectChangePoint

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

Dieser Vorgang generiert ein Modell mit einer ganzen Datenreihe, jeder Punkt wird mit demselben Modell erkannt. Bei dieser Methode werden Punkte vor und nach einem bestimmten Punkt verwendet, um zu bestimmen, ob es sich um eine Anomalie handelt. Die gesamte Erkennung kann dem Benutzer einen Gesamtstatus 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

Promise<AnomalyDetectorDetectEntireSeriesResponse>

geerbt vonAnomalyDetector.detectEntireSeries

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

Mit diesem Vorgang wird ein Modell mit Punkten vor dem neuesten generiert. Bei dieser Methode werden nur historische Punkte verwendet, um zu bestimmen, ob der Zielpunkt eine Anomalie ist. 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

Promise<AnomalyDetectorDetectLastPointResponse>

geerbt vonAnomalyDetector.detectLastPoint

exportModel(string, AnomalyDetectorExportModelOptionalParams)

Exportieren des multivariaten Anomalieerkennungsmodells basierend auf modelId

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

Parameter

modelId

string

Modellbezeichner.

options

AnomalyDetectorExportModelOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AnomalyDetectorExportModelResponse>

geerbt vonAnomalyDetector.exportModel

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

Abrufen von multivariatem Anomalieerkennungsergebnis basierend auf resultId, die von der DetectAnomalyAsync-API zurückgegeben wird

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

Parameter

resultId

string

Ergebnisbezeichner.

options

AnomalyDetectorGetDetectionResultOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AnomalyDetectorGetDetectionResultResponse>

Geerbt vonAnomalyDetector.getDetectionResult

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

Erhalten Sie detaillierte Informationen zum multivariaten Modell, einschließlich des Schulungsstatus und der variablen, die im Modell verwendet werden.

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

Parameter

modelId

string

Modellbezeichner.

options

AnomalyDetectorGetMultivariateModelOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AnomalyDetectorGetMultivariateModelResponse>

Geerbt vonAnomalyDetector.getMultivariateModel

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

Synchronisierte API zur 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

Promise<AnomalyDetectorLastDetectAnomalyResponse>

geerbt vonAnomalyDetector.lastDetectAnomaly

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

Auflisten von Modellen eines Abonnements

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

Parameter

options

AnomalyDetectorListMultivariateModelOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<AnomalyDetectorClientModelSnapshot, AnomalyDetectorClientModelSnapshot[], PageSettings>

geerbt vonAnomalyDetector.listMultivariateModel

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

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

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

Parameter

operationArguments

OperationArguments

Die Argumente, aus denen die vorlagenbasierten Werte der HTTP-Anforderung ausgefüllt werden.

operationSpec

OperationSpec

Die OperationSpec, die zum Auffüllen der 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

options

RequestPrepareOptions | WebResourceLike

Gibt zurück

Promise<HttpOperationResponse>

geerbt vonAnomalyDetector.sendRequest

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

Erstellen und Trainieren eines multivariaten Anomalieerkennungsmodells. Die Anforderung muss einen Quellparameter enthalten, um einen extern zugänglichen Azure-Speicher-URI (vorzugsweise einen URI für freigegebenen Zugriff) anzugeben. Alle Zeitreihen, die zum Generieren des Modells verwendet werden, müssen in eine einzelne Datei gezippt werden. Jede Zeitreihe befindet sich in einer einzelnen CSV-Datei, in der die erste Spalte zeitstempel ist und die zweite Spalte ein Wert ist.

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

Parameter

body

AnomalyDetectorClientModelInfo

Schulungsanfrage

options

AnomalyDetectorTrainMultivariateModelOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AnomalyDetectorTrainMultivariateModelResponse>

Geerbt vonAnomalyDetector.trainMultivariateModel