Etiquetar una excepción

Referencia de la API para etiquetar excepciones de flujo en un conjunto de datos de Communications Mining utilizando el punto final de excepciones de flujos en Automation Cloud.

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

Permisos necesarios: Consumir transmisiones, Ver orígenes.

• 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"
      }
    ]
  }'
  

• Nodo

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

• Respuesta

  {
    "status": "ok"
  }
  

Este punto final te permite etiquetar comentarios como excepciones en la plataforma, de modo que un entrenador de modelos pueda revisarlos y etiquetarlos para mejorar el modelo. Recomendamos etiquetar los comentarios para los que el modelo no devolvió predicciones y los comentarios para los que el modelo devolvió predicciones incorrectas.

Nombre	Tipo	Obligatorio	Descripción
exceptions	array<Exception>	Sí	Una lista de excepciones.

Donde Exception tiene el siguiente formato:

Nombre	Tipo	Obligatorio	Descripción
uid	String	Sí	El uid del comentario que debe etiquetarse como excepción.
metadata	Metadatos	Sí	Un objeto que contiene metadatos de excepción.

Donde Metadata tiene el siguiente formato:

Nombre	Tipo	Obligatorio	Descripción
type	String	Sí	El tipo de excepción estará disponible como propiedad de filtro en la interfaz de usuario de Communications Mining™. El valor puede ser una cadena arbitraria. Elija una cadena corta y fácil de entender, como "Sin predicción" y "Predicción incorrecta".