Create or update evaluation for an experiment run
curl --request POST \
--url https://api.example.com/v1/experiment_evaluations \
--header 'Content-Type: application/json' \
--data '
{
"experiment_run_id": "<string>",
"name": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"result": {
"label": "<string>",
"score": 123,
"explanation": "<string>"
},
"error": "<string>",
"metadata": {},
"trace_id": "<string>"
}
'import requests
url = "https://api.example.com/v1/experiment_evaluations"
payload = {
"experiment_run_id": "<string>",
"name": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"result": {
"label": "<string>",
"score": 123,
"explanation": "<string>"
},
"error": "<string>",
"metadata": {},
"trace_id": "<string>"
}
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({
experiment_run_id: '<string>',
name: '<string>',
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
result: {label: '<string>', score: 123, explanation: '<string>'},
error: '<string>',
metadata: {},
trace_id: '<string>'
})
};
fetch('https://api.example.com/v1/experiment_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/v1/experiment_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([
'experiment_run_id' => '<string>',
'name' => '<string>',
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'result' => [
'label' => '<string>',
'score' => 123,
'explanation' => '<string>'
],
'error' => '<string>',
'metadata' => [
],
'trace_id' => '<string>'
]),
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/v1/experiment_evaluations"
payload := strings.NewReader("{\n \"experiment_run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"result\": {\n \"label\": \"<string>\",\n \"score\": 123,\n \"explanation\": \"<string>\"\n },\n \"error\": \"<string>\",\n \"metadata\": {},\n \"trace_id\": \"<string>\"\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/v1/experiment_evaluations")
.header("Content-Type", "application/json")
.body("{\n \"experiment_run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"result\": {\n \"label\": \"<string>\",\n \"score\": 123,\n \"explanation\": \"<string>\"\n },\n \"error\": \"<string>\",\n \"metadata\": {},\n \"trace_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/experiment_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 \"experiment_run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"result\": {\n \"label\": \"<string>\",\n \"score\": 123,\n \"explanation\": \"<string>\"\n },\n \"error\": \"<string>\",\n \"metadata\": {},\n \"trace_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>"
}
}"<string>""<string>"{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Experiments
Create or update evaluation for an experiment run
POST
/
v1
/
experiment_evaluations
Create or update evaluation for an experiment run
curl --request POST \
--url https://api.example.com/v1/experiment_evaluations \
--header 'Content-Type: application/json' \
--data '
{
"experiment_run_id": "<string>",
"name": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"result": {
"label": "<string>",
"score": 123,
"explanation": "<string>"
},
"error": "<string>",
"metadata": {},
"trace_id": "<string>"
}
'import requests
url = "https://api.example.com/v1/experiment_evaluations"
payload = {
"experiment_run_id": "<string>",
"name": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"result": {
"label": "<string>",
"score": 123,
"explanation": "<string>"
},
"error": "<string>",
"metadata": {},
"trace_id": "<string>"
}
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({
experiment_run_id: '<string>',
name: '<string>',
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
result: {label: '<string>', score: 123, explanation: '<string>'},
error: '<string>',
metadata: {},
trace_id: '<string>'
})
};
fetch('https://api.example.com/v1/experiment_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/v1/experiment_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([
'experiment_run_id' => '<string>',
'name' => '<string>',
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'result' => [
'label' => '<string>',
'score' => 123,
'explanation' => '<string>'
],
'error' => '<string>',
'metadata' => [
],
'trace_id' => '<string>'
]),
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/v1/experiment_evaluations"
payload := strings.NewReader("{\n \"experiment_run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"result\": {\n \"label\": \"<string>\",\n \"score\": 123,\n \"explanation\": \"<string>\"\n },\n \"error\": \"<string>\",\n \"metadata\": {},\n \"trace_id\": \"<string>\"\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/v1/experiment_evaluations")
.header("Content-Type", "application/json")
.body("{\n \"experiment_run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"result\": {\n \"label\": \"<string>\",\n \"score\": 123,\n \"explanation\": \"<string>\"\n },\n \"error\": \"<string>\",\n \"metadata\": {},\n \"trace_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/experiment_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 \"experiment_run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"result\": {\n \"label\": \"<string>\",\n \"score\": 123,\n \"explanation\": \"<string>\"\n },\n \"error\": \"<string>\",\n \"metadata\": {},\n \"trace_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>"
}
}"<string>""<string>"{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
The ID of the experiment run being evaluated
The name of the evaluation
The kind of annotator used for the evaluation
Available options:
LLM, CODE, HUMAN The start time of the evaluation in ISO format
The end time of the evaluation in ISO format
The result of the evaluation. Either result or error must be provided.
Show child attributes
Show child attributes
Error message if the evaluation encountered an error. Either result or error must be provided.
Metadata for the evaluation
Optional trace ID for tracking
Response
Successful Response
Show child attributes
Show child attributes
Was this page helpful?
⌘I

