Edit a dataset item

curl --request PATCH \
  --url https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "base_version": "<string>",
  "inputs": {
    "question": "What is the capital of France?"
  },
  "expected_outputs": {},
  "metadata": {},
  "extras": {},
  "source_name": "<string>",
  "source_id": "<string>"
}
'

import requests

url = "https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}"

payload = {
    "base_version": "<string>",
    "inputs": { "question": "What is the capital of France?" },
    "expected_outputs": {},
    "metadata": {},
    "extras": {},
    "source_name": "<string>",
    "source_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    base_version: '<string>',
    inputs: {question: 'What is the capital of France?'},
    expected_outputs: {},
    metadata: {},
    extras: {},
    source_name: '<string>',
    source_id: '<string>'
  })
};

fetch('https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'base_version' => '<string>',
    'inputs' => [
        'question' => 'What is the capital of France?'
    ],
    'expected_outputs' => [
        
    ],
    'metadata' => [
        
    ],
    'extras' => [
        
    ],
    'source_name' => '<string>',
    'source_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}"

	payload := strings.NewReader("{\n  \"base_version\": \"<string>\",\n  \"inputs\": {\n    \"question\": \"What is the capital of France?\"\n  },\n  \"expected_outputs\": {},\n  \"metadata\": {},\n  \"extras\": {},\n  \"source_name\": \"<string>\",\n  \"source_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"base_version\": \"<string>\",\n  \"inputs\": {\n    \"question\": \"What is the capital of France?\"\n  },\n  \"expected_outputs\": {},\n  \"metadata\": {},\n  \"extras\": {},\n  \"source_name\": \"<string>\",\n  \"source_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"base_version\": \"<string>\",\n  \"inputs\": {\n    \"question\": \"What is the capital of France?\"\n  },\n  \"expected_outputs\": {},\n  \"metadata\": {},\n  \"extras\": {},\n  \"source_name\": \"<string>\",\n  \"source_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "item": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inputs": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "expected_outputs": {},
      "metadata": {},
      "extras": {},
      "source_name": "<string>",
      "source_id": "<string>"
    },
    "dataset_version": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": 123,
      "tag": "<string>"
    }
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

Evals

Edit a dataset item

Edit one dataset item by appending a revision under a new committed version. Nothing is overwritten and nothing is removed: the previous revision stays readable at every earlier ?version=.

This is a merge, not a replace. A field the request omits keeps its current value; a field the request sends replaces that field wholesale. There is no deep merge inside the JSON buckets — sending inputs replaces the whole inputs object, which is what lets a caller remove a key from it. Note that an omitted field and a field sent as null are different things: null clears the field, except inputs, which cannot be cleared.

A no-op writes nothing. If the resulting content is identical to the item’s current content, nothing is written, no new version is created, and the response is still 200 with the unchanged item. null and empty are normalised before the comparison, so clearing an already-empty field is a no-op too.

base_version is required, for an optimistic-concurrency check: the edit is refused with 409 if any revision of this item has landed above that version. An older base_version is still accepted if this item has not changed since it. A retry of an edit whose response was lost therefore gets a 409; re-read the item to see that it was applied.

PATCH

evals

datasets

{dataset_id}

items

{item_id}

Edit a dataset item

curl --request PATCH \
  --url https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "base_version": "<string>",
  "inputs": {
    "question": "What is the capital of France?"
  },
  "expected_outputs": {},
  "metadata": {},
  "extras": {},
  "source_name": "<string>",
  "source_id": "<string>"
}
'

import requests

url = "https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}"

payload = {
    "base_version": "<string>",
    "inputs": { "question": "What is the capital of France?" },
    "expected_outputs": {},
    "metadata": {},
    "extras": {},
    "source_name": "<string>",
    "source_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    base_version: '<string>',
    inputs: {question: 'What is the capital of France?'},
    expected_outputs: {},
    metadata: {},
    extras: {},
    source_name: '<string>',
    source_id: '<string>'
  })
};

fetch('https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'base_version' => '<string>',
    'inputs' => [
        'question' => 'What is the capital of France?'
    ],
    'expected_outputs' => [
        
    ],
    'metadata' => [
        
    ],
    'extras' => [
        
    ],
    'source_name' => '<string>',
    'source_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}"

	payload := strings.NewReader("{\n  \"base_version\": \"<string>\",\n  \"inputs\": {\n    \"question\": \"What is the capital of France?\"\n  },\n  \"expected_outputs\": {},\n  \"metadata\": {},\n  \"extras\": {},\n  \"source_name\": \"<string>\",\n  \"source_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"base_version\": \"<string>\",\n  \"inputs\": {\n    \"question\": \"What is the capital of France?\"\n  },\n  \"expected_outputs\": {},\n  \"metadata\": {},\n  \"extras\": {},\n  \"source_name\": \"<string>\",\n  \"source_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/evals/datasets/{dataset_id}/items/{item_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"base_version\": \"<string>\",\n  \"inputs\": {\n    \"question\": \"What is the capital of France?\"\n  },\n  \"expected_outputs\": {},\n  \"metadata\": {},\n  \"extras\": {},\n  \"source_name\": \"<string>\",\n  \"source_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "item": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inputs": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "expected_outputs": {},
      "metadata": {},
      "extras": {},
      "source_name": "<string>",
      "source_id": "<string>"
    },
    "dataset_version": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": 123,
      "tag": "<string>"
    }
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dataset_id

string<uuid>

required

Dataset UUID

item_id

string<uuid>

required

Dataset item UUID

Body

application/json

Partial update of one dataset item. Send only the fields you want to change: an omitted field keeps its current value, while a field sent as null clears it (except inputs). An unknown field is a 400. A field that is sent replaces that field wholesale — there is no deep merge inside the JSON buckets.

base_version

required

Optimistic-concurrency check: the version the caller believes it is editing. The edit is refused with 409 if any revision of this item has landed above that version — not "if this is not the dataset's newest version", so an edit to an item that is merely old is not rejected.

inputs

object

Replaces the whole inputs object. Not deep-merged, so this is how a key is removed from it.

Example:

{
  "question": "What is the capital of France?"
}

expected_outputs

object | null

Replaces the whole expected_outputs object.

metadata

object | null

Replaces the whole metadata object.

extras

object | null

Replaces the whole extras object.

source_name

string | null

Name of the source for this dataset item.

source_id

string | null

ID of the item in the source.

Response

The item as it reads at the version this edit committed, and that version. For a no-op, the unchanged item and the current version it was compared against. dataset_version.version is safe as base_version only for this item; re-read before editing others.

Response object for standard API responses.

api_version

enum<string>

default:3.0

API version.

Available options:

2.0,

3.0

kind

enum<string>

default:NORMAL

Type of response, indicating a normal response.

Available options:

NORMAL

data

object

Show child attributes

Fiddler Python Client SDK

Fiddler Evals SDK

Fiddler OTel SDK

Fiddler LangGraph SDK

Fiddler LangChain SDK

Fiddler Google ADK SDK

Fiddler Strands Agent SDK

Fiddler OTel JS SDK

Fiddler LangGraph JS SDK

Fiddler LangChain JS SDK

Edit a dataset item

Authorizations

Path Parameters

Body

Response