Release a claimed evaluation or annotation

Release a previously claimed evaluation or annotation without submitting a score. Works on any evaluation status. Clears humanEvaluatorStartedAt. See Evaluations.

POST /evaluations/{id}/release

Release a claimed evaluation or annotation

cURL

curl --request POST \
  --url https://api.galtea.ai/evaluations/{id}/release \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.galtea.ai/evaluations/{id}/release"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.galtea.ai/evaluations/{id}/release', 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.galtea.ai/evaluations/{id}/release",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.galtea.ai/evaluations/{id}/release"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.galtea.ai/evaluations/{id}/release")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galtea.ai/evaluations/{id}/release")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "id": "eval_123",
  "metricId": "metric_123",
  "sessionId": "session_123",
  "userId": "user_123",
  "status": "SUCCESS",
  "inferenceResultId": "ir_123",
  "score": 0.95,
  "reason": "High quality response",
  "error": "<string>",
  "canRetry": false,
  "creditsUsed": 1,
  "conversationSimulatorVersion": "1.0.0",
  "humanEvaluatorId": "<string>",
  "humanEvaluatorStartedAt": "2023-11-07T05:31:56Z",
  "humanScore": 123,
  "humanReason": "<string>",
  "humanEvaluatorFinishedAt": "2023-11-07T05:31:56Z",
  "failedTurns": [
    "<string>"
  ],
  "monitorId": "<string>",
  "monitorSettledAtTurn": 123,
  "monitorSamplingPercentage": 123,
  "deletedAt": "2023-11-07T05:31:56Z",
  "evaluatedAt": "2023-11-07T05:31:56Z",
  "metricLegacyAt": "2023-11-07T05:31:56Z",
  "metricDisabledAt": "2023-11-07T05:31:56Z",
  "testCaseLegacyAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "error": "Error type",
  "message": "Error message description"
}

{
  "error": "Error type",
  "message": "Error message description"
}

{
  "error": "Error type",
  "message": "Error message description"
}

Authorizations

Authorization · string · header · required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Path Parameters

id · string · required

Evaluation ID

Response

200

application/json

Evaluation released successfully

id · string · required

Example:

"eval_123"

metricId · string · required

Example:

"metric_123"

sessionId · string · required

Example:

"session_123"

userId · string | null · required

Example:

"user_123"

status · enum<string> · required

Available options: PENDING, PENDING_HUMAN, SUCCESS, FAILED, SKIPPED, CANCELLED

Example:

"SUCCESS"

inferenceResultId · string | null · required

Example:

"ir_123"

score · number | null · required

Example:

0.95

reason · string | null · required

Example:

"High quality response"

error · string | null · required

canRetry · boolean | null · required

Example:

false

creditsUsed · integer | null · required

Example:

1

conversationSimulatorVersion · string | null · required

Example:

"1.0.0"

humanEvaluatorId · string | null · required

User ID of the human evaluator

humanEvaluatorStartedAt · string<date-time> | null · required

humanScore · number | null · required

Human-provided annotation score

humanReason · string | null · required

Human-provided annotation reason

humanEvaluatorFinishedAt · string<date-time> | null · required

Timestamp when human evaluation was submitted

failedTurns · string[] · required

Conversation turns that failed

monitorId · string | null · required

ID of the monitor that dispatched this evaluation

monitorSettledAtTurn · integer | null · required

Session turn count when the monitor scored it

monitorSamplingPercentage · number | null · required

Sampling percentage in effect when the monitor scored this session

deletedAt · string<date-time> | null · required

evaluatedAt · string<date-time> | null · required

metricLegacyAt · string<date-time> | null · required

metricDisabledAt · string<date-time> | null · required

testCaseLegacyAt · string<date-time> | null · required

createdAt · string<date-time>