Jeux de données

Obtenir tous les jeux de données

/api/v1/datasets

Autorisations requises : Afficher les libellés

• Bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/datasets' \
      -H "Authorization: Bearer $REINFER_TOKEN"
  

• Nœud

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets",
      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",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))
  

• Réponse

  {
    "datasets": [
      {
        "created": "2018-10-15T15:48:49.603000Z",
        "description": "An optional long form description.",
        "has_sentiment": true,
        "id": "18ba5ce699f8da1f",
        "last_modified": "2018-10-15T15:48:49.603000Z",
        "model_family": "english",
        "name": "example",
        "owner": "<project>",
        "source_ids": ["18ba5ce699f8da1f"],
        "title": "An Example Dataset"
      }
    ],
    "status": "ok"
  }
  

Obtenir des jeux de données par projet

/api/v1/datasets/<project>

Autorisations requises : Afficher les libellés

Obtenir un jeu de données par nom

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

Autorisations requises : Afficher les libellés

• Bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/datasets/<project>/example' \
      -H "Authorization: Bearer $REINFER_TOKEN"
  

• Nœud

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets/<project>/example",
      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/<project>/example",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))
  

• Réponse

  {
    "dataset": {
      "created": "2018-10-15T15:48:49.603000Z",
      "description": "An optional long form description.",
      "has_sentiment": true,
      "id": "18ba5ce699f8da1f",
      "last_modified": "2018-10-15T15:48:49.603000Z",
      "model_family": "english",
      "name": "example",
      "owner": "<project>",
      "source_ids": ["18ba5ce699f8da1f"],
      "title": "An Example Dataset"
    },
    "status": "ok"
  }
  

Obtenir les balises de modèle pour un ensemble de données

/api/v1/datasets/<project>/<dataset>/model-tags

Autorisations requises : Administrateur de modèle

• Bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/datasets/<project>/model-tags' \
      -H "Authorization: Bearer $REINFER_TOKEN"
  

• Nœud

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets/<project>/model-tags",
      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/<project>/model-tags",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))
  

• Réponse

  {
    "model_tags": [
      {
        "name": "prod",
        "updated_at": "2021-11-16T12:31:00.123Z",
        "version": 5
      },
      {
        "name": "staging",
        "updated_at": "2021-11-15T12:30:00.123Z",
        "version": 7
      }
    ],
    "status": "ok"
  }
  

Créer un ensemble de données

/api/v1/datasets/<project>/<dataset>

Autorisations requises : Modifier les ensembles de données

• Bash

  curl -X PUT 'https://<my_api_endpoint>/api/v1/datasets/<project>/example' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "dataset": {
      "description": "An optional long form description.",
      "model_family": "english",
      "source_ids": [
        "18ba5ce699f8da1f"
      ],
      "title": "An Example Dataset"
    }
  }'
  

• Nœud

  const request = require("request");
  
  request.put(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets/<project>/example",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        dataset: {
          description: "An optional long form description.",
          model_family: "english",
          source_ids: ["18ba5ce699f8da1f"],
          title: "An Example Dataset",
        },
      },
    },
    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/<project>/example",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "dataset": {
              "title": "An Example Dataset",
              "description": "An optional long form description.",
              "source_ids": ["18ba5ce699f8da1f"],
              "model_family": "english",
          }
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))
  

• Réponse

  {
    "dataset": {
      "created": "2018-10-15T15:48:49.603000Z",
      "description": "An optional long form description.",
      "has_sentiment": true,
      "id": "b9a1fd75f6133bce",
      "last_modified": "2018-10-15T15:48:49.603000Z",
      "model_family": "english",
      "name": "example",
      "owner": "<project>",
      "source_ids": ["18ba5ce699f8da1f"],
      "title": "An Example Dataset"
    },
    "status": "ok"
  }
  

Nom	Saisie de texte	Requis	Description
title	string	non	Titre une ligne lisible par un humain pour l'ensemble de données.
description	string	non	Une description plus longue de l'ensemble de données.
source_ids	array<string>	non	Un tableau des ID de source à inclure dans cet ensemble de données.
model_family	string	non	Famille de modèles d'ensemble de données, peut être anglais ou multilingue. La valeur par défaut est l' anglais. Pour vérifier les langues prises en charge par la famille de modèles multilingues, consultez Sources et jeux de données multilingues.
has_sentiment	boolean	non	Indique si les libellés de l'ensemble de données doivent être appliqués avec un sentiment. La valeur par défaut est true.

Mettre à jour un jeu de données

/api/v1/datasets/<project>/<dataset>

Autorisations requises : administrateur de jeux de données

• Bash

  curl -X POST 'https://<my_api_endpoint>/api/v1/datasets/<project>/example' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "dataset": {
      "title": "An Alternative Title"
    }
  }'
  

• Nœud

  const request = require("request");
  
  request.post(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets/<project>/example",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: { dataset: { title: "An Alternative Title" } },
    },
    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>/example",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={"dataset": {"title": "An Alternative Title"}},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))
  

• Réponse

  {
    "dataset": {
      "created": "2018-10-15T15:48:49.603000Z",
      "description": "An optional long form description.",
      "has_sentiment": true,
      "id": "b9a1fd75f6133bce",
      "last_modified": "2018-10-15T15:53:08.479000Z",
      "model_family": "english",
      "name": "example",
      "owner": "<project>",
      "source_ids": ["18ba5ce699f8da1f"],
      "title": "An Alternative Title"
    },
    "status": "ok"
  }
  

