Get Evaluations | Humanloop Docs

1 import requests 2 3 url = "https://api.humanloop.com/v4/evaluations" 4 5 querystring = {"project_id":"project_id"} 6 7 headers = {"X-API-KEY": "<apiKey>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

1 { 2 "records": [ 3 { 4 "id": "id", 5 "status": "pending", 6 "config": { 7 "type": "model", 8 "id": "id", 9 "model": "model" 10 }, 11 "created_at": "2024-01-15T09:30:00Z", 12 "updated_at": "2024-01-15T09:30:00Z", 13 "evaluators": [ 14 { 15 "name": "name", 16 "description": "description", 17 "arguments_type": "target_free", 18 "return_type": "boolean", 19 "type": "python", 20 "id": "id", 21 "created_at": "2024-01-15T09:30:00Z", 22 "updated_at": "2024-01-15T09:30:00Z" 23 } 24 ], 25 "dataset": { 26 "id": "id", 27 "name": "name", 28 "datapoint_count": 1, 29 "created_at": "2024-01-15T09:30:00Z", 30 "updated_at": "2024-01-15T09:30:00Z", 31 "project_id": "project_id" 32 }, 33 "dataset_version_id": "dataset_version_id", 34 "dataset_snapshot": { 35 "id": "id", 36 "name": "name", 37 "datapoint_count": 1, 38 "created_at": "2024-01-15T09:30:00Z", 39 "updated_at": "2024-01-15T09:30:00Z", 40 "project_id": "project_id" 41 }, 42 "evaluator_aggregates": [ 43 { 44 "model_config_id": "model_config_id", 45 "evaluator_id": "evaluator_id", 46 "evaluator_version_id": "evaluator_version_id" 47 } 48 ] 49 } 50 ], 51 "page": 1, 52 "size": 1, 53 "total": 1 54 }

Get the evaluations associated with a project.

Sorting and filtering are supported through query params for categorical columns and the created_at timestamp.

Sorting is supported for the dataset, config, status and evaluator-{evaluator_id} columns. Specify sorting with the sort query param, with values {column}.{ordering}. E.g. ?sort=dataset.asc&sort=status.desc will yield a multi-column sort. First by dataset then by status.

Filtering is supported for the id, dataset, config and status columns.

Specify filtering with the id_filter, dataset_filter, config_filter and status_filter query params.

E.g. ?dataset_filter=my_dataset&dataset_filter=my_other_dataset&status_filter=running will only show rows where the dataset is “my_dataset” or “my_other_dataset”, and where the status is “running”.

An additional date range filter is supported for the created_at column. Use the start_date and end_date query parameters to configure this.

Get the evaluations associated with a project. Sorting and filtering are supported through query params for categorical columns and the `created_at` timestamp. Sorting is supported for the `dataset`, `config`, `status` and `evaluator-{evaluator_id}` columns. Specify sorting with the `sort` query param, with values `{column}.{ordering}`. E.g. ?sort=dataset.asc&sort=status.desc will yield a multi-column sort. First by dataset then by status. Filtering is supported for the `id`, `dataset`, `config` and `status` columns. Specify filtering with the `id_filter`, `dataset_filter`, `config_filter` and `status_filter` query params. E.g. ?dataset_filter=my_dataset&dataset_filter=my_other_dataset&status_filter=running will only show rows where the dataset is "my_dataset" or "my_other_dataset", and where the status is "running". An additional date range filter is supported for the `created_at` column. Use the `start_date` and `end_date` query parameters to configure this.

Authentication

X-API-KEYstring

API Key authentication via header

Query Parameters

project_idstringRequired

String ID of project. Starts with pr_.

idstringOptional

A list of evaluation run ids to filter on. Starts with ev_.

start_datestringOptionalformat: "date"

Only return evaluations created after this date.

end_datestringOptionalformat: "date"

Only return evaluations created before this date.

sizeintegerOptionalDefaults to 50

pageintegerOptionalDefaults to 0

evaluatee_idstringOptional

String ID of evaluatee version to return. If not defined, the first evaluatee will be returned. Starts with evv_.

Response

Successful Response

recordslist of objects

pageinteger

sizeinteger

totalinteger

Authentication

Query Parameters

Response

Errors