Skip to main content
Send top-level names from the inferred fields list. Creates dataset fields with inferred JSON Schemas and copies their values from uploaded rows. Future file uploads populate them too. Splits and slices that read these fields are blocked until copying finishes.

Signature

Method signature on client.datasets:

Parameters

string
required
Dataset ID with prefix ds..
string[]
required
Top-level fields of the uploaded rows to add as dataset fields, as the inferred fields name them. Each becomes a dataset field with the JSON schema inferred from the uploaded rows.

Returns

Promise<DatasetField[]> Dataset fields created by this request. Returns an array. Each item has these fields:
DatasetFieldId
required
Dataset field ID with prefix df..
string
required
Name of the dataset field.
string | null
required
Description of the field, or null when none is set.
JsonSchema
required
JSON Schema that values in this field must satisfy.See the HTTP endpoint for the supported JSON Schema fields.
boolean
required
True when this field is excluded from pipeline input bindings. The field is still included in dataset field responses.
object | null
required
Set when this is a split field: each row’s value names its part.
DatasetFieldOperation[]
required
Operations currently writing to this field. A split or slice that reads the field is rejected while a blocking operation runs.
string
required
Time the field was created, as an ISO 8601 timestamp.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: POST /datasets/{datasetId}/fields/from-uploaded.