AnomalyDetectorClient class

Pakiet:

@azure/ai-anomaly-detector

Klasa klienta do interakcji z usługą Narzędzia do wykrywania anomalii platformy Azure.

Rozszerzenie

AnomalyDetector

Konstruktory

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Tworzy wystąpienie klasy AnomalyDetectorClient. Przykładowe użycie: import { AnomalyDetectorClient, AzureKeyCredential } from "@azure/ai-anomaly-detector"; const client = new AnomalyDetectorClient( "<service endpoint>", new AzureKeyCredential("<api key>") );

Właściwości dziedziczone

apiVersion
endpoint

Metody dziedziczone

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)	Usuń istniejący model wielowariancji zgodnie z identyfikatorem modelId
detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)	Prześlij wielowariancyjne zadanie wykrywania anomalii z wytrenowanym modelem modelId, schemat wejściowy powinien być taki sam jak w przypadku żądania trenowania. W związku z tym żądanie zostanie ukończone asynchronicznie i zwróci wynik resultId zapytania o wynik wykrywania. Żądanie powinno być linkiem źródłowym, aby wskazać zewnętrznie dostępny identyfikator URI usługi Azure Storage (najlepiej identyfikator URI sygnatury dostępu współdzielonego). Wszystkie szeregi czasowe używane w generowaniu modelu muszą być spakowane do jednego pliku. Każda seria czasowa będzie następująca: pierwsza kolumna to sygnatura czasowa, a druga kolumna to wartość.
detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)	Ocena wyniku punktu zmiany dla każdego punktu serii
detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)	Ta operacja generuje model z całą serią. Każdy punkt jest wykrywany przy użyciu tego samego modelu. W przypadku tej metody punkty przed i po pewnym punkcie są używane do określenia, czy jest to anomalia. Całe wykrywanie może dać użytkownikowi ogólny stan szeregów czasowych.
detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)	Ta operacja generuje model przy użyciu punktów przed ostatnim. W przypadku tej metody tylko punkty historyczne są używane do określania, czy punkt docelowy jest anomalią. Najnowsza operacja wykrywania punktów jest zgodna ze scenariuszem monitorowania metryk biznesowych w czasie rzeczywistym.
exportModel(string, AnomalyDetectorExportModelOptionalParams)	Eksportowanie wielowariancyjnego modelu wykrywania anomalii na podstawie identyfikatora modelId
getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)	Uzyskiwanie wielowariancyjnego wyniku wykrywania anomalii na podstawie identyfikatora resultId zwróconego przez interfejs API DetectAnomalyAsync
getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)	Uzyskaj szczegółowe informacje o modelu wielowariancji, w tym stan trenowania i zmienne używane w modelu.
lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)	Zsynchronizowany interfejs API na potrzeby wykrywania anomalii.
listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)	Wyświetlanie listy modeli subskrypcji
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Wyślij podany element httpRequest.
trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)	Tworzenie i trenowanie wielowariancyjnego modelu wykrywania anomalii. Żądanie musi zawierać parametr źródłowy, aby wskazać identyfikator URI usługi Azure Storage dostępny zewnętrznie (najlepiej identyfikator URI sygnatury dostępu współdzielonego). Wszystkie szeregi czasowe używane w generowaniu modelu muszą być spakowane do jednego pliku. Każda seria czasowa będzie znajdować się w jednym pliku CSV, w którym pierwsza kolumna jest sygnaturą czasową, a druga kolumna to wartość.

Szczegóły konstruktora

AnomalyDetectorClient(string, TokenCredential | KeyCredential, PipelineOptions)

Tworzy wystąpienie klasy AnomalyDetectorClient.

Przykładowe użycie:

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)

Parametry

endpointUrl

string

Adres URL do punktu końcowego usługi Narzędzia do wykrywania anomalii platformy Azure

credential

TokenCredential | KeyCredential

Służy do uwierzytelniania żądań w usłudze.

options

PipelineOptions

Służy do konfigurowania klienta rozpoznawania formularzy.

Szczegóły właściwości dziedziczonej

apiVersion

apiVersion: string

Wartość właściwości

string

