Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

Utilice la operación `PreviewAnomalyDetector` para crear un punto de conexión que demuestre cómo analizará los datos de sus métricas mediante el algoritmo de detección de anomalías durante el período de tiempo especificado. Este punto de conexión le ayuda a evaluar y validar el rendimiento del detector antes de la implementación.

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

Tipos de carga útil compatibles  
Parámetros codificados con URL  
`application/x-www-form-urlencoded` para `POST`

Parámetros admitidos  
`query=<string>` Una cadena de consulta de expresiones de Prometheus.  
`start=<rfc3339 | unix_timestamp>` Marca de tiempo de inicio si está utilizando `query_range` para consultar un intervalo de tiempo.   
`end=<rfc3339 | unix_timestamp>` Marca de tiempo de finalización si está utilizando `query_range` para consultar un intervalo de tiempo.  
`step=<duration | float>` Ancho del paso de resolución de la consulta en formato `duration` o como número de segundos `float`. Úselo solo si va a utilizar `query_range` para realizar consultas durante un intervalo de tiempo y si es necesario para dichas consultas.

## Formato de parámetros de consultas
<a name="anomaly-detection-query-formatting"></a>

Incluya la expresión original de ProMQL con la pseudofunción RandomCutForest (RCF) en el parámetro de consulta. Para obtener más información, consulte la referencia [RandomCutForestConfiguration](https://docs.aws.amazon.com/prometheus/latest/APIReference/API_RandomCutForestConfiguration.html)de la API de *Amazon Managed Service for Prometheus*.

La función RCF utiliza 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 los parámetros, excepto la consulta, son opcionales y utilizan valores predeterminados cuando se omiten. La sintaxis mínima es la siguiente:

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

Debe incluir una función de agregación en la consulta. Para usar parámetros opcionales específicos y omitir otros, deje las posiciones vacías en la función:

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

En este ejemplo, se establecen únicamente los parámetros de ratio que ignoran los picos y descensos de la detección de anomalías en función de la relación entre los valores esperados y observados.

## Solicitud y respuesta de la API
<a name="anomaly-detection-query-formatting"></a>

[Las llamadas correctas devuelven el mismo formato que la QueryMetrics API.](AMP-APIReference-QueryMetrics.md) Además de las series temporales originales, la API devuelve estas nuevas series temporales cuando hay suficientes muestras disponibles:
+ `anomaly_detector_preview:lower_band`: banda inferior para el valor esperado del resultado de la expresión PromQL
+ `anomaly_detector_preview:score`: puntuación de anomalía entre 0 y 1, donde 1 indica una alta confianza de que se trata de una anomalía en ese punto de datos
+ `anomaly_detector_preview:upper_band`: banda superior para el valor esperado del resultado de la expresión PromQL

 **Solicitud de ejemplo** 

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

 **Respuesta de ejemplo** 

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