Experiments

Conclude a client-driven Experiment

Sets the Experiment completed only when every Slot has a terminal execution record. Otherwise it returns 409 naming how many Slots are still missing.

post/api/{org_id}/experiments/{experiment_id}/finalize

Request

Base URL
https://api.openobserve.ai (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/:org_id/experiments/:experiment_id/finalize/post.ts
A function with typed inputs. Its response is checked against the schema.

org_idstring required

Organization name

experiment_idstring required

Experiment ID

createdAtinteger required

createdBystring required

datasetIdstring required

datasetNamestring nullable

Resolved from the Dataset the experiment pinned, so callers do not have to fetch the Dataset list just to label a run. None when it was deleted.

datasetVersioninteger required

The pinned global_version: the row cut every Slot reads.

datasetWriteVersioninteger required

The Dataset version to display for that pin: one per write request.

deadlineAtinteger required

descriptionstring nullable

executionCompletedAtinteger nullable

executionStatus'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required

executionStatusReasonstring nullable

idstring required

idempotencyKeystring nullable

isBaselineboolean required

The organization's Baseline for this Dataset. At most one Experiment per organization and Dataset carries it.

lifecycleVersioninteger required

metadataunknown

namestring required

orgIdstring required

promptContentHashstring nullable

promptIdstring nullable

promptNamestring nullable

promptVersioninteger nullable

retryCountinteger required

trialCountinteger required

No recorded changes to this operation across all 1 revision of this API.