Restore dataset to a previous version

POST

/v1/private/datasets/:id/versions/restore

POST

/api/v1/private/datasets/:id/versions/restore

$ curl -X POST http://localhost:5173/api/v1/private/datasets/id/versions/restore \
>      -H "Content-Type: application/json" \
>      -d '{
>   "version_ref": "string"
> }'

1 {
2   "id": "string",
3   "dataset_id": "string",
4   "version_hash": "string",
5   "tags": [
6     "string"
7   ],
8   "is_latest": true,
9   "version_name": "string",
10   "items_total": 1,
11   "items_added": 1,
12   "items_modified": 1,
13   "items_deleted": 1,
14   "change_description": "string",
15   "metadata": {},
16   "evaluators": [
17     {
18       "name": "string",
19       "type": "llm_judge",
20       "config": {}
21     }
22   ],
23   "execution_policy": {
24     "runs_per_item": 1,
25     "pass_threshold": 1
26   },
27   "created_at": "2024-01-15T09:30:00Z",
28   "created_by": "string",
29   "last_updated_at": "2024-01-15T09:30:00Z",
30   "last_updated_by": "string"
31 }

Restores the dataset to a previous version state by creating a new version with items copied from the specified version. If the version is already the latest, returns it as-is (no-op).

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

version_refstringRequired>=1 character

Version hash or tag to restore from

Response

Version restored successfully

idstringOptionalRead-onlyformat: "uuid"

dataset_idstringOptionalRead-onlyformat: "uuid"

version_hashstringOptionalRead-only

tagslist of stringsOptionalRead-only

is_latestbooleanOptionalRead-only

Indicates whether this is the latest version of the dataset

version_namestringOptionalRead-only

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

items_totalintegerOptionalRead-only

Total number of items in this version

items_addedintegerOptionalRead-only

Number of items added since last version

items_modifiedintegerOptionalRead-only

Number of items modified since last version

items_deletedintegerOptionalRead-only

Number of items deleted since last version

change_descriptionstringOptionalRead-only

metadatamap from strings to stringsOptionalRead-only

evaluatorslist of objectsOptionalRead-only

Default evaluators for items in this version

execution_policyobjectOptionalRead-only

Default execution policy for items in this version

created_atdatetimeOptionalRead-only

created_bystringOptionalRead-only

last_updated_atdatetimeOptionalRead-only

last_updated_bystringOptionalRead-only

Errors

404

Not Found Error

409

Conflict Error