List dataset fields

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

for await (const item of client.datasets.listAllFields({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
})) {
  console.log(item);
}

{
  "fields": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "internal": true,
      "jsonSchema": {
        "additionalProperties": true,
        "allOf": [
          "<unknown>"
        ],
        "anyOf": [
          "<unknown>"
        ],
        "const": "<string>",
        "default": "<string>",
        "description": "<string>",
        "enum": [
          "<string>"
        ],
        "examples": [
          "<string>"
        ],
        "exclusiveMaximum": 123,
        "exclusiveMinimum": 123,
        "format": "<string>",
        "items": "<unknown>",
        "maxItems": 4503599627370495,
        "maxLength": 4503599627370495,
        "maximum": 123,
        "minItems": 4503599627370495,
        "minLength": 4503599627370495,
        "minimum": 123,
        "oneOf": [
          "<unknown>"
        ],
        "pattern": "<string>",
        "properties": {},
        "required": [
          "<string>"
        ],
        "title": "<string>",
        "type": "string",
        "uniqueItems": true
      },
      "name": "<string>",
      "operations": [
        {
          "blocking": true,
          "sourceFieldId": "<string>",
          "type": "copy"
        }
      ],
      "split": {
        "error": {
          "code": "too_many_labels",
          "message": "<string>"
        },
        "lastFill": {
          "kept": 4503599627370495,
          "parts": {},
          "placed": 4503599627370495
        },
        "parts": [
          {
            "name": "<string>",
            "roles": [
              "train"
            ]
          }
        ],
        "progress": {
          "placed": 4503599627370495,
          "total": 4503599627370495
        },
        "recipe": {
          "balanceByFieldId": "<string>",
          "seed": 1073741823,
          "shares": [
            {
              "name": "<string>",
              "share": 123
            }
          ]
        },
        "status": "filling"
      }
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 20,
    "offset": 0,
    "total": 42
  }
}

GET

datasets

{datasetId}

fields

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

for await (const item of client.datasets.listAllFields({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
})) {
  console.log(item);
}

{
  "fields": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "internal": true,
      "jsonSchema": {
        "additionalProperties": true,
        "allOf": [
          "<unknown>"
        ],
        "anyOf": [
          "<unknown>"
        ],
        "const": "<string>",
        "default": "<string>",
        "description": "<string>",
        "enum": [
          "<string>"
        ],
        "examples": [
          "<string>"
        ],
        "exclusiveMaximum": 123,
        "exclusiveMinimum": 123,
        "format": "<string>",
        "items": "<unknown>",
        "maxItems": 4503599627370495,
        "maxLength": 4503599627370495,
        "maximum": 123,
        "minItems": 4503599627370495,
        "minLength": 4503599627370495,
        "minimum": 123,
        "oneOf": [
          "<unknown>"
        ],
        "pattern": "<string>",
        "properties": {},
        "required": [
          "<string>"
        ],
        "title": "<string>",
        "type": "string",
        "uniqueItems": true
      },
      "name": "<string>",
      "operations": [
        {
          "blocking": true,
          "sourceFieldId": "<string>",
          "type": "copy"
        }
      ],
      "split": {
        "error": {
          "code": "too_many_labels",
          "message": "<string>"
        },
        "lastFill": {
          "kept": 4503599627370495,
          "parts": {},
          "placed": 4503599627370495
        },
        "parts": [
          {
            "name": "<string>",
            "roles": [
              "train"
            ]
          }
        ],
        "progress": {
          "placed": 4503599627370495,
          "total": 4503599627370495
        },
        "recipe": {
          "balanceByFieldId": "<string>",
          "seed": 1073741823,
          "shares": [
            {
              "name": "<string>",
              "share": 123
            }
          ]
        },
        "status": "filling"
      }
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 20,
    "offset": 0,
    "total": 42
  }
}

Authorizations

Authorization

string

header

required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

datasetId

string

required

Dataset ID with prefix ds..

Pattern: ^ds\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Query Parameters

limit

integer

default:20

Maximum number of results to return; defaults to 20.

Required range: 1 <= x <= 100

offset

integer

default:0

Number of results to skip before this page; defaults to 0.

Required range: 0 <= x <= 9007199254740991

names

string

Comma-separated field names to include; omit to list all fields.

Response

List dataset fields

fields

object[]

required

Nested fields inferred from the first validated dataset upload.

Show child attributes

pagination

object

required

Pagination information for this page.

Show child attributes

Reference

TypeScript SDK

CLI

HTTP API

Authorizations

Path Parameters

Query Parameters

Response