Conjuntos de dados

Obter todos os conjuntos de dados

/api/v1/datasets

Permissões necessárias: exibir rótulos

• Bash

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

• Nó

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

• Resposta

  {
    "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"
  }

Obter conjuntos de dados por projeto

/api/v1/datasets/<project>

Permissões necessárias: exibir rótulos

Obter um conjunto de dados pelo nome

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

Permissões necessárias: exibir rótulos

• Bash

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

• Nó

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

• Resposta

  {
    "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"
  }

Obter tags de modelo para um conjunto de dados

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

Permissões necessárias: Administrador de modelo

• Bash

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

• Nó

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

• Resposta

  {
    "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"
  }

Criar um conjunto de dados

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

Permissões necessárias: Modificar conjuntos de dados

• 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ó

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

• Resposta

  {
    "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"
  }

Nome	Tipo	Required	Descrição
title	String	não	Título legível por humanos de uma linha para o conjunto de dados.
description	String	não	Uma descrição mais longa do conjunto de dados.
source_ids	array<string>	não	Uma matriz de IDs de origem a ser incluída neste conjunto de dados.
model_family	String	não	A família do modelo de conjunto de dados pode ser inglês ou multilíngue. O padrão é inglês. Para verificar os idiomas que são compatíveis com a família de modelos multilíngues, acesse Origens e conjuntos de dados multilíngues.
has_sentiment	Booleano	não	Se os rótulos no conjunto de dados devem ser aplicados com sentimento. O padrão é verdadeiro.

Atualizar um conjunto de dados

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

Permissões necessárias: administrador de conjuntos de dados

• 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ó

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

• Resposta

  {
    "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"
  }

Nome	Tipo	Required	Descrição
title	String	não	Título legível por humanos de uma linha para o conjunto de dados.
description	String	não	Uma descrição mais longa do conjunto de dados.
source_ids	array<string>	não	Uma matriz de IDs de origem a ser incluída neste conjunto de dados.

Excluir um conjunto de dados

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

Permissões necessárias: administrador de conjuntos de dados

• Bash

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

• Nó

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

• Resposta

  {
    "status": "ok"
  }

Exportar um conjunto de dados

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

Permissões necessárias: exportar conjuntos de dados

• 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ó

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

• Resposta

  {
    "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"
  }

This route lets you export a dataset. It returns a list of comments with assigned labels and latest available predictions. Other ways to export a dataset are CSV download in the browser and JSONL download via the CLI. For a detailed comparison, check the comparison table.

Formato de solicitação

Nome	Tipo	Required	Descrição
comment_uids	array<string>	não	Uma lista de no máximo 256 UIDs de comentários (no formato de source_id.comment_id). Se fornecido, somente esses comentários serão incluídos na resposta. Nenhum outro filtro pode ser passado com comment_uids.
source_ids	array<string>	não	Uma lista de no máximo 1.024 IDs de origem. Se informada, apenas comentários dessas origens serão incluídos na resposta.
order_by	String	não	Um de created_at ou timestamp. Se fornecido, retorna os comentários classificados pela data de criação da API dos comentários (created_at), ou pelo carimbo de data/hora do comentário definido pelo usuário (timestamp). O padrão é timestamp.
from	String	não	Um carimbo de data/hora ISO-8601. Se fornecido, retorna apenas comentários a partir deste carimbo de data/hora. O campo order_by relacionado controla qual carimbo de data/hora será usado para filtragem.
to	String	não	Um carimbo de data/hora ISO-8601. Se fornecido, retorna apenas comentários até este carimbo de data/hora (inclusivo). O campo order_by relacionado controla qual carimbo de data/hora será usado para filtragem.
continuation	String	não	Token de paginação (fornecido na resposta). Deve ser usado para buscar o próximo número limit de comentários.
limit	Número	não	Número de comentários retornados por resposta, até um máximo de 256. Padrão: 64.

Formato da Resposta

Nome	Tipo	Descrição
comments	array<Comment>	Uma lista de comentários com seus rótulos atribuídos e previstos.
continuation	String	Token de paginação para buscar o próximo número limit de comentários. Se não houver mais comentários, este campo não estará presente na resposta.

Onde Comment tem o seguinte formato:

Nome	Tipo	Descrição
comment	object	Comment object. The format is described in the Comment Reference.
annotations	object	An object containing a single field labels.assigned which is a list of labels assigned to this comment. The format is described in the Labels Reference. Note that it won't include predictions as these labels are assigned, not predicted.
predictions	object	An object containing a single field labels which is a list of labels predicted for this comment. The format is described in the Labels Reference.