Evaluation Run Finish

Finish an evaluation run.

POST /v2/{entity}/{project}/evaluation_runs/{evaluation_run_id}/finish

Evaluation Run Finish

cURL

curl --request POST \
  --url https://api.example.com/v2/{entity}/{project}/evaluation_runs/{evaluation_run_id}/finish \
  --header 'Content-Type: application/json' \
  --data '{
  "summary": {}
}'

import requests

url = "https://api.example.com/v2/{entity}/{project}/evaluation_runs/{evaluation_run_id}/finish"

payload = { "summary": {} }
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({summary: {}})
};

fetch('https://api.example.com/v2/{entity}/{project}/evaluation_runs/{evaluation_run_id}/finish', 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}/evaluation_runs/{evaluation_run_id}/finish",
  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([
    'summary' => [
        
    ]
  ]),
  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}/evaluation_runs/{evaluation_run_id}/finish"

	payload := strings.NewReader("{\n  \"summary\": {}\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}/evaluation_runs/{evaluation_run_id}/finish")
  .header("Content-Type", "application/json")
  .body("{\n  \"summary\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"summary\": {}\n}"

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

200

{
  "success": true
}

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

Path Parameters

entity · string · required

project · string · required

evaluation_run_id · string · required

Body

application/json

Request body for finishing an evaluation run via REST API.

This model excludes project_id and evaluation_run_id since they come from the URL path in RESTful endpoints.

summary · Summary · object | null

Optional summary dictionary for the evaluation run

Response

200

application/json

Successful Response

success · boolean · required

Whether the evaluation run was finished successfully