Stream experiment items | Opik Documentation

POST/v1/private/experiments/items/streamStream experiment items

Stream experiment items

Request body

application/json

objectExperimentItemStreamRequest

experiment_namestringrequired

minLength 1

last_retrieved_idstring · uuid

limitinteger · int32

maximum 2000 · minimum 1

project_namestring

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

truncateboolean

Truncate image included in either input, output or metadata

default true

Example request

{
  "experiment_name": "string",
  "last_retrieved_id": "00000000-0000-0000-0000-000000000000",
  "limit": 0,
  "project_name": "string",
  "truncate": true
}

Responses

array of string

maxItems 2000

Show array items

anyOf · 2 options

Option 1objectExperimentItem

assertion_resultsarray of object

Show child attributes

Show array items

passedboolean

reasonstring

valuestring

commentsarray of object

Show child attributes

Show array items

created_atstring · date-time

created_bystring

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

source_queue_idstring · uuid

textstringrequired

minLength 1

created_atstring · date-time

created_bystring

dataset_item_idstring · uuidrequired

descriptionstring

durationnumber · double

execution_policyobject

Show child attributes

pass_thresholdinteger · int32

maximum 100 · minimum 1

runs_per_iteminteger · int32

maximum 100 · minimum 1

experiment_idstring · uuidrequired

feedback_scoresarray of object

Show child attributes

Show array items

category_namestring

created_atstring · date-time

created_bystring

last_updated_atstring · date-time

last_updated_bystring

namestringrequired

minLength 1

reasonstring

sourcestringrequired

one of "ui", "sdk", "online_scoring"

source_queue_idstring · uuid

valuenumberrequired

maximum 1000000000 · minimum -1000000000

value_by_authorobject

idstring · uuid

inputobject

Show child attributes

anyOf · 3 options

Option 1object

Option 2array of object

Option 3string

last_updated_atstring · date-time

last_updated_bystring

outputobjectJsonListString ↑

project_idstring · uuid

project_namestring

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

statusstring

one of "passed", "failed"

total_estimated_costnumber

trace_idstring · uuidrequired

trace_metadataobjectJsonListString ↑

trace_visibility_modestring

one of "default", "hidden"

usageobject

Option 2objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

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

Examples

curl -X POST 'http://localhost:5173/api/v1/private/experiments/items/stream' \
  -H 'Content-Type: application/json' \
  -d '{"experiment_name":"string","last_retrieved_id":"00000000-0000-0000-0000-000000000000","limit":0,"project_name":"string","truncate":true}'

const response = await fetch('http://localhost:5173/api/v1/private/experiments/items/stream', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"experiment_name":"string","last_retrieved_id":"00000000-0000-0000-0000-000000000000","limit":0,"project_name":"string","truncate":true}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/experiments/items/stream', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"experiment_name\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"limit\":0,\"project_name\":\"string\",\"truncate\":true}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/experiments/items/stream",
    headers={"Content-Type": "application/json"},
    data='{"experiment_name":"string","last_retrieved_id":"00000000-0000-0000-0000-000000000000","limit":0,"project_name":"string","truncate":true}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"experiment_name":"string","last_retrieved_id":"00000000-0000-0000-0000-000000000000","limit":0,"project_name":"string","truncate":true}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/experiments/items/stream", 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/experiments/items/stream");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"experiment_name\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"limit\":0,\"project_name\":\"string\",\"truncate\":true}");
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/experiments/items/stream"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"experiment_name\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"limit\":0,\"project_name\":\"string\",\"truncate\":true}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/experiments/items/stream")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"experiment_name\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"limit\":0,\"project_name\":\"string\",\"truncate\":true}"
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/experiments/items/stream");
request.Content = new StringContent("{\"experiment_name\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"limit\":0,\"project_name\":\"string\",\"truncate\":true}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

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