Crear una transmisión

Crear una transmisión

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

Permisos necesarios: administrador de transmisiones, ver etiquetas

• Bash

  curl -X PUT 'https://<my_api_endpoint>/api/v1/datasets/project1/collateral/streams' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "stream": {
      "comment_filter": {
        "user_properties": {
          "number:Spend": {
            "maximum": 100000,
            "minimum": 100
          },
          "number:Transactions": {
            "one_of": [
              1
            ]
          },
          "string:Country": {
            "one_of": [
              "uk",
              "de"
            ]
          }
        }
      },
      "description": "Used by ACME RPA to create tickets for disputes.",
      "model": {
        "label_thresholds": [
          {
            "name": [
              "Some Label"
            ],
            "threshold": 0.37
          },
          {
            "name": [
              "Another Label"
            ],
            "threshold": 0.46
          },
          {
            "name": [
              "Parent Label",
              "Child Label"
            ],
            "threshold": 0.41
          }
        ],
        "version": 8
      },
      "name": "dispute",
      "title": "Collateral Disputes"
    }
  }'

• Nodo

  const request = require("request");
  
  request.put(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets/project1/collateral/streams",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        stream: {
          comment_filter: {
            user_properties: {
              "number:Spend": { maximum: 100000, minimum: 100 },
              "number:Transactions": { one_of: [1] },
              "string:Country": { one_of: ["uk", "de"] },
            },
          },
          description: "Used by ACME RPA to create tickets for disputes.",
          model: {
            label_thresholds: [
              { name: ["Some Label"], threshold: 0.37 },
              { name: ["Another Label"], threshold: 0.46 },
              { name: ["Parent Label", "Child Label"], threshold: 0.41 },
            ],
            version: 8,
          },
          name: "dispute",
          title: "Collateral Disputes",
        },
      },
    },
    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",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "stream": {
              "name": "dispute",
              "title": "Collateral Disputes",
              "description": "Used by ACME RPA to create tickets for disputes.",
              "model": {
                  "version": 8,
                  "label_thresholds": [
                      {"name": ["Some Label"], "threshold": 0.37},
                      {"name": ["Another Label"], "threshold": 0.46},
                      {
                          "name": ["Parent Label", "Child Label"],
                          "threshold": 0.41,
                      },
                  ],
              },
              "comment_filter": {
                  "user_properties": {
                      "string:Country": {"one_of": ["uk", "de"]},
                      "number:Spend": {"minimum": 100, "maximum": 100000},
                      "number:Transactions": {"one_of": [1]},
                  }
              },
          }
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Respuesta

  {
    "status": "ok",
    "stream": {
      "context": "0",
      "created_at": "2019-08-03T12:30:00.123456Z",
      "dataset_id": "abcdef0123456789",
      "description": "Used by ACME RPA to create tickets for disputes.",
      "id": "0123456789abcdef",
      "model": {
        "version": 8
      },
      "name": "dispute",
      "title": "Collateral Disputes",
      "updated_at": "2019-08-03T12:30:00.123456Z"
    }
  }

Los flujos permiten una iteración persistente y con estado a través de comentarios en un conjunto de datos, con etiquetas predichas y campos generales calculados utilizando un modelo anclado.

Una vez creada una transmisión, los métodos y pueden utilizarse para iterar a través de los comentarios.

Nombre	Tipo	Obligatorio	Descripción
name	String	Sí	Nombre de API para la transmisión, utilizado en las URL. Debe ser único dentro de un conjunto de datos y debe coincidir con [A-Za-z0-9-_]{1,256}.
title	String	No	Título legible por humanos de una línea para la transmisión.
description	String	No	Una descripción más larga de la transmisión.
model	Modelo	No	Si se especifica, los comentarios obtenidos de esta transmisión contendrán predicciones de un modelo anclado.
comment_filter	CommentFilter	No	Si se especifica, no se devolverán los comentarios que no coincidan con el filtro. Consulta para obtener más información sobre cómo afectará el filtro de comentarios a los resultados devueltos por la transmisión.

Donde Model tiene el siguiente formato:

Nombre	Tipo	Obligatorio	Descripción
version	Entero	Sí	Una versión del modelo que se ha anclado a través de la página Modelos .
label_thresholds	array<LabelThreshold>	No	Si se establece, solo se devuelven los valores que coinciden con el label_thresholds dado. Si no se establece, se devolverán todas las etiquetas y todos los valores de predicción.

Donde LabelThreshold tiene el siguiente formato:

Nombre	Tipo	Obligatorio	Descripción
name	array<string>	Sí	El nombre de la etiqueta que se devolverá, en formato de lista de etiquetas jerárquicas. Por ejemplo, la etiqueta "Some Label" tendrá el formato ["Some Label"], y la etiqueta "Parent Label > Child Label" tendrá el formato ["Parent Label", "Child Label"].
threshold	Número	Sí	El umbral de confianza que se utilizará para la etiqueta (un número entre 0,0 y 1,0). La etiqueta solo se devolverá para un comentario si su predicción está por encima de este umbral.

Donde CommentFilter tiene el siguiente formato:

Nombre	Tipo	Obligatorio	Descripción
user_properties	UserPropertyFilter	No	Un filtro que se aplica a las propiedades de usuario de un comentario. Para obtener más información sobre las propiedades de usuario, consulta la Referencia de comentarios.

El UserPropertyFilter es un mapa del nombre de propiedad del usuario para filtrar. Las propiedades de cadena pueden filtrarse a valores en un conjunto ({"one_of": ["val_1", "val_2"]}). Las propiedades numéricas pueden filtrarse a valores en un conjunto ({"one_of": [123, 456]}) o a un rango ({"minimum": 123, "maximum": 456}).