dziedziczone zAnomalyDetector.apiVersion

endpoint

endpoint: string

Wartość właściwości

string

dziedziczone zAnomalyDetector.endpoint

Szczegóły metody dziedziczonej

deleteMultivariateModel(string, AnomalyDetectorDeleteMultivariateModelOptionalParams)

Usuń istniejący model wielowariancji zgodnie z identyfikatorem modelId

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

Parametry

modelId

string

Identyfikator modelu.

options

AnomalyDetectorDeleteMultivariateModelOptionalParams

Parametry opcji.

Zwraca

Promise<RestResponse>

dziedziczone zAnomalyDetector.deleteMultivariateModel

detectAnomaly(string, DetectionRequest, AnomalyDetectorDetectAnomalyOptionalParams)

Prześlij wielowariancyjne zadanie wykrywania anomalii z wytrenowanym modelem modelId, schemat wejściowy powinien być taki sam jak w przypadku żądania trenowania. W związku z tym żądanie zostanie ukończone asynchronicznie i zwróci wynik resultId zapytania o wynik wykrywania. Żądanie powinno być linkiem źródłowym, aby wskazać zewnętrznie dostępny identyfikator URI usługi Azure Storage (najlepiej identyfikator URI sygnatury dostępu współdzielonego). Wszystkie szeregi czasowe używane w generowaniu modelu muszą być spakowane do jednego pliku. Każda seria czasowa będzie następująca: pierwsza kolumna to sygnatura czasowa, a druga kolumna to wartość.

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

Parametry

modelId

string

Identyfikator modelu.

body

DetectionRequest

Wykrywanie żądania anomalii

options

AnomalyDetectorDetectAnomalyOptionalParams

Parametry opcji.

Zwraca

Promise<AnomalyDetectorDetectAnomalyResponse>

dziedziczone zAnomalyDetector.detectAnomaly

detectChangePoint(DetectChangePointRequest, AnomalyDetectorDetectChangePointOptionalParams)

Ocena wyniku punktu zmiany dla każdego punktu serii

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

Parametry

body

DetectChangePointRequest

Potrzebne są punkty szeregów czasowych i stopień szczegółowości. Zaawansowane parametry modelu można również ustawić w żądaniu w razie potrzeby.

options

AnomalyDetectorDetectChangePointOptionalParams

Parametry opcji.

Zwraca

Promise<AnomalyDetectorDetectChangePointResponse>

dziedziczone zAnomalyDetector.detectChangePoint

detectEntireSeries(DetectRequest, AnomalyDetectorDetectEntireSeriesOptionalParams)

Ta operacja generuje model z całą serią. Każdy punkt jest wykrywany przy użyciu tego samego modelu. W przypadku tej metody punkty przed i po pewnym punkcie są używane do określenia, czy jest to anomalia. Całe wykrywanie może dać użytkownikowi ogólny stan szeregów czasowych.

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

Parametry

body

DetectRequest

W razie potrzeby punkty szeregów czasowych i okres. Zaawansowane parametry modelu można również ustawić w żądaniu.

options

AnomalyDetectorDetectEntireSeriesOptionalParams

Parametry opcji.

Zwraca

Promise<AnomalyDetectorDetectEntireSeriesResponse>

dziedziczone zanomaliiDetector.detectEntireSeries

detectLastPoint(DetectRequest, AnomalyDetectorDetectLastPointOptionalParams)

Ta operacja generuje model przy użyciu punktów przed ostatnim. W przypadku tej metody tylko punkty historyczne są używane do określania, czy punkt docelowy jest anomalią. Najnowsza operacja wykrywania punktów jest zgodna ze scenariuszem monitorowania metryk biznesowych w czasie rzeczywistym.

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

Parametry

body

DetectRequest

W razie potrzeby punkty szeregów czasowych i okres. Zaawansowane parametry modelu można również ustawić w żądaniu.

options

AnomalyDetectorDetectLastPointOptionalParams

Parametry opcji.

Zwraca

Promise<AnomalyDetectorDetectLastPointResponse>

dziedziczone zAnomalyDetector.detectLastPoint

exportModel(string, AnomalyDetectorExportModelOptionalParams)

