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 '{
>   "agent_name": "NemoAgent",
>   "agent_version": "v2.3.1",
>   "dataset_name": "ImageNet-2024"
> }'

1 {
2   "id": "exp-123e4567-e89b-12d3-a456-426614174000",
3   "name": "experiment_alpha_2024",
4   "workspace": "research_team_42",
5   "agent_name": "NemoAgent",
6   "agent_version": "v2.3.1",
7   "dataset_name": "ImageNet-2024",
8   "experiment_group_id": "group-987f6543-e21b-45d3-b789-123456789abc",
9   "dataset_version": "v1.0.0",
10   "source_link": "https://nemo-platform.example.com/experiments/exp-123e4567-e89b-12d3-a456-426614174000",
11   "metadata": {},
12   "description": "Evaluation of NemoAgent performance on ImageNet-2024 dataset.",
13   "summary": "The experiment showed a 5% improvement in accuracy over the previous version.",
14   "created_at": "2024-01-15T09:30:00Z",
15   "updated_at": "2024-01-15T09:30:00Z",
16   "evaluator_names": [
17     "accuracy_evaluator",
18     "latency_evaluator"
19   ],
20   "model_names": [
21     "resnet50",
22     "efficientnet_b0"
23   ],
24   "aggregate_scores": {},
25   "run_count": 12,
26   "cost_usd": {
27     "sum": 125.75,
28     "mean": 10.48,
29     "median": 10.5,
30     "p90": 12,
31     "p95": 13,
32     "p99": 15,
33     "count": 12
34   },
35   "latency_ms": {
36     "sum": 36000,
37     "mean": 3000,
38     "median": 2950,
39     "p90": 3500,
40     "p95": 3700,
41     "p99": 4000,
42     "count": 12
43   }
44 }

Path parameters

workspacestringRequired

namestringRequired

Request

This endpoint expects an object.

namestringRequired

Producer-supplied, workspace-unique experiment id.

agent_namestringRequired

Name of the agent under test.

agent_versionstringRequired

Version of the agent under test.

dataset_namestringRequired

Producer-supplied dataset name.

experiment_group_idstringOptional

Entity id of the owning ExperimentGroup; optional. Soft reference, not validated.

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

agent_namestring

agent_versionstring

dataset_namestring

experiment_group_idstring

Entity id of the owning ExperimentGroup; null when ungrouped. Soft reference, not validated.

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.

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