Nom	Saisie de texte	Requis	Description
title	string	non	Titre une ligne lisible par un humain pour l'ensemble de données.
description	string	non	Une description plus longue de l'ensemble de données.
source_ids	array<string>	non	Un tableau des ID de source à inclure dans cet ensemble de données.

Supprimer un jeu de données

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

Autorisations requises : administrateur de jeux de données

• Bash

  curl -X DELETE 'https://<my_api_endpoint>/api/v1/datasets/<project>/example' \
      -H "Authorization: Bearer $REINFER_TOKEN"
  

• Nœud

  const request = require("request");
  
  request.delete(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets/<project>/example",
      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.delete(
      "https://<my_api_endpoint>/api/v1/datasets/<project>/example",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))
  

• Réponse

  {
    "status": "ok"
  }
  

Exporter un ensemble de données

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

Autorisations requises : Exporter des ensembles de données

• Bash

  curl -X POST 'https://<my_api_endpoint>/api/v1/datasets/<project>/example/export' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "limit": 1
  }'
  

• Nœud

  const request = require("request");
  
  request.post(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets/<project>/example/export",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: { limit: 1 },
    },
    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>/example/export",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={"limit": 1},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))
  

• Réponse

  {
    "comments": [
      {
        "annotations": {
          "labels": {
            "assigned": [
              {
                "name": "Parent Label",
                "sentiment": "positive"
              },
              {
                "name": "Parent Label > Child Label",
                "sentiment": "positive"
              }
            ]
          }
        },
        "comment": {
          "context": "1596721237668",
          "created_at": "2020-08-06T13:20:28.531000Z",
          "has_annotations": true,
          "id": "0123456789abcdef",
          "last_modified": "2020-08-06T13:40:37.668000Z",
          "messages": [
            {
              "body": {
                "text": "Alice,\n\nHere are the figures for today.\n\nRegards,\nBob"
              },
              "from": "[e-mail]",
              "sent_at": "2011-12-11T11:05:10Z",
              "subject": {
                "text": "Today's figures"
              },
              "to": ["[e-mail]"]
            }
          ],
          "source_id": "47194279497e141e",
          "text_format": "plain",
          "thread_id": "123456",
          "timestamp": "2011-12-11T11:05:10Z",
          "uid": "47194279497e141e.0123456789abcdef",
          "user_properties": {
            "string:Recipient Domain": "company.com",
            "string:Sender Domain": "organisation.org"
          }
        },
        "predictions": {
          "labels": [
            {
              "name": "Another Parent Label",
              "probability": 0.954979807138443,
              "sentiment": -0.4281917143125379
            },
            {
              "name": "Another Parent Label > Another Child Label",
              "probability": 0.7726812064647675,
              "sentiment": -0.6603664430231163
            }
          ]
        }
      }
    ],
    "continuation": "2021-02-16T10:55:05Z.c060a787c0b2bbf95526ad5cf28bf582",
    "status": "ok"
  }
  

Cet itinéraire vous permet d’exporter un ensemble de données. Il renvoie une liste de commentaires avec les libellés attribués et les dernières prédictions disponibles. Les autres façons d’exporter un ensemble de données sont le téléchargement au format CSV dans le navigateur et le téléchargement en JSON via la CLI. Pour obtenir une comparaison détaillée, consultez le tableau de comparaison.

Format de demande

NME	Saisie de texte	Requis	Description
comment_uids	array<string>	non	Une liste d'un maximum de 256 UID de commentaires (au format source_id.comment_id). Si fourni, seuls ces commentaires seront inclus dans la réponse. Aucun autre filtre ne peut être transmis avec comment_uids.
source_ids	array<string>	non	Liste de 1 024 ID source maximum. Si fourni, seuls les commentaires de ces sources seront inclus dans la réponse.
order_by	string	non	L'un des created_at ou timestamp. Si fourni, renvoie les commentaires triés soit par la date de création d'API des commentaires (created_at), soit par l'horodatage de commentaire défini par l'utilisateur (timestamp). La valeur par défaut est timestamp.
from	string	non	Un horodatage ISO-8601. Si fourni, renvoie les commentaires uniquement à partir de cet horodatage. Le champ order_by associé contrôle l'horodatage qui sera utilisé pour le filtrage.
to	string	non	Un horodatage ISO-8601. Si fourni, renvoie les commentaires uniquement jusqu'à cet horodatage (inclus). Le champ order_by associé contrôle l'horodatage qui sera utilisé pour le filtrage.
continuation	string	non	Jeton de pagination (fourni dans la réponse). Doit être utilisé pour récupérer le nombre limit suivant de commentaires.
limit	Numérique	non	Nombre de commentaires renvoyés par réponse, jusqu'à un maximum de 256. Par défaut : 64.

Format de réponse

Nom	Saisie de texte	Description
comments	array<Comment>	Une liste de commentaires avec leurs libellés attribués et prédits.
continuation	string	Jeton de pagination pour récupérer le nombre limit suivant de commentaires. S'il n'y a pas d'autres commentaires, ce champ ne sera pas présent dans la réponse.

Où Comment a le format suivant :

Nom	Saisie de texte	Description
comment	object	Objet de commentaire. Le format est décrit dans le Guide de référence des commentaires.
annotations	object	Un objet contenant un seul champ labels.assigned qui est une liste de libellés attribués à ce commentaire. Le format est décrit dans le Référencement des libellés. Remarque : il n’inclura pas les prédictions car ces libellés sont attribués, et non prédits.
predictions	object	Un objet contenant un seul champ labels qui est une liste de libellés prévu pour ce commentaire. Le format est décrit dans le Référencement des libellés.