Create Dataset

Create Dataset

POST 
/api/2/auto_eval/dataset/create

Create a new Dataset. Use UploadDatasetFile to upload files to the dataset.

Request

application/json

Body

name string

Human-readable name for the dataset, if one exists.

description string

Human-readable description of the dataset, if one exists.

isFewShotExamples boolean

PseudoLabel job fields.

isActiveLabels boolean
projectId string

The project to add the new dataset to

Responses

200

Successful operation

application/json

Schema

Schema

dataset

object

required

A Dataset in the most basic sense: metadata and ownership, but nothing tied to its data.

id stringrequired

The ID of the dataset.

createdAt date-timerequired

updatedAt date-timerequired

name string

Human-readable name for the dataset, if one exists.

description string

Human-readable description of the dataset, if one exists.

ownerUserId stringrequired

The ID of the user who owns the dataset.

numRows integerrequired

numCols integerrequired

initializationStatus stringrequired

initializationError string

columns

object[]

required

Array [

id stringrequired

The ID of the dataset file.

createdAt date-timerequired

updatedAt date-timerequired

index integerrequired

Index of the column within the dataset file.

literalName stringrequired

The literal name for the column.

dtype string

]

labelState

object

The state of the latest labeling job for the dataset

labelingStatus stringrequired

The status of the latest general pseudo-labeling job for the dataset

promptTemplate stringrequired

aka user general instructions

error string

if the labeling status is error, this field may contain an error message

Example (from schema)

{
  "dataset": {
    "id": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "name": "string",
    "description": "string",
    "ownerUserId": "string",
    "numRows": 0,
    "numCols": 0,
    "initializationStatus": "string",
    "initializationError": "string",
    "columns": [
      {
        "id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z",
        "index": 0,
        "literalName": "string",
        "dtype": "string"
      }
    ],
    "labelState": {
      "labelingStatus": "string",
      "promptTemplate": "string",
      "error": "string"
    }
  }
}

Loading...