Humanloop Documentation and API Reference

Get an evaluator within your organization.

Path parameters

idstringRequired

Response

This endpoint returns an object

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

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

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

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

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