Skip to main content
POST
/
v2
/
{entity}
/
{project}
/
evaluations
{
  "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.

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)

​
project_id
string
required

The entity/project where this evaluation will be saved

​
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
object | null

Optional attributes for the evaluation

​
wb_user_id
string | null

Do not set directly. Server will automatically populate this field.

Response

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