AnomalyDetectorClient class

Clase de cliente para interactuar con el servicio azure Anomaly Detector.

Extends

Constructores

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Crea una instancia de AnomalyDetectorClient.

Ejemplo de uso:

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

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

Propiedades heredadas

apiVersion
endpoint

Métodos heredados

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

Elimina un modelo de multivariante existente según modelId.

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

Envía la tarea de detección de anomalías de multivariante con el modelo entrenado de modelId; el esquema de entrada debe ser el mismo con la solicitud de entrenamiento. Por lo tanto, la solicitud se completará de manera asincrónica y devolverá un resultId para consultar el resultado de la detección. La solicitud debe ser un vínculo de origen para indicar un URI de Azure Storage al que se puede acceder externamente (preferiblemente un URI de firma de acceso compartido). Todas las series temporales usadas para generar el modelo deben comprimirse en un solo archivo. Cada serie temporal será como sigue: la primera columna es la marca de tiempo y la segunda columna es el valor.

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

Evaluación de la puntuación de punto de cambio de cada punto de serie

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

Esta operación genera un modelo con una serie completa, cada punto se detecta con el mismo modelo. Con este método, los puntos antes y después de un determinado punto se usan para determinar si se trata de una anomalía. Toda la detección puede proporcionar al usuario un estado general de la serie temporal.

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

Esta operación genera un modelo con puntos anteriores al último. Con este método, solo se usan puntos históricos para determinar si el punto de destino es una anomalía. La operación de detección de puntos más reciente coincide con el escenario de supervisión en tiempo real de las métricas empresariales.

exportModel(string, AnomalyDetectorExportModelOptionalParams)

Exporta un modelo de detección de anomalías de multivariante basado en modelId.

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

Obtiene el resultado de la detección de anomalías de multivariante en función del resultId devuelto por la API DetectAnomalyAsync.

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

Obtiene información detallada del modelo de multivariante, incluidos el estado de entrenamiento y las variables que se usan en el modelo.

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

API sincronizada para la detección de anomalías.

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

Enumera los modelos de una suscripción.

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.

sendRequest(RequestPrepareOptions | WebResourceLike)

Envíe el httpRequest proporcionado.

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

Crea y entrena un modelo de detección de anomalías de multivariante. La solicitud debe incluir un parámetro de origen para indicar un URI de Azure Storage al que se pueda acceder externamente (preferiblemente un URI de firma de acceso compartido). Todas las series temporales usadas para generar el modelo deben comprimirse en un solo archivo. Cada serie temporal estará en un único archivo .csv en el que la primera columna sea la marca de tiempo y la segunda columna sea el valor.

Detalles del constructor

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Crea una instancia de AnomalyDetectorClient.

Ejemplo de uso:

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)

Parámetros

endpointUrl

string

Dirección URL a un punto de conexión de servicio de Azure Anomaly Detector

credential

TokenCredential | KeyCredential

Se usa para autenticar las solicitudes en el servicio.

options
PipelineOptions

Se usa para configurar el cliente de Form Recognizer.

Detalles de las propiedades heredadas

apiVersion

apiVersion: string

Valor de propiedad

string

Heredado deAnomalyDetector.apiVersion

endpoint

endpoint: string

Valor de propiedad

string

Heredado deAnomalyDetector.endpoint

Detalles de los métodos heredados

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

Elimina un modelo de multivariante existente según modelId.

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

Parámetros

modelId

string

Identificador del modelo.

options
AnomalyDetectorDeleteMultivariateModelOptionalParams

Parámetros de opciones.

Devoluciones

Promise<RestResponse>

Heredado deAnomalyDetector.deleteMultivariateModel

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

Envía la tarea de detección de anomalías de multivariante con el modelo entrenado de modelId; el esquema de entrada debe ser el mismo con la solicitud de entrenamiento. Por lo tanto, la solicitud se completará de manera asincrónica y devolverá un resultId para consultar el resultado de la detección. La solicitud debe ser un vínculo de origen para indicar un URI de Azure Storage al que se puede acceder externamente (preferiblemente un URI de firma de acceso compartido). Todas las series temporales usadas para generar el modelo deben comprimirse en un solo archivo. Cada serie temporal será como sigue: la primera columna es la marca de tiempo y la segunda columna es el valor.

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

