Get experiment by id

GET

/v1/private/experiments/:id

GET

/api/v1/private/experiments/:id

$ curl http://localhost:5173/api/v1/private/experiments/id \
>      -H "Content-Type: application/json"

1 {
2   "dataset_name": "Customer Churn Dataset",
3   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4   "dataset_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
5   "project_id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
6   "project_name": "Churn Prediction Project",
7   "name": "Experiment 42 - Random Forest",
8   "metadata": {
9     "hyperparameters": {
10       "max_depth": 10,
11       "n_estimators": 100
12     },
13     "model_type": "random_forest"
14   },
15   "tags": [
16     "random-forest",
17     "churn",
18     "2024"
19   ],
20   "type": "regular",
21   "evaluation_method": "dataset",
22   "optimization_id": "9a7b3c1d-4f2e-4a6a-9f3b-2d8e5f7a1c3b",
23   "feedback_scores": [
24     {
25       "name": "accuracy",
26       "value": 0.87
27     }
28   ],
29   "comments": [
30     {
31       "text": "Initial run with default parameters.",
32       "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
33       "source_queue_id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
34       "created_at": "2024-01-15T09:30:00Z",
35       "last_updated_at": "2024-01-15T09:30:00Z",
36       "created_by": "alice@example.com",
37       "last_updated_by": "alice@example.com"
38     }
39   ],
40   "trace_count": 1500,
41   "dataset_item_count": 10000,
42   "created_at": "2024-01-15T09:30:00Z",
43   "duration": {
44     "p50": 120.5,
45     "p90": 180,
46     "p99": 240
47   },
48   "total_estimated_cost": 35.75,
49   "total_estimated_cost_avg": 0.0238,
50   "usage": {
51     "cpu_hours": 12.5,
52     "gpu_hours": 3.2
53   },
54   "last_updated_at": "2024-01-20T15:45:00Z",
55   "created_by": "alice@example.com",
56   "last_updated_by": "bob@example.com",
57   "status": "running",
58   "experiment_scores": [
59     {
60       "name": "f1_score",
61       "value": 0.82
62     }
63   ],
64   "prompt_version": {
65     "prompt_version_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
66     "commit": "a1b2c3d4e5f6g7h8i9j0",
67     "prompt_id": "c9bf9e57-1685-4c89-bafb-ff5af830be8a",
68     "prompt_name": "Initial Prompt"
69   },
70   "prompt_versions": [
71     {
72       "prompt_version_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
73       "commit": "a1b2c3d4e5f6g7h8i9j0",
74       "prompt_id": "c9bf9e57-1685-4c89-bafb-ff5af830be8a",
75       "prompt_name": "Initial Prompt"
76     },
77     {
78       "prompt_version_id": "e7d1a3f4-9c2b-4a1d-8f3e-2b7c9d5e6f7a",
79       "commit": "b2c3d4e5f6g7h8i9j0a1",
80       "prompt_id": "d4e5f6g7-h8i9-j0a1-b2c3-d4e5f6g7h8i9",
81       "prompt_name": "Updated Prompt"
82     }
83   ],
84   "dataset_version_id": "2c1f3e4d-5b6a-7c8d-9e0f-1a2b3c4d5e6f",
85   "dataset_version_summary": {
86     "id": "2c1f3e4d-5b6a-7c8d-9e0f-1a2b3c4d5e6f",
87     "version_hash": "a1b2c3d4e5f67890abcdef1234567890",
88     "version_name": "v3",
89     "change_description": "Added new customer segments and updated labels.",
90     "tags": [
91       "production",
92       "2024-01"
93     ]
94   },
95   "pass_rate": 0.95,
96   "passed_count": 950,
97   "total_count": 1000,
98   "assertion_scores": [
99     {
100       "name": "precision",
101       "value": 0.88
102     },
103     {
104       "name": "recall",
105       "value": 0.85
106     }
107   ]
108 }

Get experiment by id

Path parameters

idstringRequiredformat: "uuid"

Response

Experiment resource

dataset_namestring or null>=1 character

idstringOptionalformat: "uuid"

dataset_idstringOptionalRead-onlyformat: "uuid"

project_idstringOptionalformat: "uuid"

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

project_namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"

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

namestringOptional

metadatamap from strings to any or list of objects or stringOptional

tagslist of stringsOptional

typeenumOptional

evaluation_methodenumOptional

optimization_idstringOptionalformat: "uuid"

feedback_scoreslist of objectsOptionalRead-only

commentslist of objectsOptionalRead-only

trace_countlongOptionalRead-only

dataset_item_countlongOptionalRead-only

created_atdatetimeOptionalRead-only

durationobjectOptional

total_estimated_costdoubleOptionalRead-only

total_estimated_cost_avgdoubleOptionalRead-only

usagemap from strings to doublesOptionalRead-only

last_updated_atdatetimeOptionalRead-only

created_bystringOptionalRead-only

last_updated_bystringOptionalRead-only

statusenumOptional

experiment_scoreslist of objectsOptional

prompt_versionobjectOptional

prompt_versionslist of objectsOptional

dataset_version_idstringOptionalformat: "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_summaryobjectOptionalRead-only

Summary of the latest dataset version

pass_ratedoubleOptionalRead-only

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

passed_countlongOptionalRead-only

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

total_countlongOptionalRead-only

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

assertion_scoreslist of objectsOptionalRead-only

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

Errors

404

Not Found Error