List

GET

List all Evaluations for the specified file_id.

Retrieve a list of Evaluations that evaluate versions of the specified File.

Query parameters

file_idstringRequired

Filter by File ID. Only Evaluations for the specified File will be returned.

pageintegerOptional

Page number for pagination.

sizeintegerOptional

Page size for pagination. Number of Evaluations to fetch.

Response

This endpoint returns an object.

recordslist of objects

pageinteger

sizeinteger

totalinteger

Errors

GET

1 curl -G https://api.humanloop.com/v5/evaluations \
2      -H "X-API-KEY: <apiKey>" \
3      -d file_id=pr_30gco7dx6JDq4200GVOHa \
4      -d size=1

1 {
2   "page": 1,
3   "size": 10,
4   "total": 1,
5   "records": [
6     {
7       "id": "ev_567yza",
8       "created_at": "2024-05-01T12:00:00Z",
9       "updated_at": "2024-05-01T12:00:00Z",
10       "status": "completed",
11       "dataset": {
12         "id": "ds_345mno",
13         "path": "test-questions",
14         "name": "test-questions",
15         "version_id": "dsv_678pqr",
16         "type": "dataset",
17         "created_at": "2024-05-01T12:00:00Z",
18         "updated_at": "2024-05-01T12:00:00Z",
19         "created_by": {
20           "id": "usr_v23rSVAgas2a",
21           "full_name": "Jordan Burges",
22           "email_address": "jordan@humanloop.com"
23         },
24         "status": "committed",
25         "commit_message": "initial commit",
26         "last_used_at": "2024-05-01T12:00:00Z",
27         "datapoints_count": 2
28       },
29       "evaluatees": [
30         {
31           "version": {
32             "path": "Personal Projects/Coding Assistant",
33             "id": "pr_30gco7dx6JDq4200GVOHa",
34             "name": "Coding Assistant",
35             "version_id": "prv_7ZlQREDScH0xkhUwtXruN",
36             "type": "prompt",
37             "environments": [
38               {
39                 "id": "env_ffSVxEBzJcBZ1H5jcNMVj",
40                 "created_at": "2023-06-27T23:16:07.992339",
41                 "name": "development",
42                 "tag": "default"
43               }
44             ],
45             "created_at": "2024-07-08T22:40:35.656915",
46             "updated_at": "2024-07-08T22:40:35.656915",
47             "created_by": {
48               "id": "usr_01RJO1k2spBVqNUt1ASef",
49               "email_address": "raza@humanloop.com",
50               "full_name": "Raza Habib"
51             },
52             "status": "committed",
53             "last_used_at": "2024-07-08T22:40:35.656915",
54             "model": "gpt-4o",
55             "endpoint": "chat",
56             "template": [
57               {
58                 "content": "You are a helpful coding assistant specialising in {{language}}",
59                 "role": "system"
60               }
61             ],
62             "provider": "openai",
63             "max_tokens": -1,
64             "temperature": 0.7,
65             "top_p": 1,
66             "presence_penalty": 0,
67             "frequency_penalty": 0,
68             "other": {},
69             "tools": [],
70             "linked_tools": [],
71             "commit_message": "Initial commit",
72             "version_logs_count": 0,
73             "total_logs_count": 0,
74             "inputs": [
75               {
76                 "name": "messages"
77               }
78             ]
79           },
80           "orchestrated": false
81         }
82       ],
83       "evaluators": [
84         {
85           "version": {
86             "id": "ev_890bcd",
87             "name": "Accuracy Evaluator",
88             "path": "Shared Evaluators/Accuracy Evaluator",
89             "version_id": "evv_012def",
90             "type": "evaluator",
91             "created_at": "2024-05-01T12:00:00Z",
92             "updated_at": "2024-05-01T12:00:00Z",
93             "status": "committed",
94             "last_used_at": "2024-05-01T12:00:00Z",
95             "spec": {
96               "arguments_type": "target_required",
97               "return_type": "number",
98               "evaluator_type": "python",
99               "code": "def evaluate(answer, target):\n    return 0.5"
100             },
101             "version_logs_count": 1,
102             "total_logs_count": 1,
103             "inputs": [
104               {
105                 "name": "answer"
106               }
107             ]
108           },
109           "orchestrated": false
110         }
111       ]
112     }
113   ]
114 }

