AnomalyDetectorClient クラス

リファレンス

Anomaly Detector API は、時系列データの異常を自動的に検出します。 2 種類のモードがサポートされています。1 つはステートレス使用用、もう 1 つはステートフル使用用です。ステートレスモードでは、3 つの機能があります。 Entire Detect は、時系列によってトレーニングされたモデルを使用して系列全体を検出するために使用され、Last Detect は、前のポイントによってトレーニングされたモデルを使用して最後のポイントを検出します。 ChangePoint Detect は、時系列の傾向の変化を検出するために使用されます。ステートフルモードでは、ユーザーは時系列を格納でき、格納された時系列は検出異常に使用されます。このモードでは、ユーザーはクライアント側で時系列を準備せずに時間範囲を指定するだけで、上記の 3 つの機能を引き続き使用できます。上記の 3 つの機能に加えて、ステートフルモデルでは、グループベースの検出とラベル付けサービスも提供されます。ラベル付けサービスを利用することで、ユーザーは検出結果ごとにラベルを提供できます。これらのラベルは、検出モデルの再チューニングまたは再生成に使用されます。不整合検出はグループベースの検出の一種であり、この検出では一連の時系列で不整合が検出されます。異常検出サービスを使用することで、ビジネスのお客様はインシデントを検出し、根本原因分析のためのロジックフローを確立できます。

継承: azure.ai.anomalydetector.aio._operations._operations.AnomalyDetectorClientOperationsMixin

AnomalyDetectorClient

コンストラクター

AnomalyDetectorClient(endpoint: str, credential: AzureKeyCredential, **kwargs: Any)

パラメーター

endpoint: str

必須

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus2.api.cognitive.microsoft.com 必須。

credential: AzureKeyCredential

必須

クライアントが Azure に接続するために必要な資格情報。必須。

api_version: str

API バージョン。既定値は "v1.1" です。この既定値をオーバーライドすると、サポートされていない動作が発生する可能性があることに注意してください。

メソッド

close
delete_multivariate_model	多変量モデルを削除します。 modelId に従って既存の多変量モデルを削除します。
detect_multivariate_batch_anomaly	多変量異常を検出します。トレーニング済みのモデルと推論データの modelId を使用して多変量異常検出タスクを送信します。入力スキーマはトレーニング要求と同じである必要があります。要求は非同期的に完了し、resultId を返して検出結果を照会します。要求は、外部からアクセス可能な Azure ストレージ URI を示すソースリンクである必要があります。これは、Azure BLOB ストレージフォルダーを指しているか、Azure BLOB ストレージ内の CSV ファイルを指しています。
detect_multivariate_last_anomaly	要求本文の最後のポイントで異常を検出します。トレーニング済みのモデルと推論データの modelId を使用して多変量異常検出タスクを送信します。推論データは JSON 形式で要求本文に配置する必要があります。要求は同期的に完了し、応答本文ですぐに検出を返します。
detect_univariate_change_point	系列全体の変更ポイントを検出します。すべての系列ポイントの変更ポイントスコアを評価します。
detect_univariate_entire_series	系列全体の異常をバッチで検出します。この操作により、系列全体を持つモデルが生成され、各ポイントが同じモデルで検出されます。このメソッドでは、特定のポイントの前後のポイントを使用して、異常であるかどうかを判断します。検出全体によって、ユーザーは時系列の全体的な状態を得ることができます。
detect_univariate_last_point	時系列の最新のポイントの異常状態を検出します。この操作では、API に送信したポイントを使用し、すべてのデータに基づいて最後のポイントが異常かどうかを判断するモデルが生成されます。
get_multivariate_batch_detection_result	多変量異常検出結果を取得します。非同期推論の場合は、BatchDetectAnomaly API によって返される resultId に基づいて、多変量異常検出結果を取得します。
get_multivariate_model	多変量モデルを取得します。多変量モデルの詳細情報 (トレーニングの状態やモデルで使用された変数を含む) を取得します。
list_multivariate_models	多変量モデルを一覧表示します。リソースのモデルを一覧表示します。
send_request	クライアントのチェーンポリシーを介してネットワーク要求を実行します。 `>>> from azure.core.rest import HttpRequest >>> request = HttpRequest("GET", "https://www.example.org/") <HttpRequest [GET], url: 'https://www.example.org/'> >>> response = await client.send_request(request) <AsyncHttpResponse: 200 OK>` このコードフローの詳細については、次を参照してください。 https://aka.ms/azsdk/dpcodegen/python/send_request
train_multivariate_model	多変量異常検出モデルをトレーニングします。多変量異常検出モデルを作成してトレーニングします。要求には、外部からアクセス可能な Azure BLOB ストレージ URI を示すソースパラメーターが含まれている必要があります。データ入力には、複数の CSV ファイルを含む Azure BLOB ストレージフォルダーを指す URI と、各 CSV ファイルにタイムスタンプと変数の 2 つの列があります。もう 1 つの種類の入力は、すべての変数とタイムスタンプ列を含む Azure BLOB ストレージ内の CSV ファイルを指す URI です。

