As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Use a operação `PreviewAnomalyDetector` para criar um endpoint que demonstre como seus dados métricos serão analisados pelo algoritmo de detecção de anomalias durante o período especificado. Esse endpoint ajuda você a avaliar e validar o desempenho do detector antes da implementação.

Verbos HTTP válidos:  
`GET`, `POST`

Tipos de carga útil compatíveis  
Parâmetros codificados em URL  
`application/x-www-form-urlencoded` para `POST`

Parâmetros compatíveis  
`query=<string>` Uma string de consulta da expressão Prometheus.  
`start=<rfc3339 | unix_timestamp>` Inicie o timestamp se você estiver usando `query_range` para consultar por um intervalo de tempo.   
`end=<rfc3339 | unix_timestamp>` Carimbo de data/hora de término se você estiver usando `query_range` para consultar por um intervalo de tempo.  
`step=<duration | float>` Largura da etapa de resolução da consulta em `duration` formato ou em `float` alguns segundos. Use somente se você estiver usando `query_range` para consultar por um intervalo de tempo e for necessário para essas consultas.

## Formatação do parâmetro da solicitação
<a name="anomaly-detection-query-formatting"></a>

Envolva sua expressão original do PromQL com a pseudofunção RandomCutForest (RCF) no parâmetro de consulta. Para obter mais informações, consulte a [RandomCutForestConfiguration](https://docs.aws.amazon.com/prometheus/latest/APIReference/API_RandomCutForestConfiguration.html)Referência de API do *Amazon Managed Service for Prometheus*.

A função RCF usa este formato:

```
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]]]]])
```

Todos os parâmetros, exceto a consulta, são opcionais e usam valores padrão quando omitidos. A sintaxe é:

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

A consulta deve ser integrada com uma função de agregação. Para usar parâmetros opcionais específicos e omitir outros, deixe posições vazias na função:

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

Esse exemplo define somente os parâmetros de proporção que ignoram os picos e quedas de detecção de anomalias com base na proporção entre os valores esperados e observados.

## Solicitação e reposta da API
<a name="anomaly-detection-query-formatting"></a>

As chamadas bem-sucedidas retornam o mesmo formato da [QueryMetrics API](AMP-APIReference-QueryMetrics.md). Além da série temporal original, a API retorna estas novas séries temporais quando amostras suficientes estão disponíveis:
+ `anomaly_detector_preview:lower_band`: banda inferior para o valor esperado do resultado da expressão PromQL
+ `anomaly_detector_preview:score`: pontuação de anomalia entre 0 e 1, onde 1 indica alta confiança de uma anomalia naquele ponto de dados
+ `anomaly_detector_preview:upper_band`: banda superior para o valor esperado do resultado da expressão PromQL

 **Exemplo de solicitação** 

```
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
```

 **Exemplo de resposta** 

```
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"
  }
}
```