Retrieve dataset version by name

import requests
url = "http://localhost:5173/api/v1/private/datasets/id/versions/retrieve"
payload = { "version_name": "v1" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "string",
  "dataset_id": "string",
  "version_hash": "string",
  "tags": [
    "string"
  ],
  "is_latest": true,
  "version_name": "string",
  "items_total": 1,
  "items_added": 1,
  "items_modified": 1,
  "items_deleted": 1,
  "change_description": "string",
  "metadata": {},
  "evaluators": [
    {
      "name": "string",
      "type": "llm_judge",
      "config": {}
    }
  ],
  "execution_policy": {
    "runs_per_item": 1,
    "pass_threshold": 1
  },
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string"
}

Get a specific version by its version name (e.g., ‘v1’, ‘v373’). This is more efficient than paginating through all versions for large datasets.

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

version_namestringRequiredformat: "^v\d+$">=1 character

Version name in format ‘vN’ (e.g., ‘v1’, ‘v373’)

Response

Dataset version

idstring or nullRead-onlyformat: "uuid"

dataset_idstring or nullRead-onlyformat: "uuid"

version_hashstring or nullRead-only

tagslist of strings or nullRead-only

is_latestboolean or nullRead-only

Indicates whether this is the latest version of the dataset

version_namestring or nullRead-only

Sequential version name formatted as 'v1', 'v2', etc.

items_totalinteger or nullRead-only

Total number of items in this version

items_addedinteger or nullRead-only

Number of items added since last version

items_modifiedinteger or nullRead-only

Number of items modified since last version

items_deletedinteger or nullRead-only

Number of items deleted since last version

change_descriptionstring or nullRead-only

metadatamap from strings to strings or nullRead-only

evaluatorslist of objects or nullRead-only

Default evaluators for items in this version

execution_policyobject or nullRead-only

Default execution policy for items in this version

created_atstring or nullRead-onlyformat: "date-time"

created_bystring or nullRead-only

last_updated_atstring or nullRead-onlyformat: "date-time"

last_updated_bystring or nullRead-only

Path parameters

Request

Response

Errors