Batch update dataset items | Opik Documentation

PATCH/v1/private/datasets/items/batchBatch update dataset items

Update multiple dataset items

Request body

application/json

objectDatasetItemBatchUpdate

Request to batch update multiple dataset items

dataset_idstring · uuid

Dataset ID. Required when using 'filters', optional when using 'ids'.

filtersarray of object

Show child attributes

Show array items

Filters to select dataset items to delete within the specified dataset. Must be used with 'dataset_id'. Mutually exclusive with 'item_ids'. Empty array means 'delete all items in the dataset'.

fieldstring

keystring

operatorstring

one of "contains", "not_contains", "starts_with", "ends_with", "=", "!=", ">", ">=", "<", "<=", "is_empty", "is_not_empty", "in", "not_in"

valuestring

idsarray of string · uuid

List of dataset item IDs to update (max 1000). Mutually exclusive with 'filters'.

maxItems 1000 · minItems 1 · uniqueItems true

Show child attributes

maxItems 1000 · minItems 1 · uniqueItems true

merge_tagsboolean

If true, merge tags with existing tags instead of replacing them. Default: false. When using 'filters', this is automatically set to true.

updateobjectrequired

Dataset item update request

Show child attributes

clear_execution_policyboolean

When true, clears the item-level execution policy (falls back to dataset-level)

dataobject

descriptionstring

Dataset item description

evaluatorsarray of object

Evaluators

Show child attributes

Show array items

configobjectrequired

namestringrequired

minLength 1

typestringrequired

one of "llm_judge", "code_metric"

execution_policyobject

Show child attributes

pass_thresholdinteger · int32

maximum 100 · minimum 1

runs_per_iteminteger · int32

maximum 100 · minimum 1

expected_outputstring

Dataset item expected output

pattern (?s)^\s*(\S.*\S|\S)\s*$

inputstring

Dataset item input

pattern (?s)^\s*(\S.*\S|\S)\s*$

metadataobject

tagsarray of string

Responses

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

curl -X PATCH 'http://localhost:5173/api/v1/private/datasets/items/batch' \
  -H 'Content-Type: application/json' \
  -d '{"dataset_id":"00000000-0000-0000-0000-000000000000","filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"ids":["00000000-0000-0000-0000-000000000000"],"merge_tags":true,"update":{"clear_execution_policy":true,"data":{},"description":"string","evaluators":[{"config":{},"name":"string","type":"code_metric"}],"execution_policy":{"pass_threshold":0,"runs_per_item":0},"expected_output":"string","input":"string","metadata":{},"tags":["string"],"tags_to_add":["string"],"tags_to_remove":["string"]}}'

const response = await fetch('http://localhost:5173/api/v1/private/datasets/items/batch', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"dataset_id":"00000000-0000-0000-0000-000000000000","filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"ids":["00000000-0000-0000-0000-000000000000"],"merge_tags":true,"update":{"clear_execution_policy":true,"data":{},"description":"string","evaluators":[{"config":{},"name":"string","type":"code_metric"}],"execution_policy":{"pass_threshold":0,"runs_per_item":0},"expected_output":"string","input":"string","metadata":{},"tags":["string"],"tags_to_add":["string"],"tags_to_remove":["string"]}}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/datasets/items/batch', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":true,\"update\":{\"clear_execution_policy\":true,\"data\":{},\"description\":\"string\",\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"expected_output\":\"string\",\"input\":\"string\",\"metadata\":{},\"tags\":[\"string\"],\"tags_to_add\":[\"string\"],\"tags_to_remove\":[\"string\"]}}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "http://localhost:5173/api/v1/private/datasets/items/batch",
    headers={"Content-Type": "application/json"},
    data='{"dataset_id":"00000000-0000-0000-0000-000000000000","filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"ids":["00000000-0000-0000-0000-000000000000"],"merge_tags":true,"update":{"clear_execution_policy":true,"data":{},"description":"string","evaluators":[{"config":{},"name":"string","type":"code_metric"}],"execution_policy":{"pass_threshold":0,"runs_per_item":0},"expected_output":"string","input":"string","metadata":{},"tags":["string"],"tags_to_add":["string"],"tags_to_remove":["string"]}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"dataset_id":"00000000-0000-0000-0000-000000000000","filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"ids":["00000000-0000-0000-0000-000000000000"],"merge_tags":true,"update":{"clear_execution_policy":true,"data":{},"description":"string","evaluators":[{"config":{},"name":"string","type":"code_metric"}],"execution_policy":{"pass_threshold":0,"runs_per_item":0},"expected_output":"string","input":"string","metadata":{},"tags":["string"],"tags_to_add":["string"],"tags_to_remove":["string"]}}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "http://localhost:5173/api/v1/private/datasets/items/batch", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/datasets/items/batch");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":true,\"update\":{\"clear_execution_policy\":true,\"data\":{},\"description\":\"string\",\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"expected_output\":\"string\",\"input\":\"string\",\"metadata\":{},\"tags\":[\"string\"],\"tags_to_add\":[\"string\"],\"tags_to_remove\":[\"string\"]}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/datasets/items/batch"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":true,\"update\":{\"clear_execution_policy\":true,\"data\":{},\"description\":\"string\",\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"expected_output\":\"string\",\"input\":\"string\",\"metadata\":{},\"tags\":[\"string\"],\"tags_to_add\":[\"string\"],\"tags_to_remove\":[\"string\"]}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/datasets/items/batch")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":true,\"update\":{\"clear_execution_policy\":true,\"data\":{},\"description\":\"string\",\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"expected_output\":\"string\",\"input\":\"string\",\"metadata\":{},\"tags\":[\"string\"],\"tags_to_add\":[\"string\"],\"tags_to_remove\":[\"string\"]}}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "http://localhost:5173/api/v1/private/datasets/items/batch");
request.Content = new StringContent("{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":true,\"update\":{\"clear_execution_policy\":true,\"data\":{},\"description\":\"string\",\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"expected_output\":\"string\",\"input\":\"string\",\"metadata\":{},\"tags\":[\"string\"],\"tags_to_add\":[\"string\"],\"tags_to_remove\":[\"string\"]}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

{
  "code": 0,
  "details": "string",
  "message": "string"
}