Gestion des alertes

Les anomalies concernant les données récentes sont remontées par Timelight sous forme d'alertes disponibles par API.

Récupérer la liste des alertes

curl -X GET -H "Authorization: Bearer ${JWT}" "${API_URL}/v1/alert/list"
import timelight_ai_python_api_client as tlc

conf = tlc.Configuration()
conf.host = "https://api.demo.timelight.tech"
conf.api_key["Authorization"] = "Bearer " + jwt

alert_api = tlc.AlertApi(tlc.ApiClient(conf))
alert_api.v1_alert_list_get()
const TimelightApi = require("timelight-ai-js-api-client")

const config = { 
  basePath: "https://api.demo.timelight.tech",
  apiKey: "Bearer " + jwt,
}

const AlertApi = new TimelightApi.AlertApi(config);

AlertApi.v1AlertListGet().then(res => console.log(res.alerts))
const config = { 
  basePath: "https://api.demo.timelight.tech",
  apiKey: "Bearer " + jwt,
}

const AlertApi = new TimelightApi.AlertApi(config);

AlertApi.v1AlertListGet().then(res => console.log(res.alerts))
import TimelightApi from "timelight-ai-js-api-client"

const config = { 
  basePath: "https://api.demo.timelight.tech",
  apiKey: "Bearer " + jwt,
}

const AlertApi = new TimelightApi.AlertApi(config);

AlertApi.v1AlertListGet().then(res => console.log(res.alerts))
$config = TimelightAi\Configuration::getDefaultConfiguration()
    ->setHost("https://api.demo.timelight.tech")
    ->setApiKey('Authorization', 'Bearer ' . $jwt);

$alertApi = new TimelightAi\Api\ImportApi(new GuzzleHttp\Client(), $config);

$response = $alertApi->v1AlertListGet();

Vous pouvez également choisir de filtrer ces résultats directement par source ou année avec les paramètres sourceId et year. Plus d'informations dans la référence complète.

Le résultat de cet appel est une liste d'alertes :

{
  "alerts": [
    {
      "id": 1,
      "source_id": 3,
      "date": "string",
      "criticity": 14.151,
      "shape": true,
      "activity": "over",
      "better_model_id": 123,
      "closest_model_id": 123,
      "favorite": false
    }
    ...
  ]
}

Les composantes d'une alerte sont les suivantes:

  • criticity: importance de l'alerte, plus cette valeur est élevée, plus l'écart de l'activité par rapport au prévisionnel est important
  • shape: l'IA a détecté un écart dans la forme de l'activité
  • activity: cette valeur est fournie si l'IA détecte une sur-activité (over) ou une sous-activité (under)
  • better_model_id: un meilleur profil type que celui prévu a été détecté; uniquement fourni si un planning prévisionnel a été enregistré
  • closest_model_id: toujours présente, cette valeur contient l'id du profil type que Timelight considère être le plus proche de la journée en alerte