Marquer une exception

/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions

Autorisations requises : Utiliser des flux, Afficher les sources.

• Bash

  curl -X PUT 'https://<my_api_endpoint>/api/v1/datasets/project1/collateral/streams/dispute/exceptions' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "exceptions": [
      {
        "metadata": {
          "type": "No Prediction"
        },
        "uid": "18ba5ce699f8da1f.abcdef0123456789"
      },
      {
        "metadata": {
          "type": "Wrong Prediction"
        },
        "uid": "18ba5ce699f8da1f.0123456789abcdef"
      }
    ]
  }'

• Nœud

  const request = require("request");
  
  request.put(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets/project1/collateral/streams/dispute/exceptions",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        exceptions: [
          {
            metadata: { type: "No Prediction" },
            uid: "18ba5ce699f8da1f.abcdef0123456789",
          },
          {
            metadata: { type: "Wrong Prediction" },
            uid: "18ba5ce699f8da1f.0123456789abcdef",
          },
        ],
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.put(
      "https://<my_api_endpoint>/api/v1/datasets/project1/collateral/streams/dispute/exceptions",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "exceptions": [
              {
                  "uid": "18ba5ce699f8da1f.abcdef0123456789",
                  "metadata": {"type": "No Prediction"},
              },
              {
                  "uid": "18ba5ce699f8da1f.0123456789abcdef",
                  "metadata": {"type": "Wrong Prediction"},
              },
          ]
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Réponse

  {
    "status": "ok"
  }

Ce point de terminaison vous permet de baliser les commentaires comme exceptions dans la plate-forme, afin qu'un entraîneur de modèle puisse les examiner et les étiqueter afin d'améliorer le modèle. Nous vous recommandons de baliser les commentaires pour lesquels le modèle n'a renvoyé aucune prédiction et les commentaires pour lesquels le modèle a renvoyé des prédictions erronées. (Pour obtenir de l'aide sur la conception du flux de gestion des exceptions, veuillez consulter le Guide d'intégration).

Nom	Saisie de texte	Requis	DESCRIPTION
exceptions	array<Exception>	oui	Une liste d'exceptions.

Où Exception a le format suivant :

Nom	Saisie de texte	Requis	DESCRIPTION
uid	string	oui	Le uid du commentaire qui doit être balisé comme exception.
metadata	Metadata	oui	Un objet contenant des métadonnées d'exception.

Où Metadata a le format suivant :

Nom	Saisie de texte	Requis	DESCRIPTION
type	string	oui	Le type d'exception sera disponible en tant que propriété de filtre dans l'interface utilisateur de Communications Mining. La valeur peut être une chaîne arbitraire. Veuillez choisir une chaîne courte et facile à comprendre telle que "Pas de prédiction" et "prédiction erronée".