Built with

1	curl -G https://api.humanloop.com/v5/evaluations \
2	-H "X-API-KEY: <apiKey>" \
3	-d file_id=pr_30gco7dx6JDq4200GVOHa \
4	-d size=1

1	{
2	"page": 1,
3	"size": 10,
4	"total": 1,
5	"records": [
6	{
7	"id": "ev_567yza",
8	"created_at": "2024-05-01T12:00:00Z",
9	"updated_at": "2024-05-01T12:00:00Z",
10	"status": "completed",
11	"dataset": {
12	"id": "ds_345mno",
13	"path": "test-questions",
14	"name": "test-questions",
15	"version_id": "dsv_678pqr",
16	"type": "dataset",
17	"created_at": "2024-05-01T12:00:00Z",
18	"updated_at": "2024-05-01T12:00:00Z",
19	"created_by": {
20	"id": "usr_v23rSVAgas2a",
21	"full_name": "Jordan Burges",
22	"email_address": "jordan@humanloop.com"
23	},
24	"status": "committed",
25	"commit_message": "initial commit",
26	"last_used_at": "2024-05-01T12:00:00Z",
27	"datapoints_count": 2
28	},
29	"evaluatees": [
30	{
31	"version": {
32	"path": "Personal Projects/Coding Assistant",
33	"id": "pr_30gco7dx6JDq4200GVOHa",
34	"name": "Coding Assistant",
35	"version_id": "prv_7ZlQREDScH0xkhUwtXruN",
36	"type": "prompt",
37	"environments": [
38	{
39	"id": "env_ffSVxEBzJcBZ1H5jcNMVj",
40	"created_at": "2023-06-27T23:16:07.992339",
41	"name": "development",
42	"tag": "default"
43	}
44	],
45	"created_at": "2024-07-08T22:40:35.656915",
46	"updated_at": "2024-07-08T22:40:35.656915",
47	"created_by": {
48	"id": "usr_01RJO1k2spBVqNUt1ASef",
49	"email_address": "raza@humanloop.com",
50	"full_name": "Raza Habib"
51	},
52	"status": "committed",
53	"last_used_at": "2024-07-08T22:40:35.656915",
54	"model": "gpt-4o",
55	"endpoint": "chat",
56	"template": [
57	{
58	"content": "You are a helpful coding assistant specialising in {{language}}",
59	"role": "system"
60	}
61	],
62	"provider": "openai",
63	"max_tokens": -1,
64	"temperature": 0.7,
65	"top_p": 1,
66	"presence_penalty": 0,
67	"frequency_penalty": 0,
68	"other": {},
69	"tools": [],
70	"linked_tools": [],
71	"commit_message": "Initial commit",
72	"version_logs_count": 0,
73	"total_logs_count": 0,
74	"inputs": [
75	{
76	"name": "messages"
77	}
78	]
79	},
80	"orchestrated": false
81	}
82	],
83	"evaluators": [
84	{
85	"version": {
86	"id": "ev_890bcd",
87	"name": "Accuracy Evaluator",
88	"path": "Shared Evaluators/Accuracy Evaluator",
89	"version_id": "evv_012def",
90	"type": "evaluator",
91	"created_at": "2024-05-01T12:00:00Z",
92	"updated_at": "2024-05-01T12:00:00Z",
93	"status": "committed",
94	"last_used_at": "2024-05-01T12:00:00Z",
95	"spec": {
96	"arguments_type": "target_required",
97	"return_type": "number",
98	"evaluator_type": "python",
99	"code": "def evaluate(answer, target):\n return 0.5"
100	},
101	"version_logs_count": 1,
102	"total_logs_count": 1,
103	"inputs": [
104	{
105	"name": "answer"
106	}
107	]
108	},
109	"orchestrated": false
110	}
111	]
112	}
113	]
114	}