List Evaluations for a File

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

Successful Response

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

Create Evaluation

Up Next

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