Update Experiment

PUT

https://host.com/apis/intake/v2/workspaces/:workspace/experiments/:name

PUT

/apis/intake/v2/workspaces/:workspace/experiments/:name

$ curl -X PUT https://host.com/apis/intake/v2/workspaces/workspace/experiments/name \
>      -H "Content-Type: application/json" \
>      -d '{
>   "experiment_group_id": "group-12345",
>   "dataset_name": "customer-churn-data"
> }'

1 {
2   "id": "exp-67890",
3   "name": "experiment-alpha-2024",
4   "workspace": "marketing-analytics",
5   "experiment_group_id": "group-12345",
6   "dataset_name": "customer-churn-data",
7   "dataset_version": "v2.3.1",
8   "source_link": "https://github.com/nemo-platform/experiments/alpha-2024",
9   "metadata": {},
10   "description": "Experiment to evaluate churn prediction models on Q1 customer data.",
11   "summary": "Random forest model outperformed baseline with 85% accuracy.",
12   "created_at": "2024-01-15T09:30:00Z",
13   "updated_at": "2024-01-15T09:30:00Z",
14   "evaluator_names": [
15     "accuracy",
16     "f1_score"
17   ],
18   "model_names": [
19     "random_forest",
20     "logistic_regression"
21   ],
22   "agent_names": [
23     "nemo-agent-v1"
24   ],
25   "agent_versions": [
26     "1.4.2"
27   ],
28   "aggregate_scores": {},
29   "run_count": 42,
30   "cost_usd": {
31     "sum": 125.75,
32     "mean": 2.99,
33     "median": 2.85,
34     "p90": 4.5,
35     "p95": 5,
36     "p99": 6.2,
37     "count": 42
38   },
39   "latency_ms": {
40     "sum": 84000,
41     "mean": 2000,
42     "median": 1950,
43     "p90": 3000,
44     "p95": 3500,
45     "p99": 4000,
46     "count": 42
47   }
48 }

Path parameters

workspacestringRequired

namestringRequired

Request

This endpoint expects an object.

namestringRequired

Producer-supplied, workspace-unique experiment id.

experiment_group_idstringRequired

Entity id of the owning ExperimentGroup. Required — the group must already exist.

dataset_namestringRequired

Producer-supplied dataset name.

dataset_versionstringOptional

Producer-supplied dataset version.

source_linkstringOptionalformat: "uri">=1 character

Optional URL for the source experiment.

metadatamap from strings to anyOptional

Free-form producer metadata.

descriptionstringOptional

Human-readable description.

summarystringOptional

Human-authored summary of results.

Response

Successful Response

idstring

namestring

workspacestring

experiment_group_idstring

Entity id of the owning ExperimentGroup. Required for every Experiment.

dataset_namestring

dataset_versionstring

source_linkstringformat: "uri">=1 character

metadatamap from strings to any

descriptionstring

summarystring

created_atdatetime

updated_atdatetime

evaluator_nameslist of strings

model_nameslist of strings

Distinct model names observed across ingested sessions for this experiment.

agent_nameslist of strings

Distinct agent names observed across ingested sessions for this experiment.

agent_versionslist of strings

Distinct agent versions observed across ingested sessions for this experiment.

aggregate_scoresmap from strings to objects

run_countintegerDefaults to 0

Number of distinct ingested experiment sessions; one session is treated as one run.

cost_usdobject

Aggregate statistics over evaluator scores or session-level metric values.

latency_msobject

Aggregate statistics over evaluator scores or session-level metric values.

Errors

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error