List

GET

Get all evaluators within your organization.

Response

Successful Response

namestring=1 character

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

Create

Up Next

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