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

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

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

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

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

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([
'dataset' => '<string>',
'name' => '<string>',
'description' => '<string>',
'eval_attributes' => [

],
'evaluation_name' => '<string>',
'scorers' => [
'<string>'
],
'trials' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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 \"dataset\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"eval_attributes\": {},\n \"evaluation_name\": \"<string>\",\n \"scorers\": [\n \"<string>\"\n ],\n \"trials\": 1\n}")

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

req.Header.Add("Authorization", "Basic <encoded-value>")
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("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"dataset\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"eval_attributes\": {},\n \"evaluation_name\": \"<string>\",\n \"scorers\": [\n \"<string>\"\n ],\n \"trials\": 1\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["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataset\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"eval_attributes\": {},\n \"evaluation_name\": \"<string>\",\n \"scorers\": [\n \"<string>\"\n ],\n \"trials\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "digest": "<string>",
  "evaluation_ref": "<string>",
  "object_id": "<string>",
  "version_index": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

entity
string
requis
project
string
requis

Corps

application/json
dataset
string
requis

Référence au jeu de données (URI weave://)

name
string
requis

Le nom de cette évaluation. Les évaluations portant le même nom seront versionnées ensemble.

description
string | null

Une description de cette évaluation

eval_attributes
Eval Attributes · object | null

Attributs facultatifs pour l'évaluation

evaluation_name
string | null

Nom du run d'évaluation

scorers
string[] | null

Liste des références de scorer (URI weave://)

trials
integer
défaut:1

Nombre d'essais à exécuter

Réponse

Réponse réussie

digest
string
requis

Le digest de l'évaluation créée

evaluation_ref
string
requis

Référence complète de l’évaluation créée

object_id
string
requis

L'ID de l'évaluation créée

version_index
integer
requis

L’index de version de l’évaluation créée