Get Dataset View

POST 
/api/2/auto_eval/dataset/get_view

Get a paginated view of the data within a Dataset.

Request

application/json

Body

datasetId stringrequired

The ID of the dataset from which to retrieve content. When specified, gets data from the current file in the dataset.

datasetFileId stringrequired

The ID of the (pinned) dataset file from which to retrieve content. Requests iterating over pages of results are recommended to use this pinned identifier after the first page in order to prevent any effects from a dataset changing between the queries.

after integer

Pagination: The index, by row-order, after which to query results.

limit integer

Pagination: The maximum number of results to return on this page.

Responses

200

Successful operation

application/json

Schema

Schema

datasetId stringrequired
datasetFileId stringrequired

datasetView

object

required

numRows integerrequired

numCols integerrequired

data

object[]

required

Array [

id stringrequired

rowValues object[]required

]

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

]

Example (from schema)

{
  "datasetId": "string",
  "datasetFileId": "string",
  "datasetView": {
    "numRows": 0,
    "numCols": 0,
    "data": [
      {
        "id": "string",
        "rowValues": [
          {}
        ]
      }
    ],
    "columns": [
      {
        "id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z",
        "index": 0,
        "literalName": "string",
        "dtype": "string"
      }
    ]
  }
}

Loading...