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 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "dataset": "<string>",
  "description": "<string>",
  "scorers": [
    "<string>"
  ],
  "trials": 1,
  "evaluation_name": "<string>",
  "eval_attributes": {}
}
'

import requests

url = "https://api.example.com/v2/{entity}/{project}/evaluations"

payload = {
    "name": "<string>",
    "dataset": "<string>",
    "description": "<string>",
    "scorers": ["<string>"],
    "trials": 1,
    "evaluation_name": "<string>",
    "eval_attributes": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    dataset: '<string>',
    description: '<string>',
    scorers: ['<string>'],
    trials: 1,
    evaluation_name: '<string>',
    eval_attributes: {}
  })
};

fetch('https://api.example.com/v2/{entity}/{project}/evaluations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/{entity}/{project}/evaluations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'dataset' => '<string>',
    'description' => '<string>',
    'scorers' => [
        '<string>'
    ],
    'trials' => 1,
    'evaluation_name' => '<string>',
    'eval_attributes' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/{entity}/{project}/evaluations"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"dataset\": \"<string>\",\n  \"description\": \"<string>\",\n  \"scorers\": [\n    \"<string>\"\n  ],\n  \"trials\": 1,\n  \"evaluation_name\": \"<string>\",\n  \"eval_attributes\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v2/{entity}/{project}/evaluations")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"dataset\": \"<string>\",\n  \"description\": \"<string>\",\n  \"scorers\": [\n    \"<string>\"\n  ],\n  \"trials\": 1,\n  \"evaluation_name\": \"<string>\",\n  \"eval_attributes\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/{entity}/{project}/evaluations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"dataset\": \"<string>\",\n  \"description\": \"<string>\",\n  \"scorers\": [\n    \"<string>\"\n  ],\n  \"trials\": 1,\n  \"evaluation_name\": \"<string>\",\n  \"eval_attributes\": {}\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

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