close

async close() -> None

delete_multivariate_model

多変量モデルを削除します。

modelId に従って既存の多変量モデルを削除します。

async delete_multivariate_model(model_id: str, **kwargs: Any) -> None

パラメーター

model_id: str

必須

モデル識別子。必須。

戻り値

なし

の戻り値の型 :

None

例外

HttpResponseError

detect_multivariate_batch_anomaly

多変量異常を検出します。

トレーニング済みのモデルと推論データの modelId を使用して多変量異常検出タスクを送信します。入力スキーマはトレーニング要求と同じである必要があります。要求は非同期的に完了し、resultId を返して検出結果を照会します。要求は、外部からアクセス可能な Azure ストレージ URI を示すソースリンクである必要があります。これは、Azure BLOB ストレージフォルダーを指しているか、Azure BLOB ストレージ内の CSV ファイルを指しています。

async detect_multivariate_batch_anomaly(model_id: str, options: MultivariateBatchDetectionOptions | MutableMapping[str, Any] | IO, **kwargs: Any) -> MultivariateDetectionResult

パラメーター

model_id: str

必須

モデル識別子。必須。

options: MultivariateBatchDetectionOptions または <xref:JSON> または IO

必須

多変量異常検出の要求。 model、JSON、IO Required のいずれかの種類です。

content_type: str

Body パラメーター Content-Type。既知の値は application/json です。既定値は [なし] です。

戻り値

MultivariateDetectionResult。 MultivariateDetectionResult は MutableMapping と互換性があります

の戻り値の型 :

MultivariateDetectionResult

例外

HttpResponseError

detect_multivariate_last_anomaly

要求本文の最後のポイントで異常を検出します。

トレーニング済みのモデルと推論データの modelId を使用して多変量異常検出タスクを送信します。推論データは JSON 形式で要求本文に配置する必要があります。要求は同期的に完了し、応答本文ですぐに検出を返します。

async detect_multivariate_last_anomaly(model_id: str, options: MultivariateLastDetectionOptions | MutableMapping[str, Any] | IO, **kwargs: Any) -> MultivariateLastDetectionResult

パラメーター

model_id: str

必須

モデル識別子。必須。

options: MultivariateLastDetectionOptions または <xref:JSON> または IO

必須

最後の検出の要求。 model、JSON、IO Required のいずれかの種類です。

content_type: str

Body パラメーター Content-Type。既知の値は application/json です。既定値は [なし] です。

戻り値

MultivariateLastDetectionResult。 MultivariateLastDetectionResult は MutableMapping と互換性があります

の戻り値の型 :

MultivariateLastDetectionResult

例外

HttpResponseError

detect_univariate_change_point

系列全体の変更ポイントを検出します。

すべての系列ポイントの変更ポイントスコアを評価します。

async detect_univariate_change_point(options: UnivariateChangePointDetectionOptions | MutableMapping[str, Any] | IO, **kwargs: Any) -> UnivariateChangePointDetectionResult

パラメーター

options: UnivariateChangePointDetectionOptions または <xref:JSON> または IO

必須

一変量異常検出の方法。 model、JSON、IO Required のいずれかの種類です。

content_type: str

Body パラメーター Content-Type。既知の値は application/json です。既定値は [なし] です。

戻り値

UnivariateChangePointDetectionResult。 UnivariateChangePointDetectionResult は MutableMapping と互換性があります

の戻り値の型 :

UnivariateChangePointDetectionResult

例外

HttpResponseError

detect_univariate_entire_series

系列全体の異常をバッチで検出します。

この操作により、系列全体を持つモデルが生成され、各ポイントが同じモデルで検出されます。このメソッドでは、特定のポイントの前後のポイントを使用して、異常であるかどうかを判断します。検出全体によって、ユーザーは時系列の全体的な状態を得ることができます。

async detect_univariate_entire_series(options: UnivariateDetectionOptions | MutableMapping[str, Any] | IO, **kwargs: Any) -> UnivariateEntireDetectionResult

パラメーター

options: UnivariateDetectionOptions または <xref:JSON> または IO

必須

一変量異常検出の方法。 model、JSON、IO Required のいずれかの種類です。

content_type: str

Body パラメーター Content-Type。既知の値は application/json です。既定値は [なし] です。

戻り値

UnivariateEntireDetectionResult。 UnivariateEntireDetectionResult は MutableMapping と互換性があります

の戻り値の型 :

UnivariateEntireDetectionResult

例外

HttpResponseError

detect_univariate_last_point

時系列の最新のポイントの異常状態を検出します。

この操作では、API に送信したポイントを使用し、すべてのデータに基づいて最後のポイントが異常かどうかを判断するモデルが生成されます。

async detect_univariate_last_point(options: UnivariateDetectionOptions | MutableMapping[str, Any] | IO, **kwargs: Any) -> UnivariateLastDetectionResult

パラメーター

options: UnivariateDetectionOptions または <xref:JSON> または IO