Parámetros

modelId

string

Identificador del modelo.

body
DetectionRequest

Detección de una solicitud de anomalías

options
AnomalyDetectorDetectAnomalyOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.detectAnomaly

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

Evaluación de la puntuación de punto de cambio de cada punto de serie

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

Parámetros

body
DetectChangePointRequest

Se necesitan puntos de serie temporal y granularidad. Los parámetros avanzados del modelo también se pueden establecer en la solicitud si es necesario.

options
AnomalyDetectorDetectChangePointOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.detectChangePoint

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

Esta operación genera un modelo con una serie completa, cada punto se detecta con el mismo modelo. Con este método, los puntos antes y después de un determinado punto se usan para determinar si se trata de una anomalía. Toda la detección puede proporcionar al usuario un estado general de la serie temporal.

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

Parámetros

body
DetectRequest

Puntos de serie temporal y período si es necesario. Los parámetros avanzados del modelo también se pueden establecer en la solicitud.

options
AnomalyDetectorDetectEntireSeriesOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.detectEntireSeries

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

Esta operación genera un modelo con puntos anteriores al último. Con este método, solo se usan puntos históricos para determinar si el punto de destino es una anomalía. La operación de detección de puntos más reciente coincide con el escenario de supervisión en tiempo real de las métricas empresariales.

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

Parámetros

body
DetectRequest

Puntos de serie temporal y período si es necesario. Los parámetros avanzados del modelo también se pueden establecer en la solicitud.

options
AnomalyDetectorDetectLastPointOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.detectLastPoint

exportModel(string, AnomalyDetectorExportModelOptionalParams)

Exporta un modelo de detección de anomalías de multivariante basado en modelId.

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

Parámetros

modelId

string

Identificador del modelo.

options
AnomalyDetectorExportModelOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.exportModel

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

Obtiene el resultado de la detección de anomalías de multivariante en función del resultId devuelto por la API DetectAnomalyAsync.

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

Parámetros

resultId

string

Identificador de resultado.

options
AnomalyDetectorGetDetectionResultOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.getDetectionResult

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

Obtiene información detallada del modelo de multivariante, incluidos el estado de entrenamiento y las variables que se usan en el modelo.

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

Parámetros

modelId

string

Identificador del modelo.

options
AnomalyDetectorGetMultivariateModelOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.getMultivariateModel

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

API sincronizada para la detección de anomalías.

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

Parámetros

modelId

string

Identificador del modelo.

body
LastDetectionRequest

Solicitud de la última detección.

options
AnomalyDetectorLastDetectAnomalyOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.lastDetectAnomaly

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

Enumera los modelos de una suscripción.

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

Parámetros

options
AnomalyDetectorListMultivariateModelOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.listMultivariateModel

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.

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

Parámetros

operationArguments
OperationArguments

Argumentos de los que se rellenarán los valores con plantilla de la solicitud HTTP.

operationSpec
OperationSpec

OperationSpec que se va a usar para rellenar httpRequest.

callback

ServiceCallback<any>

Devolución de llamada que se va a llamar cuando se recibe la respuesta.

Devoluciones

Promise<RestResponse>

Heredado deAnomalyDetector.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envíe el httpRequest proporcionado.

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

Parámetros

Devoluciones

Heredado deAnomalyDetector.sendRequest

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

Crea y entrena un modelo de detección de anomalías de multivariante. La solicitud debe incluir un parámetro de origen para indicar un URI de Azure Storage al que se pueda acceder externamente (preferiblemente un URI de firma de acceso compartido). Todas las series temporales usadas para generar el modelo deben comprimirse en un solo archivo. Cada serie temporal estará en un único archivo .csv en el que la primera columna sea la marca de tiempo y la segunda columna sea el valor.

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

Parámetros

body
AnomalyDetectorClientModelInfo

Solicitud de entrenamiento

options
AnomalyDetectorTrainMultivariateModelOptionalParams

Parámetros de opciones.

Devoluciones

Heredado deAnomalyDetector.trainMultivariateModel