ixp
latest
false
UiPath logo, featuring letters U and I in white

Guía del usuario de Communications Mining

Última actualización 7 de oct. de 2025

Predictions

Obtener predicciones para un modelo anclado

/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict

Permisos necesarios: Ver etiquetas, Ver fuentes

Importante:

Operación facturable

Se le cobrará 1 AI Unit o 0,2 Platform Units por comentario proporcionado en el cuerpo de la solicitud.

  • Bash
    curl -X POST 'https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict' \
    -H "Authorization: Bearer $REINFER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
  "documents": [
    {
      "messages": [
        {
          "body": {
            "text": "Hi Bob,\n\nCould you send me the figures for today?"
          },
          "from": "alice@company.com",
          "sent_at": "2020-01-09T16:34:45Z",
          "signature": {
            "text": "Thanks,\nAlice"
          },
          "subject": {
            "text": "Figures Request"
          },
          "to": [
            "bob@organisation.org"
          ]
        }
      ],
      "timestamp": "2013-09-12T20:01:20.000000+00:00",
      "user_properties": {
        "string:City": "London"
      }
    },
    {
      "messages": [
        {
          "body": {
            "text": "Alice,\n\nHere are the figures for today."
          },
          "from": "bob@organisation.org",
          "sent_at": "2020-01-09T16:44:45Z",
          "signature": {
            "text": "Regards,\nBob"
          },
          "subject": {
            "text": "Re: Figures Request"
          },
          "to": [
            "alice@company.com"
          ]
        }
      ],
      "timestamp": "2011-12-12T10:04:30.000000+00:00",
      "user_properties": {
        "string:City": "Bucharest"
      }
    }
  ],
  "threshold": 0.25
}'curl -X POST 'https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict' \
    -H "Authorization: Bearer $REINFER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
  "documents": [
    {
      "messages": [
        {
          "body": {
            "text": "Hi Bob,\n\nCould you send me the figures for today?"
          },
          "from": "alice@company.com",
          "sent_at": "2020-01-09T16:34:45Z",
          "signature": {
            "text": "Thanks,\nAlice"
          },
          "subject": {
            "text": "Figures Request"
          },
          "to": [
            "bob@organisation.org"
          ]
        }
      ],
      "timestamp": "2013-09-12T20:01:20.000000+00:00",
      "user_properties": {
        "string:City": "London"
      }
    },
    {
      "messages": [
        {
          "body": {
            "text": "Alice,\n\nHere are the figures for today."
          },
          "from": "bob@organisation.org",
          "sent_at": "2020-01-09T16:44:45Z",
          "signature": {
            "text": "Regards,\nBob"
          },
          "subject": {
            "text": "Re: Figures Request"
          },
          "to": [
            "alice@company.com"
          ]
        }
      ],
      "timestamp": "2011-12-12T10:04:30.000000+00:00",
      "user_properties": {
        "string:City": "Bucharest"
      }
    }
  ],
  "threshold": 0.25
}'
  • Nodo
    const request = require("request");

