Create dataset items from spans | Opik Documentation

POST/v1/private/datasets/{dataset_id}/items/from-spansCreate dataset items from spans

Create dataset items from spans with enriched metadata

Parameters

dataset_idstring · uuidpathrequired

Request body

application/json

objectCreateDatasetItemsFromSpansRequest

enrichment_optionsobjectrequired

Options for enriching span data

Show child attributes

includeCommentsboolean

includeFeedbackScoresboolean

includeMetadataboolean

includeTagsboolean

includeUsageboolean

evaluatorsarray of object

Optional evaluators to apply to the created items

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

field_mappingsobject

Optional mapping of dataset item field name to a path into the span, e.g. 'input.input_text'. Takes precedence over the fields produced by enrichment_options. Ignored for test suite datasets.

span_idsarray of string · uuidrequired

Set of span IDs to add to the dataset

minItems 1 · uniqueItems true

Show child attributes

minItems 1 · uniqueItems true

Example request

{
  "enrichment_options": {
    "includeComments": true,
    "includeFeedbackScores": true,
    "includeMetadata": true,
    "includeTags": true,
    "includeUsage": true
  },
  "evaluators": [
    {
      "config": {},
      "name": "string",
      "type": "code_metric"
    }
  ],
  "execution_policy": {
    "pass_threshold": 0,
    "runs_per_item": 0
  },
  "field_mappings": {
    "additionalProp1": "string"
  },
  "span_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Responses

Examples

dataset_idrequiredpath parameter

curl -X POST 'http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/items/from-spans' \
  -H 'Content-Type: application/json' \
  -d '{"enrichment_options":{"includeComments":true,"includeFeedbackScores":true,"includeMetadata":true,"includeTags":true,"includeUsage":true},"evaluators":[{"config":{},"name":"string","type":"code_metric"}],"execution_policy":{"pass_threshold":0,"runs_per_item":0},"field_mappings":{"additionalProp1":"string"},"span_ids":["00000000-0000-0000-0000-000000000000"]}'

const response = await fetch('http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/items/from-spans', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"enrichment_options":{"includeComments":true,"includeFeedbackScores":true,"includeMetadata":true,"includeTags":true,"includeUsage":true},"evaluators":[{"config":{},"name":"string","type":"code_metric"}],"execution_policy":{"pass_threshold":0,"runs_per_item":0},"field_mappings":{"additionalProp1":"string"},"span_ids":["00000000-0000-0000-0000-000000000000"]}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/items/from-spans', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"enrichment_options\":{\"includeComments\":true,\"includeFeedbackScores\":true,\"includeMetadata\":true,\"includeTags\":true,\"includeUsage\":true},\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"field_mappings\":{\"additionalProp1\":\"string\"},\"span_ids\":[\"00000000-0000-0000-0000-000000000000\"]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/items/from-spans",
    headers={"Content-Type": "application/json"},
    data='{"enrichment_options":{"includeComments":true,"includeFeedbackScores":true,"includeMetadata":true,"includeTags":true,"includeUsage":true},"evaluators":[{"config":{},"name":"string","type":"code_metric"}],"execution_policy":{"pass_threshold":0,"runs_per_item":0},"field_mappings":{"additionalProp1":"string"},"span_ids":["00000000-0000-0000-0000-000000000000"]}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"enrichment_options":{"includeComments":true,"includeFeedbackScores":true,"includeMetadata":true,"includeTags":true,"includeUsage":true},"evaluators":[{"config":{},"name":"string","type":"code_metric"}],"execution_policy":{"pass_threshold":0,"runs_per_item":0},"field_mappings":{"additionalProp1":"string"},"span_ids":["00000000-0000-0000-0000-000000000000"]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/items/from-spans", 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/00000000-0000-0000-0000-000000000000/items/from-spans");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"enrichment_options\":{\"includeComments\":true,\"includeFeedbackScores\":true,\"includeMetadata\":true,\"includeTags\":true,\"includeUsage\":true},\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"field_mappings\":{\"additionalProp1\":\"string\"},\"span_ids\":[\"00000000-0000-0000-0000-000000000000\"]}");
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/00000000-0000-0000-0000-000000000000/items/from-spans"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"enrichment_options\":{\"includeComments\":true,\"includeFeedbackScores\":true,\"includeMetadata\":true,\"includeTags\":true,\"includeUsage\":true},\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"field_mappings\":{\"additionalProp1\":\"string\"},\"span_ids\":[\"00000000-0000-0000-0000-000000000000\"]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/items/from-spans")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"enrichment_options\":{\"includeComments\":true,\"includeFeedbackScores\":true,\"includeMetadata\":true,\"includeTags\":true,\"includeUsage\":true},\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"field_mappings\":{\"additionalProp1\":\"string\"},\"span_ids\":[\"00000000-0000-0000-0000-000000000000\"]}"
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.Post, "http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/items/from-spans");
request.Content = new StringContent("{\"enrichment_options\":{\"includeComments\":true,\"includeFeedbackScores\":true,\"includeMetadata\":true,\"includeTags\":true,\"includeUsage\":true},\"evaluators\":[{\"config\":{},\"name\":\"string\",\"type\":\"code_metric\"}],\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"field_mappings\":{\"additionalProp1\":\"string\"},\"span_ids\":[\"00000000-0000-0000-0000-000000000000\"]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)