Eksportowanie wielowariancyjnego modelu wykrywania anomalii na podstawie identyfikatora modelId

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

Parametry

modelId

string

Identyfikator modelu.

options

AnomalyDetectorExportModelOptionalParams

Parametry opcji.

Zwraca

Promise<AnomalyDetectorExportModelResponse>

dziedziczone zanomaliiDetector.exportModel

getDetectionResult(string, AnomalyDetectorGetDetectionResultOptionalParams)

Uzyskiwanie wielowariancyjnego wyniku wykrywania anomalii na podstawie identyfikatora resultId zwróconego przez interfejs API DetectAnomalyAsync

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

Parametry

resultId

string

Identyfikator wyniku.

options

AnomalyDetectorGetDetectionResultOptionalParams

Parametry opcji.

Zwraca

Promise<AnomalyDetectorGetDetectionResultResponse>

dziedziczone zanomaliiDetector.getDetectionResult

getMultivariateModel(string, AnomalyDetectorGetMultivariateModelOptionalParams)

Uzyskaj szczegółowe informacje o modelu wielowariancji, w tym stan trenowania i zmienne używane w modelu.

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

Parametry

modelId

string

Identyfikator modelu.

options

AnomalyDetectorGetMultivariateModelOptionalParams

Parametry opcji.

Zwraca

Promise<AnomalyDetectorGetMultivariateModelResponse>

dziedziczone zAnomalyDetector.getMultivariateModel

lastDetectAnomaly(string, LastDetectionRequest, AnomalyDetectorLastDetectAnomalyOptionalParams)

Zsynchronizowany interfejs API na potrzeby wykrywania anomalii.

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

Parametry

modelId

string

Identyfikator modelu.

body

LastDetectionRequest

Żądanie ostatniego wykrycia.

options

AnomalyDetectorLastDetectAnomalyOptionalParams

Parametry opcji.

Zwraca

Promise<AnomalyDetectorLastDetectAnomalyResponse>

dziedziczone zanomaliiDetector.lastDetectAnomaly

listMultivariateModel(AnomalyDetectorListMultivariateModelOptionalParams)

Wyświetlanie listy modeli subskrypcji

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

Parametry

options

AnomalyDetectorListMultivariateModelOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<AnomalyDetectorClientModelSnapshot, AnomalyDetectorClientModelSnapshot[], PageSettings>

dziedziczone zAnomalyDetector.listMultivariateModel

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec.

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

Parametry

operationArguments

OperationArguments

Argumenty, z których zostaną wypełnione wartości szablonowe żądania HTTP.

operationSpec

OperationSpec

Element OperationSpec do użycia w celu wypełnienia żądania httpRequest.

callback

ServiceCallback<any>

Wywołanie zwrotne do wywołania po odebraniu odpowiedzi.

Zwraca

Promise<RestResponse>

dziedziczone zanomaliiDetector.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Wyślij podany element httpRequest.

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

Parametry

options

RequestPrepareOptions | WebResourceLike

Zwraca

Promise<HttpOperationResponse>

dziedziczone zAnomalyDetector.sendRequest

trainMultivariateModel(AnomalyDetectorClientModelInfo, AnomalyDetectorTrainMultivariateModelOptionalParams)

Tworzenie i trenowanie wielowariancyjnego modelu wykrywania anomalii. Żądanie musi zawierać parametr źródłowy, aby wskazać identyfikator URI usługi Azure Storage dostępny zewnętrznie (najlepiej identyfikator URI sygnatury dostępu współdzielonego). Wszystkie szeregi czasowe używane w generowaniu modelu muszą być spakowane do jednego pliku. Każda seria czasowa będzie znajdować się w jednym pliku CSV, w którym pierwsza kolumna jest sygnaturą czasową, a druga kolumna to wartość.

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

Parametry

body

AnomalyDetectorClientModelInfo

Żądanie szkolenia

options

AnomalyDetectorTrainMultivariateModelOptionalParams

Parametry opcji.

Zwraca

Promise<AnomalyDetectorTrainMultivariateModelResponse>

dziedziczone zAnomalyDetector.trainMultivariateModel