Find experiments

GET

/v1/private/experiments

GET

/api/v1/private/experiments

$ curl http://localhost:5173/api/v1/private/experiments

1 {
2   "page": 1,
3   "size": 1,
4   "total": 1,
5   "content": [
6     {
7       "dataset_name": "string",
8       "id": "string",
9       "dataset_id": "string",
10       "project_id": "string",
11       "project_name": "string",
12       "name": "string",
13       "metadata": {},
14       "tags": [
15         "string"
16       ],
17       "type": "regular",
18       "evaluation_method": "dataset",
19       "optimization_id": "string",
20       "feedback_scores": [
21         {
22           "name": "string",
23           "value": 1.1
24         }
25       ],
26       "comments": [
27         {
28           "text": "string",
29           "id": "string",
30           "source_queue_id": "string",
31           "created_at": "2024-01-15T09:30:00Z",
32           "last_updated_at": "2024-01-15T09:30:00Z",
33           "created_by": "string",
34           "last_updated_by": "string"
35         }
36       ],
37       "trace_count": 1,
38       "dataset_item_count": 1,
39       "created_at": "2024-01-15T09:30:00Z",
40       "duration": {
41         "p50": 1.1,
42         "p90": 1.1,
43         "p99": 1.1
44       },
45       "total_estimated_cost": 1.1,
46       "total_estimated_cost_avg": 1.1,
47       "usage": {},
48       "last_updated_at": "2024-01-15T09:30:00Z",
49       "created_by": "string",
50       "last_updated_by": "string",
51       "status": "running",
52       "experiment_scores": [
53         {
54           "name": "string",
55           "value": 1.1
56         }
57       ],
58       "prompt_version": {
59         "prompt_version_id": "string",
60         "commit": "string",
61         "prompt_id": "string",
62         "prompt_name": "string"
63       },
64       "prompt_versions": [
65         {
66           "prompt_version_id": "string",
67           "commit": "string",
68           "prompt_id": "string",
69           "prompt_name": "string"
70         }
71       ],
72       "dataset_version_id": "string",
73       "dataset_version_summary": {
74         "id": "string",
75         "version_hash": "string",
76         "version_name": "string",
77         "change_description": "string",
78         "tags": [
79           "string"
80         ]
81       },
82       "pass_rate": 1.1,
83       "passed_count": 1,
84       "total_count": 1,
85       "assertion_scores": [
86         {
87           "name": "string",
88           "value": 1.1
89         }
90       ]
91     }
92   ],
93   "sortableBy": [
94     "string"
95   ]
96 }

Find experiments

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

datasetIdstringOptionalformat: "uuid"

optimization_idstringOptionalformat: "uuid"

typesstringOptional

namestringOptional

dataset_deletedbooleanOptional

prompt_idstringOptionalformat: "uuid"

project_idstringOptionalformat: "uuid"

project_deletedbooleanOptional

sortingstringOptional

filtersstringOptional

experiment_idsstringOptional

force_sortingbooleanOptionalDefaults to false

Response

Experiments resource

pageintegerOptional

sizeintegerOptional

totallongOptional

contentlist of objectsOptional

sortableBylist of stringsOptional

Errors

400

Bad Request Error