Create Evaluation

Create an Evaluation.

Create a new Evaluation by specifying the File to evaluate, and a name for the Evaluation. You can then add Runs to this Evaluation using the POST /evaluations/{id}/runs endpoint.

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
evaluatorslist of objectsRequired
The Evaluators used to evaluate.
fileobjectOptional
The File to associate with the Evaluation. This File contains the Logs you're evaluating.
namestringOptional
Name of the Evaluation to help identify it. Must be unique within the associated File.

Response

Successful Response
idstring

Unique identifier for the Evaluation. Starts with evr.

runs_countinteger
The total number of Runs in the Evaluation.
evaluatorslist of objects
The Evaluator Versions used to evaluate.
created_atdatetime
updated_atdatetime
namestring or null
Name of the Evaluation to help identify it. Must be unique among Evaluations associated with File.
file_idstring or null
Unique identifier for the File associated with the Evaluation.
created_byany or null
urlstring or null
URL to view the Evaluation on the Humanloop.

Errors