Partager via


AnomalyDetectorClient class

Classe cliente pour interagir avec le service Azure Détecteur d'anomalies.

Extends

Constructeurs

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Crée un instance d’AnomalieDetectorClient.

Exemple d’utilisation :

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

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

Propriétés héritées

apiVersion
endpoint

Méthodes héritées

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

Supprimer un modèle multivarié existant en fonction de l’ID de modèle

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

Soumettre la détection de la tâche d’anomalie multivariée avec le modèle formé d’ID de modèle. Le schéma d’entrée doit être identique à la demande d’apprentissage. Ainsi, la requête se terminera de façon asynchrone et renverra un ID de résultat pour interroger le résultat de la détection. La requête doit être un lien source pour indiquer un URI de stockage Azure accessible en externe (de préférence un URI de signature d’accès partagé). Toutes les séries chronologiques utilisées dans la génération du modèle doivent être compressées dans un seul fichier. Chaque série chronologique se présente comme suit : la première colonne correspond au timestamp et la deuxième colonne à la valeur.

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

Évaluer le score de point de modification de chaque point de série

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

Cette opération génère un modèle avec une série entière, chaque point est détecté avec le même modèle. Avec cette méthode, les points avant et après un certain point sont utilisés pour déterminer s’il s’agit d’une anomalie. L’ensemble de la détection peut donner à l’utilisateur une status globale de la série chronologique.

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

Cette opération génère un modèle à l’aide de points avant le dernier point. Avec cette méthode, seuls les points historiques sont utilisés pour déterminer si le point cible est une anomalie. La dernière opération de détection de point correspond au scénario de surveillance en temps réel des métriques métier.

exportModel(string, AnomalyDetectorExportModelOptionalParams)

Exporter un modèle de détection d’anomalies multivarié basé sur un ID de modèle

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

Obtenir un résultat de détection d’anomalies multivarié basé sur l’ID de résultat renvoyé par l’API DetectAnomalyAsync

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

Obtenir des informations détaillées sur le modèle multivarié, incluant l’état d’apprentissage et les variables utilisées dans le modèle.

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

API synchronisée pour la détection d’anomalie.

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

Répertorier les modèles d’un abonnement

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envoyez une requête HTTP renseignée à l’aide de la spécification OperationSpec fournie.

sendRequest(RequestPrepareOptions | WebResourceLike)

Envoyez le httpRequest fourni.

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

Créer et effectuer l’apprentissage d’un modèle de détection d’anomalies multivarié La requête doit inclure un paramètre source pour indiquer un URI de stockage Azure accessible en externe (de préférence un URI de signature d’accès partagé). Toutes les séries chronologiques utilisées dans la génération du modèle doivent être compressées dans un seul fichier. Chaque série chronologique se trouve dans un seul fichier CSV au sein duquel la première colonne correspond au timestamp et la deuxième colonne à la valeur.

Détails du constructeur

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Crée un instance d’AnomalieDetectorClient.

Exemple d’utilisation :

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)

Paramètres

endpointUrl

string

URL d’un point de terminaison de service Azure Détecteur d'anomalies

credential

TokenCredential | KeyCredential

Utilisé pour authentifier les demandes adressées au service.

options
PipelineOptions

Permet de configurer le client Form Recognizer.

Détails de la propriété héritée

apiVersion

apiVersion: string

Valeur de propriété

string

Hérité deAnomalyDetector.apiVersion

endpoint

endpoint: string

Valeur de propriété

string

Hérité deAnomalyDetector.endpoint

Détails de la méthode héritée

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

Supprimer un modèle multivarié existant en fonction de l’ID de modèle

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

Paramètres

modelId

string

Identificateur de modèle.

options
AnomalyDetectorDeleteMultivariateModelOptionalParams

Paramètres d’options.

Retours

Promise<RestResponse>

Hérité deAnomalyDetector.deleteMultivariateModel

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

Soumettre la détection de la tâche d’anomalie multivariée avec le modèle formé d’ID de modèle. Le schéma d’entrée doit être identique à la demande d’apprentissage. Ainsi, la requête se terminera de façon asynchrone et renverra un ID de résultat pour interroger le résultat de la détection. La requête doit être un lien source pour indiquer un URI de stockage Azure accessible en externe (de préférence un URI de signature d’accès partagé). Toutes les séries chronologiques utilisées dans la génération du modèle doivent être compressées dans un seul fichier. Chaque série chronologique se présente comme suit : la première colonne correspond au timestamp et la deuxième colonne à la valeur.

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

Paramètres

modelId

string

Identificateur de modèle.

body
DetectionRequest

Détecter une requête d’anomalie

options
AnomalyDetectorDetectAnomalyOptionalParams

