Update dataset version | Opik Documentation

curl -X PATCH http://localhost:5173/api/v1/private/datasets/id/versions/hash/versionHash \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "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"
}

Update a dataset version’s change_description and/or add new tags

curl -X PATCH http://localhost:5173/api/v1/private/datasets/id/versions/hash/versionHash \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "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"
}

Update a dataset version’s change_description and/or add new tags

Path parameters

versionHashstringRequired

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

change_descriptionstringOptional

Optional description of changes in this version

tags_to_addlist of stringsOptional

Optional list of tags to add to this version

Response

Version updated successfully

idstringRead-onlyformat: "uuid"

dataset_idstringRead-onlyformat: "uuid"

version_hashstringRead-only

tagslist of stringsRead-only

is_latestbooleanRead-only

Indicates whether this is the latest version of the dataset

version_namestringRead-only

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

items_totalintegerRead-only

Total number of items in this version

items_addedintegerRead-only

Number of items added since last version

items_modifiedintegerRead-only

Number of items modified since last version

items_deletedintegerRead-only

Number of items deleted since last version

change_descriptionstringRead-only

metadatamap from strings to stringsRead-only

evaluatorslist of objectsRead-only

Default evaluators for items in this version

execution_policyobjectRead-only

Default execution policy for items in this version

created_atdatetimeRead-only

created_bystringRead-only

last_updated_atdatetimeRead-only

last_updated_bystringRead-only

Errors

400

Bad Request Error

404

Not Found Error

409

Conflict Error

$	curl -X PATCH http://localhost:5173/api/v1/private/datasets/id/versions/hash/versionHash \
>	-H "Content-Type: application/json" \
>	-d '{}'

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	}