必須

一変量異常検出の方法。 model、JSON、IO Required のいずれかの種類です。

content_type: str

Body パラメーター Content-Type。既知の値は application/json です。既定値は [なし] です。

戻り値

UnivariateLastDetectionResult。 UnivariateLastDetectionResult は MutableMapping と互換性があります

の戻り値の型 :

UnivariateLastDetectionResult

例外

HttpResponseError

get_multivariate_batch_detection_result

多変量異常検出結果を取得します。

非同期推論の場合は、BatchDetectAnomaly API によって返される resultId に基づいて、多変量異常検出結果を取得します。

async get_multivariate_batch_detection_result(result_id: str, **kwargs: Any) -> MultivariateDetectionResult

パラメーター

result_id: str

必須

バッチ検出結果の ID。必須。

戻り値

MultivariateDetectionResult。 MultivariateDetectionResult は MutableMapping と互換性があります

の戻り値の型 :

MultivariateDetectionResult

例外

HttpResponseError

get_multivariate_model

多変量モデルを取得します。

多変量モデルの詳細情報 (トレーニングの状態やモデルで使用された変数を含む) を取得します。

async get_multivariate_model(model_id: str, **kwargs: Any) -> AnomalyDetectionModel

パラメーター

model_id: str

必須

モデル識別子。必須。

戻り値

AnomalyDetectionModel。 AnomalyDetectionModel は MutableMapping と互換性があります

の戻り値の型 :

AnomalyDetectionModel

例外

HttpResponseError

list_multivariate_models

多変量モデルを一覧表示します。

リソースのモデルを一覧表示します。

list_multivariate_models(*, skip: int | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[AnomalyDetectionModel]

パラメーター

skip: int

Skip は、スキップされるモデルの数を示します。既定値は [なし] です。

top: int

Top は、フェッチされるモデルの数を示します。既定値は [なし] です。

戻り値

AnomalyDetectionModel のインスタンスのような反復子。 AnomalyDetectionModel は MutableMapping と互換性があります

の戻り値の型 :

AsyncItemPaged[AnomalyDetectionModel]

例外

HttpResponseError

send_request

クライアントのチェーンポリシーを介してネットワーク要求を実行します。


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = await client.send_request(request)
<AsyncHttpResponse: 200 OK>

このコードフローの詳細については、次を参照してください。 https://aka.ms/azsdk/dpcodegen/python/send_request

send_request(request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]

パラメーター

request: HttpRequest

必須

作成するネットワーク要求。必須。

stream: bool

応答ペイロードがストリーミングされるかどうか。既定値は False です。

戻り値

ネットワーク呼び出しの応答。応答でエラー処理を行いません。

の戻り値の型 :

AsyncHttpResponse

train_multivariate_model

多変量異常検出モデルをトレーニングします。

多変量異常検出モデルを作成してトレーニングします。要求には、外部からアクセス可能な Azure BLOB ストレージ URI を示すソースパラメーターが含まれている必要があります。データ入力には、複数の CSV ファイルを含む Azure BLOB ストレージフォルダーを指す URI と、各 CSV ファイルにタイムスタンプと変数の 2 つの列があります。もう 1 つの種類の入力は、すべての変数とタイムスタンプ列を含む Azure BLOB ストレージ内の CSV ファイルを指す URI です。

async train_multivariate_model(model_info: ModelInfo | MutableMapping[str, Any] | IO, **kwargs: Any) -> AnomalyDetectionModel

パラメーター

model_info: ModelInfo または <xref:JSON> または IO

必須

モデル情報。 model、JSON、IO Required のいずれかの種類です。

content_type: str

Body パラメーター Content-Type。既知の値は application/json です。既定値は [なし] です。

戻り値

AnomalyDetectionModel。 AnomalyDetectionModel は MutableMapping と互換性があります

の戻り値の型 :

AnomalyDetectionModel

例外

HttpResponseError

次の方法で共有

AnomalyDetectorClient クラス

コンストラクター

パラメーター

メソッド

close

delete_multivariate_model

パラメーター

戻り値

の戻り値の型 :

例外

detect_multivariate_batch_anomaly

パラメーター

戻り値

の戻り値の型 :

例外

detect_multivariate_last_anomaly

パラメーター

戻り値

の戻り値の型 :

例外

detect_univariate_change_point

パラメーター

戻り値

の戻り値の型 :

例外

detect_univariate_entire_series

パラメーター

戻り値

の戻り値の型 :

例外

detect_univariate_last_point

パラメーター

戻り値

の戻り値の型 :

例外

get_multivariate_batch_detection_result

パラメーター

戻り値

の戻り値の型 :

例外

get_multivariate_model

パラメーター

戻り値

の戻り値の型 :

例外

list_multivariate_models

パラメーター

戻り値

の戻り値の型 :

例外

send_request

パラメーター

戻り値

の戻り値の型 :

train_multivariate_model

パラメーター

戻り値

の戻り値の型 :

例外

その他のリソース