List Evaluators

GET

Get a list of all Evaluators.

Query parameters

pageintegerOptional

Page offset for pagination.

sizeintegerOptional

Page size for pagination. Number of Evaluators to fetch.

namestringOptional

Case-insensitive filter for Evaluator name.

user_filterstringOptional

Case-insensitive filter for users in the Evaluator. This filter matches against both email address and name of users.

sort_byenumOptional

Field to sort Evaluators by

Allowed values: created_atupdated_atname

order"asc" or "desc"Optional

Direction to sort by.

Allowed values: ascdesc

Response

Successful Response

recordslist of objects

pageinteger

sizeinteger

totalinteger

Errors

GET

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

1 {
2   "records": [
3     {
4       "path": "Shared Evaluators/Accuracy Evaluator",
5       "id": "ev_890bcd",
6       "spec": {
7         "arguments_type": "target_required",
8         "return_type": "number",
9         "evaluator_type": "python",
10         "code": "def evaluate(answer, target):\n    return 0.5"
11       },
12       "name": "Accuracy Evaluator",
13       "version_id": "evv_012def",
14       "created_at": "2024-05-01T12:00:00Z",
15       "updated_at": "2024-05-01T12:00:00Z",
16       "status": "committed",
17       "last_used_at": "2024-05-01T12:00:00Z",
18       "version_logs_count": 1,
19       "total_logs_count": 1,
20       "inputs": [
21         {
22           "name": "answer"
23         }
24       ],
25       "type": "evaluator"
26     }
27   ],
28   "page": 0,
29   "size": 1,
30   "total": 1
31 }

Upsert Evaluator

Up Next

Built with

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

1	{
2	"records": [
3	{
4	"path": "Shared Evaluators/Accuracy Evaluator",
5	"id": "ev_890bcd",
6	"spec": {
7	"arguments_type": "target_required",
8	"return_type": "number",
9	"evaluator_type": "python",
10	"code": "def evaluate(answer, target):\n return 0.5"
11	},
12	"name": "Accuracy Evaluator",
13	"version_id": "evv_012def",
14	"created_at": "2024-05-01T12:00:00Z",
15	"updated_at": "2024-05-01T12:00:00Z",
16	"status": "committed",
17	"last_used_at": "2024-05-01T12:00:00Z",
18	"version_logs_count": 1,
19	"total_logs_count": 1,
20	"inputs": [
21	{
22	"name": "answer"
23	}
24	],
25	"type": "evaluator"
26	}
27	],
28	"page": 0,
29	"size": 1,
30	"total": 1
31	}