Find optimizations

GET

/v1/private/optimizations

GET

/api/v1/private/optimizations

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

1 {
2   "page": 1,
3   "size": 1,
4   "total": 1,
5   "content": [
6     {
7       "dataset_name": "Customer Churn Dataset",
8       "objective_name": "Maximize Accuracy",
9       "status": "running",
10       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11       "name": "Hyperparameter Tuning Run 42",
12       "project_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
13       "metadata": {
14         "notes": "Initial tuning phase",
15         "tags": [
16           "churn",
17           "classification"
18         ]
19       },
20       "studio_config": {
21         "dataset_name": "Customer Churn Dataset",
22         "prompt": {
23           "messages": [
24             {
25               "role": "system",
26               "content": "Optimize model parameters for best accuracy on churn prediction."
27             }
28           ]
29         },
30         "llm_model": {
31           "model": "gpt-4-opik",
32           "parameters": {
33             "max_tokens": 512,
34             "temperature": 0.7
35           }
36         },
37         "evaluation": {
38           "metrics": [
39             {
40               "type": "accuracy",
41               "parameters": {
42                 "average": "macro"
43               }
44             }
45           ]
46         },
47         "optimizer": {
48           "type": "bayesian",
49           "parameters": {
50             "init_points": 5,
51             "n_iter": 25
52           }
53         }
54       },
55       "error_info": {
56         "exception_type": "",
57         "traceback": "",
58         "message": ""
59       },
60       "dataset_id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
61       "num_trials": 30,
62       "feedback_scores": [
63         {
64           "name": "user_satisfaction",
65           "value": 4.5
66         }
67       ],
68       "experiment_scores": [
69         {
70           "name": "validation_accuracy",
71           "value": 0.87
72         }
73       ],
74       "created_at": "2024-01-15T09:30:00Z",
75       "created_by": "alice@example.com",
76       "last_updated_at": "2024-01-20T15:45:00Z",
77       "last_updated_by": "bob@example.com",
78       "baseline_objective_score": 0.75,
79       "best_objective_score": 0.89,
80       "baseline_duration": 120.5,
81       "best_duration": 95.3,
82       "baseline_cost": 50,
83       "best_cost": 40,
84       "total_optimization_cost": 150
85     }
86   ],
87   "sortableBy": [
88     "created_at",
89     "status",
90     "best_objective_score"
91   ]
92 }

Find optimizations

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

dataset_idstringOptionalformat: "uuid"

namestringOptional

dataset_namestringOptional

dataset_deletedbooleanOptional

project_idstringOptionalformat: "uuid"

filtersstringOptional

Response

Optimizations resource

pageintegerOptional

sizeintegerOptional

totallongOptional

contentlist of objectsOptional

sortableBylist of stringsOptional

Errors

400

Bad Request Error