Evaluation Create

Create an evaluation object.

POST /v2/{entity}/{project}/evaluations

Evaluation Create

cURL

curl --request POST \
  --url https://api.example.com/v2/{entity}/{project}/evaluations \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "dataset": "<string>",
  "description": "<string>",
  "scorers": [
    "<string>"
  ],
  "trials": 1,
  "evaluation_name": "<string>",
  "eval_attributes": {}
}
'

200

{
  "digest": "<string>",
  "object_id": "<string>",
  "version_index": 123,
  "evaluation_ref": "<string>"
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

entity · string · required

project · string · required

Body

application/json

name · string · required

The name of this evaluation. Evaluations with the same name will be versioned together.

dataset · string · required

Reference to the dataset (weave:// URI)

description · string | null

A description of this evaluation

scorers · string[] | null

List of scorer references (weave:// URIs)

trials · integer · default: 1

Number of trials to run

evaluation_name · string | null

Name for the evaluation run

eval_attributes · Eval Attributes · object

Optional attributes for the evaluation

Response

200

application/json

Successful Response

digest · string · required

The digest of the created evaluation

object_id · string · required

The ID of the created evaluation

version_index · integer · required

The version index of the created evaluation

evaluation_ref · string · required

Full reference to the created evaluation