client.datasets.getInferredFields()

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

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

const inferredFields = await client.datasets.getInferredFields({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
});
console.log(inferredFields);

{
  "fields": [
    {
      "name": "<string>",
      "jsonPath": "<string>",
      "depth": 0,
      "jsonSchema": {}
    }
  ]
}

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

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

const inferredFields = await client.datasets.getInferredFields({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
});
console.log(inferredFields);

{
  "fields": [
    {
      "name": "<string>",
      "jsonPath": "<string>",
      "depth": 0,
      "jsonSchema": {}
    }
  ]
}

Returns nested field names, paths, and JSON Schemas inferred from the first file upload that passes validation. Later uploads are checked against that schema and do not refresh it. The fields array is empty until this inference completes.

Signature

Method signature on client.datasets:

getInferredFields(args: {
  datasetId: string;
}): Promise<{ fields: InferredField[] }>;

Parameters

string

required

Dataset ID with prefix ds..

Returns

Promise<{ fields: InferredField[] }>

InferredField[]

required

Nested fields inferred from the first validated dataset upload.

Show Fields

string

required

The field name at this path.

string

required

The JSONPath locating this field in a dataset item.

number

required

The nesting depth of this field.

JsonSchema

required

The JSON Schema inferred for values at this path.See the HTTP endpoint for the supported JSON Schema fields.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses:

Status	Description
404	Dataset not found
429	Rate limit exceeded

HTTP endpoint: GET /datasets/{datasetId}/inferred-fields.

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

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

const inferredFields = await client.datasets.getInferredFields({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
});
console.log(inferredFields);

{
  "fields": [
    {
      "name": "<string>",
      "jsonPath": "<string>",
      "depth": 0,
      "jsonSchema": {}
    }
  ]
}

Reference

TypeScript SDK

CLI

HTTP API

client.datasets.getInferredFields()

Signature

Parameters

Returns

Errors