Stream experiments | Opik Documentation

POST/v1/private/experiments/streamStream experiments

Stream experiments

Request body

application/json

objectExperimentStreamRequest_Public

last_retrieved_idstring · uuid

limitinteger · int32

maximum 2000 · minimum 1

namestringrequired

minLength 1

project_namestring

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

Example request

{
  "last_retrieved_id": "00000000-0000-0000-0000-000000000000",
  "limit": 0,
  "name": "string",
  "project_name": "string"
}

Responses

array of string

maxItems 2000

Show array items

anyOf · 2 options

Option 1objectExperiment_Public

assertion_scoresarray of object

Per-assertion average pass rates for test suite experiments. Null for regular experiments.

Show child attributes

Show array items

Per-assertion average pass rates for test suite experiments. Null for regular experiments.

namestringrequired

minLength 1

valuenumberrequired

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_idstring · uuid

dataset_item_countinteger · int64

dataset_namenull | stringrequired

minLength 1

dataset_version_idstring · uuid

ID of the dataset version this experiment is linked to. If not provided at creation, experiment will be automatically linked to the latest version.

dataset_version_summaryobject

Summary of the latest dataset version

Show child attributes

change_descriptionstring

Description of changes in this version

idstring · uuid

Unique identifier of the version

tagsarray of string

Tags associated with this version

uniqueItems true

Show child attributes

uniqueItems true

version_hashstring

Hash of the version content

version_namestring

Sequential version name formatted as 'v1', 'v2', etc.

durationobject

Show child attributes

p50number

p90number

p99number

evaluation_methodstring

one of "dataset", "evaluation_suite"

experiment_scoresarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

valuenumberrequired

feedback_scoresarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

valuenumberrequired

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

metadataobject

Show child attributes

anyOf · 3 options

Option 1object

Option 2array of object

Option 3string

namestring

optimization_idstring · uuid

pass_ratenumber

Pass rate for test suite experiments (0.0-1.0). Null for regular experiments.

passed_countinteger · int64

Number of items that passed for test suite experiments. Null for regular experiments.

project_idstring · uuid

Project ID. Takes precedence over project_name when both are provided.

project_namestring

Project name. Creates project if it doesn't exist. Ignored when project_id is provided.

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

prompt_versionobject

Show child attributes

commitstring

prompt_idstring · uuid

prompt_namestring

prompt_version_idstring · uuid

prompt_versionsarray of object

Show child attributes

Items: PromptVersionLink_Public ↑

statusstring

one of "running", "completed", "cancelled"

tagsarray of string

maxItems 50 · minItems 0 · uniqueItems true

Show child attributes

maxItems 50 · minItems 0 · uniqueItems true

total_countinteger · int64

Total number of items for test suite experiments. Null for regular experiments.

total_estimated_costnumber

total_estimated_cost_avgnumber

trace_countinteger · int64

typestring

one of "regular", "trial", "mini-batch", "mutation"

usageobject

Option 2objectErrorMessage_Public

codeinteger · int32

detailsstring

messagestring

Example response

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

Examples

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

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

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

import requests

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

package main

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

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

require 'net/http'

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

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