Get Dataset View

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.

useDatasetsService boolean

filters

object[]

required

Array [

columnName stringrequired

stringCriteria

object

required

operator Operator (string)required

Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_NOT_EQUALS, OPERATOR_CONTAINS, OPERATOR_STARTS_WITH, OPERATOR_ENDS_WITH]

value stringrequired

numericCriteria

object

required

operator Operator (string)required

Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_NOT_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]

intValue integerrequired

floatValue numberrequired

tagsCriteria

object

required

operator Operator (string)required

Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_HAS_ANY, OPERATOR_HAS_ALL, OPERATOR_HAS_NONE]

tags string[]required

timeRangeCriteria

object

required

operator Operator (string)required

Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_BEFORE, OPERATOR_AFTER, OPERATOR_BETWEEN]

timestamp date-timerequired

endTimestamp date-time

]

orderBy string

Column to order results by

orderDirection string

Direction to order results ("asc" or "desc")

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 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]

]

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": "DATASET_COLUMN_D_TYPE_UNSPECIFIED"
      }
    ]
  }
}

Loading...