request.post(
  {
    url: "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
    json: true,
    body: {
      documents: [
        {
          messages: [
            {
              body: {
                text: "Hi Bob,\n\nCould you send me the figures for today?",
              },
              from: "alice@company.com",
              sent_at: "2020-01-09T16:34:45Z",
              signature: { text: "Thanks,\nAlice" },
              subject: { text: "Figures Request" },
              to: ["bob@organisation.org"],
            },
          ],
          timestamp: "2013-09-12T20:01:20.000000+00:00",
          user_properties: { "string:City": "London" },
        },
        {
          messages: [
            {
              body: { text: "Alice,\n\nHere are the figures for today." },
              from: "bob@organisation.org",
              sent_at: "2020-01-09T16:44:45Z",
              signature: { text: "Regards,\nBob" },
              subject: { text: "Re: Figures Request" },
              to: ["alice@company.com"],
            },
          ],
          timestamp: "2011-12-12T10:04:30.000000+00:00",
          user_properties: { "string:City": "Bucharest" },
        },
      ],
      threshold: 0.25,
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);const request = require("request");

request.post(
  {
    url: "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
    json: true,
    body: {
      documents: [
        {
          messages: [
            {
              body: {
                text: "Hi Bob,\n\nCould you send me the figures for today?",
              },
              from: "alice@company.com",
              sent_at: "2020-01-09T16:34:45Z",
              signature: { text: "Thanks,\nAlice" },
              subject: { text: "Figures Request" },
              to: ["bob@organisation.org"],
            },
          ],
          timestamp: "2013-09-12T20:01:20.000000+00:00",
          user_properties: { "string:City": "London" },
        },
        {
          messages: [
            {
              body: { text: "Alice,\n\nHere are the figures for today." },
              from: "bob@organisation.org",
              sent_at: "2020-01-09T16:44:45Z",
              signature: { text: "Regards,\nBob" },
              subject: { text: "Re: Figures Request" },
              to: ["alice@company.com"],
            },
          ],
          timestamp: "2011-12-12T10:04:30.000000+00:00",
          user_properties: { "string:City": "Bucharest" },
        },
      ],
      threshold: 0.25,
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);
  • Python
    import json
import os

import requests

response = requests.post(
    "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
    json={
        "documents": [
            {
                "messages": [
                    {
                        "from": "alice@company.com",
                        "to": ["bob@organisation.org"],
                        "sent_at": "2020-01-09T16:34:45Z",
                        "body": {
                            "text": "Hi Bob,\n\nCould you send me the figures for today?"
                        },
                        "subject": {"text": "Figures Request"},
                        "signature": {"text": "Thanks,\nAlice"},
                    }
                ],
                "timestamp": "2013-09-12T20:01:20.000000+00:00",
                "user_properties": {"string:City": "London"},
            },
            {
                "messages": [
                    {
                        "from": "bob@organisation.org",
                        "to": ["alice@company.com"],
                        "sent_at": "2020-01-09T16:44:45Z",
                        "body": {
                            "text": "Alice,\n\nHere are the figures for today."
                        },
                        "subject": {"text": "Re: Figures Request"},
                        "signature": {"text": "Regards,\nBob"},
                    }
                ],
                "timestamp": "2011-12-12T10:04:30.000000+00:00",
                "user_properties": {"string:City": "Bucharest"},
            },
        ],
        "threshold": 0.25,
    },
)

print(json.dumps(response.json(), indent=2, sort_keys=True))import json
import os

import requests

response = requests.post(
    "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
    json={
        "documents": [
            {
                "messages": [
                    {
                        "from": "alice@company.com",
                        "to": ["bob@organisation.org"],
                        "sent_at": "2020-01-09T16:34:45Z",
                        "body": {
                            "text": "Hi Bob,\n\nCould you send me the figures for today?"
                        },
                        "subject": {"text": "Figures Request"},
                        "signature": {"text": "Thanks,\nAlice"},
                    }
                ],
                "timestamp": "2013-09-12T20:01:20.000000+00:00",
                "user_properties": {"string:City": "London"},
            },
            {
                "messages": [
                    {
                        "from": "bob@organisation.org",
                        "to": ["alice@company.com"],
                        "sent_at": "2020-01-09T16:44:45Z",
                        "body": {
                            "text": "Alice,\n\nHere are the figures for today."
                        },
                        "subject": {"text": "Re: Figures Request"},
                        "signature": {"text": "Regards,\nBob"},
                    }
                ],
                "timestamp": "2011-12-12T10:04:30.000000+00:00",
                "user_properties": {"string:City": "Bucharest"},
            },
        ],
        "threshold": 0.25,
    },
)

print(json.dumps(response.json(), indent=2, sort_keys=True))
  • Respuesta
    {
  "entities": [
    [
      {
        "capture_ids": [],
        "formatted_value": "Bob",
        "id": "76aebf2646577a1d",
        "kind": "person",
        "name": "person",
        "probability": null,
        "span": {
          "char_end": 6,
          "char_start": 3,
          "content_part": "body",
          "message_index": 0,
          "utf16_byte_end": 12,
          "utf16_byte_start": 6
        }
      },
      {
        "capture_ids": [],
        "formatted_value": "2020-01-09 00:00 UTC",
        "id": "20beddf4c5f5bb61",
        "kind": "date",
        "name": "date",
        "probability": null,
        "span": {
          "char_end": 48,
          "char_start": 43,
          "content_part": "body",
          "message_index": 0,
          "utf16_byte_end": 96,
          "utf16_byte_start": 86
        }
      }
    ],
    []
  ],
  "model": {
    "time": "2020-02-06T20:42:58.047000Z",
    "version": 5
  },
  "predictions": [
    [
      {
        "name": ["Some Label"],
        "probability": 0.8896465003490448
      },
      {
        "name": ["Parent Label", "Child Label"],
        "probability": 0.26687008142471313,
        "sentiment": 0.8762539502232571
      }
    ],
    [
      {
        "name": ["Other Label"],
        "probability": 0.6406207121908665
      }
    ]
  ],
  "status": "ok"
}{
  "entities": [
    [
      {
        "capture_ids": [],
        "formatted_value": "Bob",
        "id": "76aebf2646577a1d",
        "kind": "person",
        "name": "person",
        "probability": null,
        "span": {
          "char_end": 6,
          "char_start": 3,
          "content_part": "body",
          "message_index": 0,
          "utf16_byte_end": 12,
          "utf16_byte_start": 6
        }
      },
      {
        "capture_ids": [],
        "formatted_value": "2020-01-09 00:00 UTC",
        "id": "20beddf4c5f5bb61",
        "kind": "date",
        "name": "date",
        "probability": null,
        "span": {
          "char_end": 48,
          "char_start": 43,
          "content_part": "body",
          "message_index": 0,
          "utf16_byte_end": 96,
          "utf16_byte_start": 86
        }
      }
    ],
    []
  ],
  "model": {
    "time": "2020-02-06T20:42:58.047000Z",
    "version": 5
  },
  "predictions": [
    [
      {
        "name": ["Some Label"],
        "probability": 0.8896465003490448
      },
      {
        "name": ["Parent Label", "Child Label"],
        "probability": 0.26687008142471313,
        "sentiment": 0.8762539502232571
      }
    ],
    [
      {
        "name": ["Other Label"],
        "probability": 0.6406207121908665
      }
    ]
  ],
  "status": "ok"
}
Debe proporcionar la versión del modelo que desea consultar para las predicciones en la solicitud. Puedes utilizar el número de versión entero, o los valores especiales live o staging para consultar la versión actual del modelo Live o Staging.
Formato de solicitud
NombreTipoObligatorioDescripción
documentsarray<Comment>SíUn lote de un máximo de 4096 documentos, en el formato descrito en Referencia de comentarios. Los lotes más grandes son más rápidos (por documento) que los más pequeños.
thresholdNúmeroNoEl umbral de confianza por el que filtrar los resultados de la etiqueta. Un número entre 1.0 y 0.0. 0.0 incluirá todos los resultados. Establécelo en "auto" para utilizar umbrales automáticos. Si no se establece, se utilizará el umbral predeterminado de 0.25 .
labelsarray<Label>NoUna lista de etiquetas solicitadas que se devolverán con umbrales opcionales específicos de etiquetas.

Donde Label tiene el siguiente formato:

NombreTipoObligatorioDescripción
namearray<string>SíEl nombre de la etiqueta que se devolverá, en formato de lista de etiquetas jerárquicas. Por ejemplo, la etiqueta "Parent Label > Child Label" tendrá el formato ["Parent Label", "Child Label"].
thresholdNúmeroNoEl umbral de confianza que se utilizará para la etiqueta. Si no se especifica, se establecerá de forma predeterminada en el umbral especificado en el nivel superior.
Formato de respuesta
NombreTipoDescripción
statusStringok si la solicitud tiene éxito, o error en caso de error. Para obtener más información sobre las respuestas de error, consulta Información general.
predictionsarray<array<Label>>Una lista de array<Label> en el mismo orden que los comentarios de la solicitud, donde cada Label tiene el formato descrito aquí.
entitiesarray<array<Entity>>Una lista de array<Entity> en el mismo orden que los comentarios de la solicitud, donde cada Entity tiene el formato descrito aquí.
label_propertiesarray<LabelProperty>Una matriz que contiene propiedades de etiqueta previstas para este comentario, donde cada LabelProperty tiene el formato descrito aquí.
modelModeloInformación sobre el modelo que se utilizó para realizar las predicciones, en el formato descrito aquí.

Obtener predicciones para la última versión del modelo

Para obtener predicciones de la última versión del modelo disponible para un conjunto de datos, consulta las instrucciones en Obtener predicciones para un modelo anclado, pero utiliza latest en lugar de una versión del modelo anclado.

Obtener predicciones para un modelo anclado para correos electrónicos sin procesar

/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails

Permisos necesarios: Ver etiquetas, Ver fuentes

Importante:

Operación facturable

Se le cobrará 1 AI Unit o 0,2 Platform Units por cada correo electrónico sin procesar proporcionado en el cuerpo de la solicitud.

  • Bash
    curl -X POST 'https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails' \
    -H "Authorization: Bearer $REINFER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
  "documents": [
    {
      "raw_email": {
        "body": {
          "plain": "Hi Bob,\n\nCould you send me the figures for today?\n\nThanks,\nAlice"
        },
        "headers": {
          "parsed": {
            "Date": "Thu, 09 Jan 2020 16:34:45 +0000",
            "From": "alice@company.com",
            "Message-ID": "abcdef@company.com",
            "References": "<01234@company.com> <56789@company.com>",
            "Subject": "Figures Request",
            "To": "bob@organisation.org"
          }
        }
      },
      "user_properties": {
        "string:City": "London"
      }
    },
    {
      "raw_email": {
        "body": {
          "html": "<p>Alice,</p><p>Here are the figures for today.</p><p>Regards,<br/>Bob</p>"
        },
        "headers": {
          "raw": "Message-ID: 012345@company.com\nDate: Thu, 09 Jan 2020 16:44:45 +0000\nSubject: Re: Figures Request\nFrom: bob@organisation.org\nTo: alice@company.com"
        }
      },
      "user_properties": {
        "string:City": "Bucharest"
      }
    }
  ],
  "include_comments": false,
  "threshold": 0.25,
  "transform_tag": "generic.0.CONVKER5"
}'curl -X POST 'https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails' \
    -H "Authorization: Bearer $REINFER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
  "documents": [
    {
      "raw_email": {
        "body": {
          "plain": "Hi Bob,\n\nCould you send me the figures for today?\n\nThanks,\nAlice"
        },
        "headers": {
          "parsed": {
            "Date": "Thu, 09 Jan 2020 16:34:45 +0000",
            "From": "alice@company.com",
            "Message-ID": "abcdef@company.com",
            "References": "<01234@company.com> <56789@company.com>",
            "Subject": "Figures Request",
            "To": "bob@organisation.org"
          }
        }
      },
      "user_properties": {
        "string:City": "London"
      }
    },
    {
      "raw_email": {
        "body": {
          "html": "<p>Alice,</p><p>Here are the figures for today.</p><p>Regards,<br/>Bob</p>"
        },
        "headers": {
          "raw": "Message-ID: 012345@company.com\nDate: Thu, 09 Jan 2020 16:44:45 +0000\nSubject: Re: Figures Request\nFrom: bob@organisation.org\nTo: alice@company.com"
        }
      },
      "user_properties": {
        "string:City": "Bucharest"
      }
    }
  ],
  "include_comments": false,
  "threshold": 0.25,
  "transform_tag": "generic.0.CONVKER5"
}'
  • Nodo
    const request = require("request");

request.post(
  {
    url: "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
    json: true,
    body: {
      documents: [
        {
          raw_email: {
            body: {
              plain:
                "Hi Bob,\n\nCould you send me the figures for today?\n\nThanks,\nAlice",
            },
            headers: {
              parsed: {
                Date: "Thu, 09 Jan 2020 16:34:45 +0000",
                From: "alice@company.com",
                "Message-ID": "abcdef@company.com",
                References: "<01234@company.com> <56789@company.com>",
                Subject: "Figures Request",
                To: "bob@organisation.org",
              },
            },
          },
          user_properties: { "string:City": "London" },
        },
        {
          raw_email: {
            body: {
              html: "<p>Alice,</p><p>Here are the figures for today.</p><p>Regards,<br/>Bob</p>",
            },
            headers: {
              raw: "Message-ID: 012345@company.com\nDate: Thu, 09 Jan 2020 16:44:45 +0000\nSubject: Re: Figures Request\nFrom: bob@organisation.org\nTo: alice@company.com",
            },
          },
          user_properties: { "string:City": "Bucharest" },
        },
      ],
      include_comments: false,
      threshold: 0.25,
      transform_tag: "generic.0.CONVKER5",
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);const request = require("request");

request.post(
  {
    url: "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
    json: true,
    body: {
      documents: [
        {
          raw_email: {
            body: {
              plain:
                "Hi Bob,\n\nCould you send me the figures for today?\n\nThanks,\nAlice",
            },
            headers: {
              parsed: {
                Date: "Thu, 09 Jan 2020 16:34:45 +0000",
                From: "alice@company.com",
                "Message-ID": "abcdef@company.com",
                References: "<01234@company.com> <56789@company.com>",
                Subject: "Figures Request",
                To: "bob@organisation.org",
              },
            },
          },
          user_properties: { "string:City": "London" },
        },
        {
          raw_email: {
            body: {
              html: "<p>Alice,</p><p>Here are the figures for today.</p><p>Regards,<br/>Bob</p>",
            },
            headers: {
              raw: "Message-ID: 012345@company.com\nDate: Thu, 09 Jan 2020 16:44:45 +0000\nSubject: Re: Figures Request\nFrom: bob@organisation.org\nTo: alice@company.com",
            },
          },
          user_properties: { "string:City": "Bucharest" },
        },
      ],
      include_comments: false,
      threshold: 0.25,
      transform_tag: "generic.0.CONVKER5",
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);
  • Python
    import json
import os

import requests

response = requests.post(
    "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
    json={
        "transform_tag": "generic.0.CONVKER5",
        "documents": [
            {
                "raw_email": {
                    "headers": {
                        "parsed": {
                            "Message-ID": "abcdef@company.com",
                            "Date": "Thu, 09 Jan 2020 16:34:45 +0000",
                            "Subject": "Figures Request",
                            "From": "alice@company.com",
                            "To": "bob@organisation.org",
                            "References": "<01234@company.com> <56789@company.com>",
                        }
                    },
                    "body": {
                        "plain": "Hi Bob,\n\nCould you send me the figures for today?\n\nThanks,\nAlice"
                    },
                },
                "user_properties": {"string:City": "London"},
            },
            {
                "raw_email": {
                    "headers": {
                        "raw": "Message-ID: 012345@company.com\nDate: Thu, 09 Jan 2020 16:44:45 +0000\nSubject: Re: Figures Request\nFrom: bob@organisation.org\nTo: alice@company.com"
                    },
                    "body": {
                        "html": "<p>Alice,</p><p>Here are the figures for today.</p><p>Regards,<br/>Bob</p>"
                    },
                },
                "user_properties": {"string:City": "Bucharest"},
            },
        ],
        "threshold": 0.25,
        "include_comments": False,
    },
)

print(json.dumps(response.json(), indent=2, sort_keys=True))import json
import os

import requests

response = requests.post(
    "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
    json={
        "transform_tag": "generic.0.CONVKER5",
        "documents": [
            {
                "raw_email": {
                    "headers": {
                        "parsed": {
                            "Message-ID": "abcdef@company.com",
                            "Date": "Thu, 09 Jan 2020 16:34:45 +0000",
                            "Subject": "Figures Request",
                            "From": "alice@company.com",
                            "To": "bob@organisation.org",
                            "References": "<01234@company.com> <56789@company.com>",
                        }
                    },
                    "body": {
                        "plain": "Hi Bob,\n\nCould you send me the figures for today?\n\nThanks,\nAlice"
                    },
                },
                "user_properties": {"string:City": "London"},
            },
            {
                "raw_email": {
                    "headers": {
                        "raw": "Message-ID: 012345@company.com\nDate: Thu, 09 Jan 2020 16:44:45 +0000\nSubject: Re: Figures Request\nFrom: bob@organisation.org\nTo: alice@company.com"
                    },
                    "body": {
                        "html": "<p>Alice,</p><p>Here are the figures for today.</p><p>Regards,<br/>Bob</p>"
                    },
                },
                "user_properties": {"string:City": "Bucharest"},
            },
        ],
        "threshold": 0.25,
        "include_comments": False,
    },
)

print(json.dumps(response.json(), indent=2, sort_keys=True))
  • Respuesta
    {
  "entities": [
    [
      {
        "capture_ids": [],
        "formatted_value": "Bob",
        "id": "76aebf2646577a1d",
        "kind": "person",
        "name": "person",
        "probability": null,
        "span": {
          "char_end": 6,
          "char_start": 3,
          "content_part": "body",
          "message_index": 0,
          "utf16_byte_end": 12,
          "utf16_byte_start": 6
        }
      },
      {
        "capture_ids": [],
        "formatted_value": "2020-01-09 00:00 UTC",
        "id": "20beddf4c5f5bb61",
        "kind": "date",
        "name": "date",
        "probability": null,
        "span": {
          "char_end": 48,
          "char_start": 43,
          "content_part": "body",
          "message_index": 0,
          "utf16_byte_end": 96,
          "utf16_byte_start": 86
        }
      }
    ],
    []
  ],
  "model": {
    "time": "2020-02-06T20:42:58.047000Z",
    "version": 5
  },
  "predictions": [
    [
      {
        "name": ["Some Label"],
        "probability": 0.8896465003490448
      },
      {
        "name": ["Parent Label", "Child Label"],
        "probability": 0.26687008142471313,
        "sentiment": 0.8762539502232571
      }
    ],
    [
      {
        "name": ["Other Label"],
        "probability": 0.6406207121908665
      }
    ]
  ],
  "status": "ok"
}{
  "entities": [
    [
      {
        "capture_ids": [],
        "formatted_value": "Bob",
        "id": "76aebf2646577a1d",
        "kind": "person",
        "name": "person",
        "probability": null,
        "span": {
          "char_end": 6,
          "char_start": 3,
          "content_part": "body",
          "message_index": 0,
          "utf16_byte_end": 12,
          "utf16_byte_start": 6
        }
      },
      {
        "capture_ids": [],
        "formatted_value": "2020-01-09 00:00 UTC",
        "id": "20beddf4c5f5bb61",
        "kind": "date",
        "name": "date",
        "probability": null,
        "span": {
          "char_end": 48,
          "char_start": 43,
          "content_part": "body",
          "message_index": 0,
          "utf16_byte_end": 96,
          "utf16_byte_start": 86
        }
      }
    ],
    []
  ],
  "model": {
    "time": "2020-02-06T20:42:58.047000Z",
    "version": 5
  },
  "predictions": [
    [
      {
        "name": ["Some Label"],
        "probability": 0.8896465003490448
      },
      {
        "name": ["Parent Label", "Child Label"],
        "probability": 0.26687008142471313,
        "sentiment": 0.8762539502232571
      }
    ],
    [
      {
        "name": ["Other Label"],
        "probability": 0.6406207121908665
      }
    ]
  ],
  "status": "ok"
}
Debe proporcionar la versión del modelo que desea consultar para las predicciones en la solicitud. Puedes utilizar el número de versión entero, o los valores especiales live o staging para consultar la versión actual del modelo Live o Staging.
Formato de solicitud
NombreTipoObligatorioDescripción
transform_tagStringSíUna etiqueta que especifica cómo deben procesarse los datos sin procesar.
documentsarray<Document>SíUn lote de como máximo 4096 documentos en el formato descrito en la siguiente tabla. Los lotes más grandes son más rápidos (por documento) que los más pequeños.
thresholdNúmeroNoEl umbral de confianza por el que filtrar los resultados de la etiqueta. Un número entre 1.0 y 0.0. 0.0 incluirá todos los resultados. Establécelo en "auto" para utilizar umbrales automáticos. Si no se establece, se utilizará el umbral predeterminado de 0.25 .
labelsarray<Label>NoUna lista de etiquetas solicitadas que se devolverán con umbrales opcionales específicos de etiquetas.
include_commentsBooleanoNoSi se establece en true, los comentarios analizados de los correos electrónicos se devolverán en el cuerpo de la respuesta.
Donde Document tiene el siguiente formato:
NombreTipoObligatorioDescripción
raw_emailRawEmailSíDatos de correo electrónico, en el formato descrito Comentarios.
user_propertiesmap<string, string | number>NoCualquier metadato definido por el usuario que se aplique al comentario. El formato se describe en Comentarios.
Nota: Algunas propiedades de usuario se generan en función del contenido del correo electrónico. Si estos entran en conflicto con las propiedades de usuario cargadas, la solicitud fallará con 422 Unprocessable Entity.
Donde Label tiene el siguiente formato:
NombreTipoObligatorioDescripción
namearray<string>SíEl nombre de la etiqueta que se devolverá, en formato de lista de etiquetas jerárquicas. Por ejemplo, la etiqueta "Parent Label > Child Label" tendrá el formato ["Parent Label", "Child Label"].
thresholdNúmeroNoEl umbral de confianza que se utilizará para la etiqueta. Si no se especifica, se establecerá de forma predeterminada en el umbral especificado en el nivel superior.
Formato de respuesta
NombreTipoDescripción
statusStringok si la solicitud tiene éxito, o error en caso de error. Para obtener más información sobre las respuestas de error, consulta Información general.
commentsarray<Comment>Una lista de comentarios analizados de los correos electrónicos sin procesar cargados, en el formato descrito en la Referencia de comentarios. Solo se devuelve si estableces include_comments en la solicitud.
predictionsarray<array<Label>>Una lista de array<Label> en el mismo orden que los comentarios de la solicitud, donde cada Label tiene el formato descrito aquí.
entitiesarray<array<Entity>>Una lista de array<Entity> en el mismo orden que los comentarios de la solicitud, donde cada Entity tiene el formato descrito aquí.
label_propertiesarray<LabelProperty>Una matriz que contiene propiedades de etiqueta previstas para este comentario, donde cada LabelProperty tiene el formato descrito aquí.
modelModeloInformación sobre el modelo que se utilizó para realizar las predicciones, en el formato descrito aquí.
Nota:

Para solicitudes grandes, este punto final puede tardar más en responder. Debe aumentar el tiempo de espera de su cliente.

Obtener predicciones para un modelo anclado por ID de comentario

/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments

Permisos necesarios: Ver etiquetas, Ver fuentes

  • Bash
    curl -X POST 'https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments' \
    -H "Authorization: Bearer $REINFER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
  "threshold": 0.25,
  "uids": [
    "18ba5ce699f8da1f.0001",
    "18ba5ce699f8da1f.0002"
  ]
}'curl -X POST 'https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments' \
    -H "Authorization: Bearer $REINFER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
  "threshold": 0.25,
  "uids": [
    "18ba5ce699f8da1f.0001",
    "18ba5ce699f8da1f.0002"
  ]
}'
  • Nodo
    const request = require("request");

request.post(
  {
    url: "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
    json: true,
    body: {
      threshold: 0.25,
      uids: ["18ba5ce699f8da1f.0001", "18ba5ce699f8da1f.0002"],
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);const request = require("request");

request.post(
  {
    url: "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
    json: true,
    body: {
      threshold: 0.25,
      uids: ["18ba5ce699f8da1f.0001", "18ba5ce699f8da1f.0002"],
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);
  • Python
    import json
import os

import requests

response = requests.post(
    "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
    json={
        "uids": ["18ba5ce699f8da1f.0001", "18ba5ce699f8da1f.0002"],
        "threshold": 0.25,
    },
)

print(json.dumps(response.json(), indent=2, sort_keys=True))import json
import os

import requests

response = requests.post(
    "https://<my_api_endpoint>/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
    json={
        "uids": ["18ba5ce699f8da1f.0001", "18ba5ce699f8da1f.0002"],
        "threshold": 0.25,
    },
)

print(json.dumps(response.json(), indent=2, sort_keys=True))
  • Respuesta
    {
  "model": {
    "time": "2020-02-06T20:42:58.047000Z",
    "version": 5
  },
  "predictions": [
    {
      "entities": [
        {
          "capture_ids": [],
          "formatted_value": "Bob",
          "id": "76aebf2646577a1d",
          "kind": "person",
          "name": "person",
          "probability": null,
          "span": {
            "char_end": 6,
            "char_start": 3,
            "content_part": "body",
            "message_index": 0,
            "utf16_byte_end": 12,
            "utf16_byte_start": 6
          }
        },
        {
          "capture_ids": [],
          "formatted_value": "2020-01-09 00:00 UTC",
          "id": "20beddf4c5f5bb61",
          "kind": "date",
          "name": "date",
          "probability": null,
          "span": {
            "char_end": 48,
            "char_start": 43,
            "content_part": "body",
            "message_index": 0,
            "utf16_byte_end": 96,
            "utf16_byte_start": 86
          }
        }
      ],
      "labels": [
        {
          "name": ["Some Label"],
          "probability": 0.8896465003490448
        },
        {
          "name": ["Parent Label", "Child Label"],
          "probability": 0.26687008142471313,
          "sentiment": 0.8762539502232571
        }
      ],
      "uid": "18ba5ce699f8da1f.0001"
    },
    {
      "entities": [],
      "labels": [
        {
          "name": ["Other Label"],
          "probability": 0.6406207121908665
        }
      ],
      "uid": "18ba5ce699f8da1f.0002"
    }
  ],
  "status": "ok"
}{
  "model": {
    "time": "2020-02-06T20:42:58.047000Z",
    "version": 5
  },
  "predictions": [
    {
      "entities": [
        {
          "capture_ids": [],
          "formatted_value": "Bob",
          "id": "76aebf2646577a1d",
          "kind": "person",
          "name": "person",
          "probability": null,
          "span": {
            "char_end": 6,
            "char_start": 3,
            "content_part": "body",
            "message_index": 0,
            "utf16_byte_end": 12,
            "utf16_byte_start": 6
          }
        },
        {
          "capture_ids": [],
          "formatted_value": "2020-01-09 00:00 UTC",
          "id": "20beddf4c5f5bb61",
          "kind": "date",
          "name": "date",
          "probability": null,
          "span": {
            "char_end": 48,
            "char_start": 43,
            "content_part": "body",
            "message_index": 0,
            "utf16_byte_end": 96,
            "utf16_byte_start": 86
          }
        }
      ],
      "labels": [
        {
          "name": ["Some Label"],
          "probability": 0.8896465003490448
        },
        {
          "name": ["Parent Label", "Child Label"],
          "probability": 0.26687008142471313,
          "sentiment": 0.8762539502232571
        }
      ],
      "uid": "18ba5ce699f8da1f.0001"
    },
    {
      "entities": [],
      "labels": [
        {
          "name": ["Other Label"],
          "probability": 0.6406207121908665
        }
      ],
      "uid": "18ba5ce699f8da1f.0002"
    }
  ],
  "status": "ok"
}
Debe proporcionar la versión del modelo que desea consultar para las predicciones en la solicitud. Puedes utilizar el número de versión entero, o los valores especiales live o staging para consultar la versión actual del modelo Live o Staging.
Formato de solicitud
NombreTipoObligatorioDescripción
uidsarray<string>SíUna lista de como máximo 4096 source_id-s y comment_id-s combinados en el formato de source_id.comment_id. No es necesario que las fuentes pertenezcan al conjunto de datos actual, por lo que puedes solicitar predicciones de comentarios para una fuente en un conjunto de datos diferente (o no). Las listas más grandes son más rápidas (por comentario) que las más pequeñas.
thresholdNúmeroNoEl umbral de confianza por el que filtrar los resultados de la etiqueta. Un número entre 1.0 y 0.0. 0.0 incluirá todos los resultados. Establécelo en "auto" para utilizar umbrales automáticos. Si no se establece, se utilizará el umbral predeterminado de 0.25 .
labelsarray<Label>NoUna lista de etiquetas solicitadas que se devolverán con umbrales opcionales específicos de etiquetas.
Donde Label tiene el siguiente formato:
NombreTipoObligatorioDescripción
namearray<string>SíEl nombre de la etiqueta que se devolverá, en formato de lista de etiquetas jerárquicas. Por ejemplo, la etiqueta "Parent Label > Child Label" tendrá el formato ["Parent Label", "Child Label"].
thresholdNúmeroNoEl umbral de confianza que se utilizará para la etiqueta. Si no se especifica, se establecerá de forma predeterminada en el umbral especificado en el nivel superior.
Formato de respuesta
NombreTipoDescripción
statusStringok si la solicitud tiene éxito, o error en caso de error. Para obtener más información sobre las respuestas de error, consulta Información general.
predictionsarray<Prediction>Una lista de predicciones en el formato descrito en la siguiente tabla.
modelModeloInformación sobre el modelo que se utilizó para realizar las predicciones, en el formato descrito aquí.
Donde Prediction tiene el siguiente formato:
NombreTipoDescripción
uidStringUn source_id y comment_id combinados en el formato de source_id.comment_id.
labelsarray<Label>Una matriz que contiene etiquetas previstas para este comentario, donde Label tiene el formato descrito aquí.
entitiesarray<Entity>Una matriz que contiene entidades previstas para este comentario, donde Entity tiene el formato descrito aquí.
label_propertiesarray<LabelProperty>Una matriz que contiene propiedades de etiqueta previstas para este comentario, donde cada LabelProperty tiene el formato descrito aquí.
Nota: Para solicitudes grandes, este punto final puede tardar más en responder. Debe aumentar el tiempo de espera de su cliente.

Obtener estadísticas de validación del modelo

/api/v1/datasets/<project>/<dataset_name>/labellers/<version>/validation

Permisos necesarios: Ver etiquetas, Ver fuentes

  • Bash
    curl -X GET 'https://<my_api_endpoint>/api/v1/datasets/project1/collateral/labellers/live/validation' \
    -H "Authorization: Bearer $REINFER_TOKEN"curl -X GET 'https://<my_api_endpoint>/api/v1/datasets/project1/collateral/labellers/live/validation' \
    -H "Authorization: Bearer $REINFER_TOKEN"
  • Nodo
    const request = require("request");

request.get(
  {
    url: "https://<my_api_endpoint>/api/v1/datasets/project1/collateral/labellers/live/validation",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);const request = require("request");

request.get(
  {
    url: "https://<my_api_endpoint>/api/v1/datasets/project1/collateral/labellers/live/validation",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);
  • Python
    import json
import os

import requests

response = requests.get(
    "https://<my_api_endpoint>/api/v1/datasets/project1/collateral/labellers/live/validation",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
)

print(json.dumps(response.json(), indent=2, sort_keys=True))import json
import os

import requests

response = requests.get(
    "https://<my_api_endpoint>/api/v1/datasets/project1/collateral/labellers/live/validation",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
)

print(json.dumps(response.json(), indent=2, sort_keys=True))
  • Respuesta
    {
  "status": "ok",
  "validation": {
    "coverage": 0.9119927883148193,
    "dataset_quality": "good",
    "labels": [
      {
        "name": "Notification",
        "parts": ["Notification"]
      },
      {
        "name": "Notification > Out of Office",
        "parts": ["Notification", "Out of Office"]
      },
      {
        "name": "Notification > Public Holiday",
        "parts": ["Notification", "Public Holiday"]
      }
    ],
    "mean_average_precision_safe": 0.83,
    "num_amber_labels": 1,
    "num_labels": 3,
    "num_red_labels": 1,
    "num_reviewed_comments": 10251,
    "version": 5
  }
}{
  "status": "ok",
  "validation": {
    "coverage": 0.9119927883148193,
    "dataset_quality": "good",
    "labels": [
      {
        "name": "Notification",
        "parts": ["Notification"]
      },
      {
        "name": "Notification > Out of Office",
        "parts": ["Notification", "Out of Office"]
      },
      {
        "name": "Notification > Public Holiday",
        "parts": ["Notification", "Public Holiday"]
      }
    ],
    "mean_average_precision_safe": 0.83,
    "num_amber_labels": 1,
    "num_labels": 3,
    "num_red_labels": 1,
    "num_reviewed_comments": 10251,
    "version": 5
  }
}
Esta ruta devuelve estadísticas sobre el rendimiento de un modelo. Las mismas estadísticas se pueden ver en la página Validación. Las estadísticas de un modelo pueden solicitarse con su número version entero. Puedes utilizar los valores especiales live y staging para recuperar estadísticas de las versiones actuales del modelo Live o Staging, o el valor especial latest para la versión del modelo disponible más reciente.
Aunque este punto final acepta versiones de modelos tanto ancladas como no ancladas, recomendamos consultar las versiones de modelos ancladas o el valor especial latest, ya que no se garantiza que las estadísticas estén disponibles para las versiones de modelos no ancladas.

El objeto de respuesta validation contiene los siguientes campos:
NombreTipoDescripción
mean_average_precision_safefloatPuntuación media de precisión media (entre 0.0 y 1.0). Este campo será null si MAP no está disponible.
num_labelsNúmeroNúmero de etiquetas en la taxonomía (en el momento en que se fijó la versión del modelo).
labelsarray<Label>Lista de etiquetas en la taxonomía (en el momento en que se fijó la versión del modelo). Ten en cuenta que, como demuestra el ejemplo de respuesta, las etiquetas principales se devuelven como una etiqueta independiente además de ser devueltas como parte de las etiquetas secundarias.
num_reviewed_commentsNúmeroNúmero de comentarios revisados en el conjunto de datos (en el momento en que se fijó la versión del modelo).
versionNúmeroVersión del modelo.
num_amber_labelsNúmeroNúmero de etiquetas en estado de advertencia ámbar.
num_red_labelsNúmeroNúmero de etiquetas en estado de advertencia rojo.
dataset_scoreNúmeroPuntuación general del conjunto de datos, entre 0 y 100.
dataset_qualityStringUno de "poor", "average", "good", "excellent", que representa el rango de calidad general del conjunto de datos. Puede ser null si no hay suficientes datos.
balancefloatUna medida de la similitud entre los comentarios revisados y no revisados (entre 0.0 y 1.0). Puede ser null si no hay suficientes datos.
balance_qualityStringUno de "poor", "average", "good", "excellent", que representa el rango de calidad del saldo. Puede ser null si no hay suficientes datos.
coveragefloatUn valor fraccionario de la cobertura de la etiqueta en el conjunto de datos (entre 0.0 y 1.0). Puede ser null si no hay suficientes datos.
coverage_qualityStringUno de "poor", "average", "good", "excellent", que representa el rango de calidad de la cobertura. Puede ser null si no hay suficientes datos.
all_labels_qualityStringUno de "poor", "average", "good", "excellent", que representa el rango de calidad de todas las etiquetas. Puede ser null si no hay suficientes datos.
underperforming_labels_qualityStringUno de "poor", "average", "good", "excellent", que representa el rango de calidad de las etiquetas de bajo rendimiento. Puede ser null si no hay suficientes datos.
Donde Label tiene el siguiente formato:
NombreTipoDescripción
nameStringEl nombre de la etiqueta, en formato de cadena.
partsarray<string>El nombre de la etiqueta, en formato de lista de etiquetas jerárquicas. Por ejemplo, la etiqueta "Parent Label > Child Label" tendrá el formato ["Parent Label", "Child Label"]

¿Te ha resultado útil esta página?

Soporte y servicios
Obtén la ayuda que necesitas
UiPath Academy
RPA para el aprendizaje - Cursos de automatización
Foro de UiPath
Foro de la comunidad UiPath
Uipath Logo
Confianza y seguridad
Términos de uso
Política de privacidad
Política de cookies
© 2005-2025 UiPath. Todos los derechos reservados.