List Datasets

List Datasets

POST 
/api/2/auto_eval/dataset/list

List Datasets.

Request

application/json

Body

filters

object

Filter listed datasets by ALL filters specified

query string

search query substring match for name and description

projectId string

filter datasets associated with the project

Responses

200

Successful operation

application/json

Schema

Schema

datasets

object[]

required

Array [

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

]

totalCount integerrequired

Total count of datasets which can be listed with applicable filters, regardless of page size

Example (from schema)

{
  "datasets": [
    {
      "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": "JOB_STATUS_UNSPECIFIED",
      "initializationError": "string",
      "columns": [
        {
          "id": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z",
          "index": 0,
          "literalName": "string",
          "dtype": "DATASET_COLUMN_D_TYPE_UNSPECIFIED"
        }
      ],
      "labelState": {
        "labelingStatus": "JOB_STATUS_UNSPECIFIED",
        "promptTemplate": "string",
        "error": "string"
      }
    }
  ],
  "totalCount": 0
}

Loading...