evaluations

Create

Create an evaluation.

post/projects/{project_id}/evaluations

Request

  • Base URL: https://api.humanloop.com/v4
  • URL: https://api.humanloop.com/v4/projects/{project_id}/evaluations
  • Auth: API key in header X-API-KEY

Path parameters

project_idstring required

String ID of project. Starts with pr_.

Request body

config_idstring required

ID of the config to evaluate. Starts with config_.

evaluator_idsstring[] required

IDs of evaluators to run on the dataset. IDs start with evfn_

dataset_idstring required

ID of the dataset to use in this evaluation. Starts with evts_.

hl_generatedboolean

Whether the log generations for this evaluation should be performed by Humanloop. If False, the log generations should be submitted by the user via the API.

namestring

Name of the Evaluation to help identify it.

Response

Successful Response

idstring required

Unique ID for the evaluation. Starts with ev_.

status'pending' | 'running' | 'completed' | 'cancelled' required

Status of an evaluation.

created_atstring date-time required
updated_atstring date-time required
dataset_version_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.