Update an evaluation run
curl --request PUT \
--url https://api.honeyhive.ai/v1/runs/{run_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"metadata": {},
"results": {},
"event_ids": [
"<string>"
],
"configuration": {},
"evaluators": [
"<unknown>"
],
"session_ids": [
"<string>"
],
"datapoint_ids": [
"<string>"
],
"passing_ranges": {}
}
'import requests
url = "https://api.honeyhive.ai/v1/runs/{run_id}"
payload = {
"name": "<string>",
"description": "<string>",
"metadata": {},
"results": {},
"event_ids": ["<string>"],
"configuration": {},
"evaluators": ["<unknown>"],
"session_ids": ["<string>"],
"datapoint_ids": ["<string>"],
"passing_ranges": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
metadata: {},
results: {},
event_ids: ['<string>'],
configuration: {},
evaluators: ['<unknown>'],
session_ids: ['<string>'],
datapoint_ids: ['<string>'],
passing_ranges: {}
})
};
fetch('https://api.honeyhive.ai/v1/runs/{run_id}', 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.honeyhive.ai/v1/runs/{run_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'metadata' => [
],
'results' => [
],
'event_ids' => [
'<string>'
],
'configuration' => [
],
'evaluators' => [
'<unknown>'
],
'session_ids' => [
'<string>'
],
'datapoint_ids' => [
'<string>'
],
'passing_ranges' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.honeyhive.ai/v1/runs/{run_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"results\": {},\n \"event_ids\": [\n \"<string>\"\n ],\n \"configuration\": {},\n \"evaluators\": [\n \"<unknown>\"\n ],\n \"session_ids\": [\n \"<string>\"\n ],\n \"datapoint_ids\": [\n \"<string>\"\n ],\n \"passing_ranges\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.honeyhive.ai/v1/runs/{run_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"results\": {},\n \"event_ids\": [\n \"<string>\"\n ],\n \"configuration\": {},\n \"evaluators\": [\n \"<unknown>\"\n ],\n \"session_ids\": [\n \"<string>\"\n ],\n \"datapoint_ids\": [\n \"<string>\"\n ],\n \"passing_ranges\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeyhive.ai/v1/runs/{run_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"results\": {},\n \"event_ids\": [\n \"<string>\"\n ],\n \"configuration\": {},\n \"evaluators\": [\n \"<unknown>\"\n ],\n \"session_ids\": [\n \"<string>\"\n ],\n \"datapoint_ids\": [\n \"<string>\"\n ],\n \"passing_ranges\": {}\n}"
response = http.request(request)
puts response.read_body{
"evaluation": {
"id": "<string>",
"run_id": "<string>",
"metadata": {},
"results": {},
"event_ids": [
"<string>"
],
"configuration": {},
"is_active": true,
"created_at": "<string>",
"scope_type": "<string>",
"scope_id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"metrics": {},
"updated_at": "<string>",
"dataset_id": "<string>"
},
"warning": "<string>"
}Experiments
Update an evaluation run
Update fields on an existing experiment run such as name, status, metadata, or results.
PUT
/
v1
/
runs
/
{run_id}
Update an evaluation run
curl --request PUT \
--url https://api.honeyhive.ai/v1/runs/{run_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"metadata": {},
"results": {},
"event_ids": [
"<string>"
],
"configuration": {},
"evaluators": [
"<unknown>"
],
"session_ids": [
"<string>"
],
"datapoint_ids": [
"<string>"
],
"passing_ranges": {}
}
'import requests
url = "https://api.honeyhive.ai/v1/runs/{run_id}"
payload = {
"name": "<string>",
"description": "<string>",
"metadata": {},
"results": {},
"event_ids": ["<string>"],
"configuration": {},
"evaluators": ["<unknown>"],
"session_ids": ["<string>"],
"datapoint_ids": ["<string>"],
"passing_ranges": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
metadata: {},
results: {},
event_ids: ['<string>'],
configuration: {},
evaluators: ['<unknown>'],
session_ids: ['<string>'],
datapoint_ids: ['<string>'],
passing_ranges: {}
})
};
fetch('https://api.honeyhive.ai/v1/runs/{run_id}', 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.honeyhive.ai/v1/runs/{run_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'metadata' => [
],
'results' => [
],
'event_ids' => [
'<string>'
],
'configuration' => [
],
'evaluators' => [
'<unknown>'
],
'session_ids' => [
'<string>'
],
'datapoint_ids' => [
'<string>'
],
'passing_ranges' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.honeyhive.ai/v1/runs/{run_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"results\": {},\n \"event_ids\": [\n \"<string>\"\n ],\n \"configuration\": {},\n \"evaluators\": [\n \"<unknown>\"\n ],\n \"session_ids\": [\n \"<string>\"\n ],\n \"datapoint_ids\": [\n \"<string>\"\n ],\n \"passing_ranges\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.honeyhive.ai/v1/runs/{run_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"results\": {},\n \"event_ids\": [\n \"<string>\"\n ],\n \"configuration\": {},\n \"evaluators\": [\n \"<unknown>\"\n ],\n \"session_ids\": [\n \"<string>\"\n ],\n \"datapoint_ids\": [\n \"<string>\"\n ],\n \"passing_ranges\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeyhive.ai/v1/runs/{run_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"results\": {},\n \"event_ids\": [\n \"<string>\"\n ],\n \"configuration\": {},\n \"evaluators\": [\n \"<unknown>\"\n ],\n \"session_ids\": [\n \"<string>\"\n ],\n \"datapoint_ids\": [\n \"<string>\"\n ],\n \"passing_ranges\": {}\n}"
response = http.request(request)
puts response.read_body{
"evaluation": {
"id": "<string>",
"run_id": "<string>",
"metadata": {},
"results": {},
"event_ids": [
"<string>"
],
"configuration": {},
"is_active": true,
"created_at": "<string>",
"scope_type": "<string>",
"scope_id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"metrics": {},
"updated_at": "<string>",
"dataset_id": "<string>"
},
"warning": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Request body for PUT /runs/{run_id}
Available options:
pending, completed, failed, cancelled, running Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Minimum string length:
1Show child attributes
Show child attributes
Was this page helpful?
⌘I

