Get optimization by id

GET

/v1/private/optimizations/:id

GET

/api/v1/private/optimizations/:id

$ curl http://localhost:5173/api/v1/private/optimizations/id

1 {
2   "dataset_name": "string",
3   "objective_name": "string",
4   "status": "running",
5   "id": "string",
6   "name": "string",
7   "project_id": "string",
8   "metadata": {},
9   "studio_config": {
10     "dataset_name": "string",
11     "prompt": {
12       "messages": [
13         {
14           "role": "string",
15           "content": "string"
16         }
17       ]
18     },
19     "llm_model": {
20       "model": "string",
21       "parameters": {}
22     },
23     "evaluation": {
24       "metrics": [
25         {
26           "type": "string",
27           "parameters": {}
28         }
29       ]
30     },
31     "optimizer": {
32       "type": "string",
33       "parameters": {}
34     }
35   },
36   "error_info": {
37     "exception_type": "string",
38     "traceback": "string",
39     "message": "string"
40   },
41   "dataset_id": "string",
42   "num_trials": 1,
43   "feedback_scores": [
44     {
45       "name": "string",
46       "value": 1.1
47     }
48   ],
49   "experiment_scores": [
50     {
51       "name": "string",
52       "value": 1.1
53     }
54   ],
55   "created_at": "2024-01-15T09:30:00Z",
56   "created_by": "string",
57   "last_updated_at": "2024-01-15T09:30:00Z",
58   "last_updated_by": "string",
59   "baseline_objective_score": 1.1,
60   "best_objective_score": 1.1,
61   "baseline_duration": 1.1,
62   "best_duration": 1.1,
63   "baseline_cost": 1.1,
64   "best_cost": 1.1,
65   "total_optimization_cost": 1.1
66 }

Get optimization by id

Path parameters

idstringRequiredformat: "uuid"

Response

Optimization resource

dataset_namestring>=1 character

objective_namestring>=1 character

statusenum

idstringOptionalformat: "uuid"

namestringOptional

project_idstringOptionalformat: "uuid"

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

metadatamap from strings to any or list of objects or stringOptional

studio_configobjectOptional

error_infoobjectOptional

dataset_idstringOptionalRead-onlyformat: "uuid"

num_trialslongOptionalRead-only

feedback_scoreslist of objectsOptionalRead-only

experiment_scoreslist of objectsOptionalRead-only

created_atdatetimeOptionalRead-only

created_bystringOptionalRead-only

last_updated_atdatetimeOptional

last_updated_bystringOptionalRead-only

baseline_objective_scoredoubleOptionalRead-only

best_objective_scoredoubleOptionalRead-only

baseline_durationdoubleOptionalRead-only

best_durationdoubleOptionalRead-only

baseline_costdoubleOptionalRead-only

best_costdoubleOptionalRead-only

total_optimization_costdoubleOptionalRead-only

Errors

404

Not Found Error