AnomalyDetectorClient class

Pacote:

@azure/ai-anomaly-detector

Classe cliente para interagir com o serviço detector de anomalias do Azure.

Extends

AnomalyDetector

Construtores

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Cria uma instância de AnomalyDetectorClient. Uso de exemplo: import { AnomalyDetectorClient, AzureKeyCredential } from "@azure/ai-anomaly-detector"; const client = new AnomalyDetectorClient( "<service endpoint>", new AzureKeyCredential("<api key>") );

Propriedades herdadas

apiVersion
endpoint

Métodos herdados

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)	Excluir um modelo multivariado existente de acordo com a modelId
detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)	Enviar a tarefa de anomalias multivariadas de detecção com o modelo treinado de modelId, o esquema de entrada deve ser o mesmo com a solicitação de treinamento. Portanto, a solicitação será concluída de forma assíncrona e retornará uma resultId para consultar o resultado da detecção. A solicitação deve ser um link de origem para indicar um Uri de armazenamento do Azure acessível externamente (preferencialmente um Uri de Assinatura de Acesso Compartilhado). Todas as séries temporais usadas na geração do modelo devem ser compactadas em um único arquivo. Cada série temporal será a seguinte: a primeira coluna é o carimbo de data/hora e a segunda coluna é o valor.
detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)	Avaliar a pontuação de ponto de alteração de cada ponto de série
detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)	Essa operação gera um modelo com uma série inteira, cada ponto é detectado com o mesmo modelo. Com esse método, pontos antes e depois de um determinado ponto são usados para determinar se é uma anomalia. Toda a detecção pode dar ao usuário um status geral da série temporal.
detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)	Essa operação gera um modelo usando pontos antes do mais recente. Com esse método, somente pontos históricos são usados para determinar se o ponto de destino é uma anomalia. A operação de detecção de ponto mais recente corresponde ao cenário de monitoramento em tempo real das métricas de negócios.
exportModel(string, AnomalyDetectorExportModelOptionalParams)	Exportar modelo de detecção de anomalias multivariadas com base em modelId
getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)	Obter o resultado da detecção de anomalias multivariadas com base em resultId retornado pela api DetectAnomalyAsync
getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)	Obtenha informações detalhadas do modelo multivariado, incluindo o status de treinamento e as variáveis usadas no modelo.
lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)	API sincronizada para detecção de anomalias.
listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)	Listar modelos de uma assinatura
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.
sendRequest(RequestPrepareOptions | WebResourceLike)	Envie o httpRequest fornecido.
trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)	Crie e treine um modelo de detecção de anomalias multivariadas. A solicitação deve incluir um parâmetro de origem para indicar um Uri de armazenamento do Azure acessível externamente (preferencialmente um Uri de Assinatura de Acesso Compartilhado). Todas as séries temporais usadas na geração do modelo devem ser compactadas em um único arquivo. Cada série temporal estará em um único arquivo CSV no qual a primeira coluna é carimbo de data/hora e a segunda coluna é o valor.

Detalhes do construtor

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Cria uma instância de AnomalyDetectorClient.

Uso de exemplo:

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

Url para um ponto de extremidade de serviço do Detector de Anomalias do Azure

credential

TokenCredential | KeyCredential

Usado para autenticar solicitações no serviço.

options

PipelineOptions

Usado para configurar o cliente do Reconhecimento de Formulários.

Detalhes das propriedades herdadas

apiVersion

apiVersion: string

Valor da propriedade

string

Herdado deAnomalyDetector.apiVersion

endpoint

endpoint: string

Valor da propriedade

string

herdado deanomalyDetector.endpoint

Detalhes do método herdado

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

Excluir um modelo multivariado existente de acordo com a modelId

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

Parâmetros

modelId

string

Identificador de modelo.

options

AnomalyDetectorDeleteMultivariateModelOptionalParams

Os parâmetros de opções.

Retornos

Promise<RestResponse>

Herdado deAnomalyDetector.deleteMultivariateModel

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

Enviar a tarefa de anomalias multivariadas de detecção com o modelo treinado de modelId, o esquema de entrada deve ser o mesmo com a solicitação de treinamento. Portanto, a solicitação será concluída de forma assíncrona e retornará uma resultId para consultar o resultado da detecção. A solicitação deve ser um link de origem para indicar um Uri de armazenamento do Azure acessível externamente (preferencialmente um Uri de Assinatura de Acesso Compartilhado). Todas as séries temporais usadas na geração do modelo devem ser compactadas em um único arquivo. Cada série temporal será a seguinte: a primeira coluna é o carimbo de data/hora e a segunda coluna é o valor.

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

Parâmetros

modelId

string

Identificador de modelo.

body

DetectionRequest

Detectar solicitação de anomalias

options

AnomalyDetectorDetectAnomalyOptionalParams

Os parâmetros de opções.

Retornos

Promise<AnomalyDetectorDetectAnomalyResponse>

Herdado deAnomalyDetector.detectAnomaly

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

Avaliar a pontuação de ponto de alteração de cada ponto de série

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

Parâmetros

body

