List Evaluators

1 import { HumanloopClient } from "humanloop"; 2 3 const client = new HumanloopClient({ apiKey: "YOUR_API_KEY" }); 4 const response = await client.evaluators.list({ 5 size: 1 6 }); 7 for await (const item of response) { 8 console.log(item); 9 } 10 11 // Or you can manually iterate page-by-page 12 const page = await client.evaluators.list({ 13 size: 1 14 }); 15 while (page.hasNextPage()) { 16 page = page.getNextPage(); 17 }

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 }

Get a list of all Evaluators.

Query parameters

pageintegerOptional>=1Defaults to 1

Page offset for pagination.

sizeintegerOptionalDefaults to 10

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:

orderenumOptional

Direction to sort by.

Allowed values:

Response

Successful Response

recordslist of objects

pageinteger

sizeinteger

totalinteger

Headers

Query parameters

Response

Errors