List

GET

Get all evaluators within your organization.

Response

This endpoint returns a list of objects

namestring

The name of the evaluator.

descriptionstring

The description of the evaluator.

arguments_type"target_free" or "target_required"

Allowed values: target_freetarget_required

Whether this evaluator is target-free or target-required.

return_typeenum

Allowed values: booleannumberselectmulti_selecttext

The type of the return value of the evaluator.

typeenum

Allowed values: pythonllmhumanexternal

The type of the evaluator.

idstring

Unique ID for the evaluator. Starts with evfn_.

created_atdatetime

updated_atdatetime

codestringOptional

The code for the evaluator. This code will be executed in a sandboxed environment.

model_configobjectOptional

The model config defining the LLM evaluator.

logging_projectobjectOptional

The project where the evaluator logs are stored.

Errors

GET

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

1 [
2   {
3     "name": "name",
4     "description": "description",
5     "arguments_type": "target_free",
6     "return_type": "boolean",
7     "code": "code",
8     "model_config": {
9       "id": "id",
10       "other": {
11         "key": "value"
12       },
13       "name": "name",
14       "description": "description",
15       "provider": "openai",
16       "model": "model",
17       "max_tokens": 1,
18       "temperature": 1.1,
19       "top_p": 1.1,
20       "stop": "stop",
21       "presence_penalty": 1.1,
22       "frequency_penalty": 1.1,
23       "seed": 1,
24       "response_format": {
25         "type": "json_object"
26       },
27       "prompt_template": "prompt_template",
28       "chat_template": [
29         {
30           "role": "user"
31         }
32       ],
33       "tool_configs": [
34         {
35           "id": "id",
36           "status": "status",
37           "name": "name"
38         }
39       ],
40       "tools": [
41         {
42           "id": "id",
43           "name": "name"
44         }
45       ],
46       "endpoint": "complete"
47     },
48     "type": "python",
49     "id": "id",
50     "created_at": "2024-01-15T09:30:00Z",
51     "updated_at": "2024-01-15T09:30:00Z",
52     "logging_project": {
53       "id": "id",
54       "name": "name",
55       "active_config": {
56         "project_id": "project_id",
57         "project_name": "project_name",
58         "created_at": "2024-01-15T09:30:00Z",
59         "updated_at": "2024-01-15T09:30:00Z",
60         "last_used": "2024-01-15T09:30:00Z",
61         "config": {
62           "type": "generic",
63           "id": "config",
64           "status": "config",
65           "name": "config"
66         }
67       },
68       "users": [
69         {
70           "id": "id",
71           "email_address": "email_address"
72         }
73       ],
74       "data_count": 1,
75       "feedback_types": [
76         {
77           "type": "rating"
78         }
79       ],
80       "team_id": "team_id",
81       "config_type": "generic",
82       "directory_id": "directory_id",
83       "created_at": "2024-01-15T09:30:00Z",
84       "updated_at": "2024-01-15T09:30:00Z"
85     }
86   }
87 ]

Built with

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

1	[
2	{
3	"name": "name",
4	"description": "description",
5	"arguments_type": "target_free",
6	"return_type": "boolean",
7	"code": "code",
8	"model_config": {
9	"id": "id",
10	"other": {
11	"key": "value"
12	},
13	"name": "name",
14	"description": "description",
15	"provider": "openai",
16	"model": "model",
17	"max_tokens": 1,
18	"temperature": 1.1,
19	"top_p": 1.1,
20	"stop": "stop",
21	"presence_penalty": 1.1,
22	"frequency_penalty": 1.1,
23	"seed": 1,
24	"response_format": {
25	"type": "json_object"
26	},
27	"prompt_template": "prompt_template",
28	"chat_template": [
29	{
30	"role": "user"
31	}
32	],
33	"tool_configs": [
34	{
35	"id": "id",
36	"status": "status",
37	"name": "name"
38	}
39	],
40	"tools": [
41	{
42	"id": "id",
43	"name": "name"
44	}
45	],
46	"endpoint": "complete"
47	},
48	"type": "python",
49	"id": "id",
50	"created_at": "2024-01-15T09:30:00Z",
51	"updated_at": "2024-01-15T09:30:00Z",
52	"logging_project": {
53	"id": "id",
54	"name": "name",
55	"active_config": {
56	"project_id": "project_id",
57	"project_name": "project_name",
58	"created_at": "2024-01-15T09:30:00Z",
59	"updated_at": "2024-01-15T09:30:00Z",
60	"last_used": "2024-01-15T09:30:00Z",
61	"config": {
62	"type": "generic",
63	"id": "config",
64	"status": "config",
65	"name": "config"
66	}
67	},
68	"users": [
69	{
70	"id": "id",
71	"email_address": "email_address"
72	}
73	],
74	"data_count": 1,
75	"feedback_types": [
76	{
77	"type": "rating"
78	}
79	],
80	"team_id": "team_id",
81	"config_type": "generic",
82	"directory_id": "directory_id",
83	"created_at": "2024-01-15T09:30:00Z",
84	"updated_at": "2024-01-15T09:30:00Z"
85	}
86	}
87	]