Skip to main content

Create Dataset

Create Dataset

POST 
/api/2/auto_eval/dataset/create

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

Request​

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​

Successful operation

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 JobStatus (string)required

    Possible values: [JOB_STATUS_UNSPECIFIED, JOB_STATUS_QUEUED, JOB_STATUS_RUNNING, JOB_STATUS_COMPLETED, JOB_STATUS_CANCELLED, JOB_STATUS_FAILED]

    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 DatasetColumnDType (string)

    Datatypes for a column in a dataset file. We likely don't need everything here, but it's good to be explicit, for example to avoid unknowingly coercing int64 values into int32. Encoding for text is UTF_8 unless indicated otherwise.

    Possible values: [DATASET_COLUMN_D_TYPE_UNSPECIFIED, DATASET_COLUMN_D_TYPE_INT32, DATASET_COLUMN_D_TYPE_INT64, DATASET_COLUMN_D_TYPE_FLOAT32, DATASET_COLUMN_D_TYPE_FLOAT64, DATASET_COLUMN_D_TYPE_STRING, DATASET_COLUMN_D_TYPE_BYTES, DATASET_COLUMN_D_TYPE_ANY]

  • ]

    • labelState

    object

    The state of the latest labeling job for the dataset

    labelingStatus JobStatus (string)required

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

    Possible values: [JOB_STATUS_UNSPECIFIED, JOB_STATUS_QUEUED, JOB_STATUS_RUNNING, JOB_STATUS_COMPLETED, JOB_STATUS_CANCELLED, JOB_STATUS_FAILED]

    promptTemplate stringrequired

    aka user general instructions

    error string

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

Loading...