DetectChangePointRequest

Pontos de série temporal e granularidade são necessários. Parâmetros de modelo avançados também podem ser definidos na solicitação, se necessário.

options

AnomalyDetectorDetectChangePointOptionalParams

Os parâmetros de opções.

Retornos

Promise<AnomalyDetectorDetectChangePointResponse>

Herdado deAnomalyDetector.detectChangePoint

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

Essa operação gera um modelo com uma série inteira, cada ponto é detectado com o mesmo modelo. Com esse método, pontos antes e depois de um determinado ponto são usados para determinar se é uma anomalia. Toda a detecção pode dar ao usuário um status geral da série temporal.

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

Parâmetros

body

DetectRequest

Pontos de série temporal e ponto, se necessário. Parâmetros de modelo avançados também podem ser definidos na solicitação.

options

AnomalyDetectorDetectEntireSeriesOptionalParams

Os parâmetros de opções.

Retornos

Promise<AnomalyDetectorDetectEntireSeriesResponse>

Herdado deAnomalyDetector.detectEntireSeries

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

Essa operação gera um modelo usando pontos antes do mais recente. Com esse método, somente pontos históricos são usados para determinar se o ponto de destino é uma anomalia. A operação de detecção de ponto mais recente corresponde ao cenário de monitoramento em tempo real das métricas de negócios.

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

Parâmetros

body

DetectRequest

Pontos de série temporal e ponto, se necessário. Parâmetros de modelo avançados também podem ser definidos na solicitação.

options

AnomalyDetectorDetectLastPointOptionalParams

Os parâmetros de opções.

Retornos

Promise<AnomalyDetectorDetectLastPointResponse>

Herdado deAnomalyDetector.detectLastPoint

exportModel(string, AnomalyDetectorExportModelOptionalParams)

Exportar modelo de detecção de anomalias multivariadas com base em modelId

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

Parâmetros

modelId

string

Identificador de modelo.

options

AnomalyDetectorExportModelOptionalParams

Os parâmetros de opções.

Retornos

Promise<AnomalyDetectorExportModelResponse>

Herdado deAnomalyDetector.exportModel

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

Obter o resultado da detecção de anomalias multivariadas com base em resultId retornado pela api DetectAnomalyAsync

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

Parâmetros

resultId

string

Identificador de resultado.

options

AnomalyDetectorGetDetectionResultOptionalParams

Os parâmetros de opções.

Retornos

Promise<AnomalyDetectorGetDetectionResultResponse>

Herdado deAnomalyDetector.getDetectionResult

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

Obtenha informações detalhadas do modelo multivariado, incluindo o status de treinamento e as variáveis usadas no modelo.

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

Parâmetros

modelId

string

Identificador de modelo.

options

AnomalyDetectorGetMultivariateModelOptionalParams

Os parâmetros de opções.

Retornos

Promise<AnomalyDetectorGetMultivariateModelResponse>

Herdado deAnomalyDetector.getMultivariateModel

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

API sincronizada para detecção de anomalias.

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

Parâmetros

modelId

string

Identificador de modelo.

body

LastDetectionRequest

Solicitação de última detecção.

options

AnomalyDetectorLastDetectAnomalyOptionalParams

Os parâmetros de opções.

Retornos

Promise<AnomalyDetectorLastDetectAnomalyResponse>

Herdado deAnomalyDetector.lastDetectAnomaly

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

Listar modelos de uma assinatura

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

Parâmetros

options

AnomalyDetectorListMultivariateModelOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<AnomalyDetectorClientModelSnapshot, AnomalyDetectorClientModelSnapshot[], PageSettings>

Herdado deAnomalyDetector.listMultivariateModel

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.

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

Parâmetros

operationArguments

OperationArguments

Os argumentos dos quais os valores de modelo da solicitação HTTP serão preenchidos.

operationSpec

OperationSpec

O OperationSpec a ser usado para preencher o httpRequest.

callback

ServiceCallback<any>

O retorno de chamada a ser chamado quando a resposta é recebida.

Retornos

Promise<RestResponse>

Herdado deAnomalyDetector.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envie o httpRequest fornecido.

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

Parâmetros

options

RequestPrepareOptions | WebResourceLike

Retornos

Promise<HttpOperationResponse>

Herdado deAnomalyDetector.sendRequest

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

Crie e treine um modelo de detecção de anomalias multivariadas. A solicitação deve incluir um parâmetro de origem para indicar um Uri de armazenamento do Azure acessível externamente (preferencialmente um Uri de Assinatura de Acesso Compartilhado). Todas as séries temporais usadas na geração do modelo devem ser compactadas em um único arquivo. Cada série temporal estará em um único arquivo CSV no qual a primeira coluna é carimbo de data/hora e a segunda coluna é o valor.

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

Parâmetros

body

AnomalyDetectorClientModelInfo

Solicitação de treinamento

options

AnomalyDetectorTrainMultivariateModelOptionalParams

Os parâmetros de opções.

Retornos

Promise<AnomalyDetectorTrainMultivariateModelResponse>

Herdado deAnomalyDetector.trainMultivariateModel