Paramètres d’options.

Retours

Héritéd’AnomalieDetector.detectAnomaly

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

Évaluer le score de point de modification de chaque point de série

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

Paramètres

body
DetectChangePointRequest

Des points de série chronologique et une granularité sont nécessaires. Les paramètres de modèle avancés peuvent également être définis dans la demande si nécessaire.

options
AnomalyDetectorDetectChangePointOptionalParams

Paramètres d’options.

Retours

Hérité deAnomalyDetector.detectChangePoint

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

Cette opération génère un modèle avec une série entière, chaque point est détecté avec le même modèle. Avec cette méthode, les points avant et après un certain point sont utilisés pour déterminer s’il s’agit d’une anomalie. L’ensemble de la détection peut donner à l’utilisateur une status globale de la série chronologique.

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

Paramètres

body
DetectRequest

Points de série chronologique et période si nécessaire. Les paramètres de modèle avancés peuvent également être définis dans la demande.

options
AnomalyDetectorDetectEntireSeriesOptionalParams

Paramètres d’options.

Retours

Héritée deAnomalyDetector.detectEntireSeries

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

Cette opération génère un modèle à l’aide de points avant le dernier point. Avec cette méthode, seuls les points historiques sont utilisés pour déterminer si le point cible est une anomalie. La dernière opération de détection de point correspond au scénario de surveillance en temps réel des métriques métier.

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

Paramètres

body
DetectRequest

Points de série chronologique et période si nécessaire. Les paramètres de modèle avancés peuvent également être définis dans la demande.

options
AnomalyDetectorDetectLastPointOptionalParams

Paramètres d’options.

Retours

Hérité deAnomalyDetector.detectLastPoint

exportModel(string, AnomalyDetectorExportModelOptionalParams)

Exporter un modèle de détection d’anomalies multivarié basé sur un ID de modèle

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

Paramètres

modelId

string

Identificateur de modèle.

options
AnomalyDetectorExportModelOptionalParams

Paramètres d’options.

Retours

Hérité deAnomalyDetector.exportModel

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

Obtenir un résultat de détection d’anomalies multivarié basé sur l’ID de résultat renvoyé par l’API DetectAnomalyAsync

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

Paramètres

resultId

string

Identificateur de résultat.

options
AnomalyDetectorGetDetectionResultOptionalParams

Paramètres d’options.

Retours

Hérité deAnomalyDetector.getDetectionResult

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

Obtenir des informations détaillées sur le modèle multivarié, incluant l’état d’apprentissage et les variables utilisées dans le modèle.

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

Paramètres

modelId

string

Identificateur de modèle.

options
AnomalyDetectorGetMultivariateModelOptionalParams

Paramètres d’options.

Retours

Hérité deAnomalyDetector.getMultivariateModel

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

API synchronisée pour la détection d’anomalie.

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

Paramètres

modelId

string

Identificateur de modèle.

body
LastDetectionRequest

Demande de dernière détection.

options
AnomalyDetectorLastDetectAnomalyOptionalParams

Paramètres d’options.

Retours

Hérité deAnomalyDetector.lastDetectAnomaly

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

Répertorier les modèles d’un abonnement

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

Paramètres

options
AnomalyDetectorListMultivariateModelOptionalParams

Paramètres d’options.

Retours

Hérité deAnomalyDetector.listMultivariateModel

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envoyez une requête HTTP renseignée à l’aide de la spécification OperationSpec fournie.

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

Paramètres

operationArguments
OperationArguments

Arguments à partir duquel les valeurs de modèle de la requête HTTP seront remplies.

operationSpec
OperationSpec

OperationSpec à utiliser pour remplir le httpRequest.

callback

ServiceCallback<any>

Rappel à appeler lorsque la réponse est reçue.

Retours

Promise<RestResponse>

Hérité deAnomalyDetector.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envoyez le httpRequest fourni.

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

Paramètres

Retours

Hérité deAnomalyDetector.sendRequest

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

Créer et effectuer l’apprentissage d’un modèle de détection d’anomalies multivarié La requête doit inclure un paramètre source pour indiquer un URI de stockage Azure accessible en externe (de préférence un URI de signature d’accès partagé). Toutes les séries chronologiques utilisées dans la génération du modèle doivent être compressées dans un seul fichier. Chaque série chronologique se trouve dans un seul fichier CSV au sein duquel la première colonne correspond au timestamp et la deuxième colonne à la valeur.

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

Paramètres

body
AnomalyDetectorClientModelInfo

Demande de formation

options
AnomalyDetectorTrainMultivariateModelOptionalParams

Paramètres d’options.

Retours

Hérité deAnomalyDetector.trainMultivariateModel