翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# PreviewAnomalyDetector API
<a name="anomaly-detection-api"></a>

`PreviewAnomalyDetector` オペレーションを使用して、指定した期間に異常検出アルゴリズムによってメトリクスデータがどのように分析されるかを示すエンドポイントを作成します。このエンドポイントは、実装前にディテクターのパフォーマンスを評価および検証するのに役立ちます。

有効な HTTP 動詞  
`GET`, `POST`

サポートされているペイロードタイプ  
URL エンコードされたパラメータ  
`POST` 用の `application/x-www-form-urlencoded`

サポートされているパラメータ  
`query=<string>` Prometheus 式のクエリ文字列。  
`start=<rfc3339 | unix_timestamp>` `query_range` を使用して一定期間にわたってクエリを評価する場合、開始タイムスタンプ。  
`end=<rfc3339 | unix_timestamp>` `query_range` を使用して一定期間にわたってクエリを評価する場合、終了タイムスタンプ。  
`step=<duration | float>` クエリの解決ステップ幅 (`duration` 形式または `float` の秒数)。`query_range` を使用して一定期間にわたってクエリを評価するときに、そのクエリで必要とされる場合にのみ使用します。

## クエリパラメータの形式
<a name="anomaly-detection-query-formatting"></a>

元の PromQL 式をクエリパラメータの RandomCutForest (RCF) 擬似関数でラップします。詳細については、「*Amazon Managed Service for Prometheus API リファレンス*」の「[RandomCutForestConfiguration](https://docs.aws.amazon.com/prometheus/latest/APIReference/API_RandomCutForestConfiguration.html)」を参照してください。

RCF 関数は次の形式を使用します。

```
RCF(<query>
[,shingle size
[,sample size
[,ignore near expected from above
[,ignore near expected from below
[,ignore near expected from above ratio
[,ignore near expected from below ratio]]]]])
```

クエリを除くすべてのパラメータはオプションであり、省略するとデフォルト値が使用されます。最小構文は次のとおりです。

```
RCF(<query>)
```

クエリを集計関数でラップする必要があります。他のパラメータを省略するときに特定のオプションパラメータを使用するには、関数に空の位置を残します。

```
RCF(<query>,,,,,1.0,1.0)
```

この例では、期待値と観測値の比率に基づいて、異常検出のスパイクとドロップを無視する比率パラメータのみを設定します。

## API リクエストと応答
<a name="anomaly-detection-query-formatting"></a>

成功した呼び出しは、[QueryMetrics API](AMP-APIReference-QueryMetrics.md) と同じ形式を返します。API は十分なサンプルが利用可能になると、元の時系列に加えて、これらの新しい時系列を返します。
+ `anomaly_detector_preview:lower_band` — PromQL 式の結果の期待値の下限帯域
+ `anomaly_detector_preview:score` – 0～1 の異常スコア。1 はそのデータポイントでの異常の信頼度が高いことを示します。
+ `anomaly_detector_preview:upper_band` — PromQL 式の結果の期待値の上限帯域

 **リクエスト例** 

```
POST /workspaces/workspace-id/anomalydetectors/preview
Content-Type: application/x-www-form-urlencoded

query=RCF%28avg%28vector%28time%28%29%29%29%2C%208%2C%20256%29&start=1735689600&end=1735695000&step=1m
```

 **レスポンス例** 

```
200 OK
...

{
  "status": "success",
  "data": {
    "result": [
      {
        "metric": {},
        "values": [
          [
            1735689600,
            "1735689600"
          ],
          [
            1735689660,
            "1735689660"
          ],
          .........
        ]
      },
      {
        "metric": {
          "anomaly_detector_preview": "upper_band"
        },
        "values": [
          [
            1735693500,
            "1.7356943E9"
          ],
          [
            1735693560,
            "1.7356945E9"
          ]
          ],
          .........
        ]
      },
      {
        "metric": {
          "anomaly_detector_preview": "lower_band"
        },
        "values": [
          [
            1735693500,
            "1.7356928E9"
          ],
          [
            1735693560,
            "1.7356929E9"
          ],
          ......... 
        ]
      },
      {
        "metric": {
          "anomaly_detector_preview": "score"
        },
        "values": [
          [
            1735693500,
            "0.0"
          ],
          [
            1735695000,
            "0.0"
          ],
          .........
        ]
      }
    ],
    "resultType": "matrix"
  }
}
```