List For Project

Deprecated

GET

Get all the evaluations associated with your project.

Deprecated: This is a legacy unpaginated endpoint. Use /evaluations instead, with appropriate sorting, filtering and pagination options.

Path parameters

project_idstringRequired

String ID of project. Starts with pr_.

Query parameters

evaluatee_idstringOptional

String ID of evaluatee version to return. If not defined, the first evaluatee will be returned. Starts with evv_.

evaluator_aggregatesbooleanOptional

Whether to include evaluator aggregates in the response.

Response

Successful Response

idstring

Unique ID for the evaluation. Starts with ev_.

statusenum

Allowed values: pendingrunningcompletedcancelled

Status of an evaluation.

configobject

created_atdatetime

updated_atdatetime

evaluatorslist of objects

datasetobject

dataset_version_idstring

dataset_snapshotobjectOptional

evaluator_aggregateslist of objectsOptional

Errors

GET

1 curl https://api.humanloop.com/v4/projects/project_id/evaluations \
2      -H "X-API-KEY: <apiKey>"

1 [
2   {
3     "id": "id",
4     "status": "pending",
5     "config": {
6       "type": "generic",
7       "id": "config",
8       "name": "config",
9       "status": "config",
10       "created_by": {
11         "id": "id",
12         "email_address": "email_address",
13         "verified": true
14       },
15       "description": "config",
16       "other": {
17         "key": "value"
18       }
19     },
20     "created_at": "2024-01-15T09:30:00Z",
21     "updated_at": "2024-01-15T09:30:00Z",
22     "evaluators": [
23       {
24         "name": "name",
25         "description": "description",
26         "arguments_type": "target_free",
27         "return_type": "boolean",
28         "type": "python",
29         "id": "id",
30         "created_at": "2024-01-15T09:30:00Z",
31         "updated_at": "2024-01-15T09:30:00Z"
32       }
33     ],
34     "dataset": {
35       "id": "id",
36       "name": "name",
37       "datapoint_count": 1,
38       "created_at": "2024-01-15T09:30:00Z",
39       "updated_at": "2024-01-15T09:30:00Z",
40       "project_id": "project_id",
41       "description": "description"
42     },
43     "dataset_version_id": "dataset_version_id",
44     "dataset_snapshot": {
45       "id": "id",
46       "name": "name",
47       "datapoint_count": 1,
48       "created_at": "2024-01-15T09:30:00Z",
49       "updated_at": "2024-01-15T09:30:00Z",
50       "project_id": "project_id",
51       "description": "description"
52     },
53     "evaluator_aggregates": [
54       {
55         "model_config_id": "model_config_id",
56         "evaluator_id": "evaluator_id",
57         "evaluator_version_id": "evaluator_version_id"
58       }
59     ]
60   }
61 ]

List

Up Next

Built with

1	curl https://api.humanloop.com/v4/projects/project_id/evaluations \
2	-H "X-API-KEY: <apiKey>"

1	[
2	{
3	"id": "id",
4	"status": "pending",
5	"config": {
6	"type": "generic",
7	"id": "config",
8	"name": "config",
9	"status": "config",
10	"created_by": {
11	"id": "id",
12	"email_address": "email_address",
13	"verified": true
14	},
15	"description": "config",
16	"other": {
17	"key": "value"
18	}
19	},
20	"created_at": "2024-01-15T09:30:00Z",
21	"updated_at": "2024-01-15T09:30:00Z",
22	"evaluators": [
23	{
24	"name": "name",
25	"description": "description",
26	"arguments_type": "target_free",
27	"return_type": "boolean",
28	"type": "python",
29	"id": "id",
30	"created_at": "2024-01-15T09:30:00Z",
31	"updated_at": "2024-01-15T09:30:00Z"
32	}
33	],
34	"dataset": {
35	"id": "id",
36	"name": "name",
37	"datapoint_count": 1,
38	"created_at": "2024-01-15T09:30:00Z",
39	"updated_at": "2024-01-15T09:30:00Z",
40	"project_id": "project_id",
41	"description": "description"
42	},
43	"dataset_version_id": "dataset_version_id",
44	"dataset_snapshot": {
45	"id": "id",
46	"name": "name",
47	"datapoint_count": 1,
48	"created_at": "2024-01-15T09:30:00Z",
49	"updated_at": "2024-01-15T09:30:00Z",
50	"project_id": "project_id",
51	"description": "description"
52	},
53	"evaluator_aggregates": [
54	{
55	"model_config_id": "model_config_id",
56	"evaluator_id": "evaluator_id",
57	"evaluator_version_id": "evaluator_version_id"
58	}
59	]
60	}
61	]