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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dataset_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "version_hash": "a1b2c3d4e5f67890123456789abcdef0",
  "tags": [
    "production",
    "v1.2"
  ],
  "is_latest": true,
  "version_name": "v3",
  "items_total": 1500,
  "items_added": 200,
  "items_modified": 50,
  "items_deleted": 10,
  "change_description": "Added new labeled data and fixed annotation errors",
  "metadata": {},
  "evaluators": [
    {
      "name": "QualityCheckLLM",
      "type": "llm_judge",
      "config": {}
    }
  ],
  "execution_policy": {
    "runs_per_item": 3,
    "pass_threshold": 2
  },
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "alice@example.com",
  "last_updated_at": "2024-04-10T14:45:00Z",
  "last_updated_by": "bob@example.com"
}

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