Download Evaluation Results

curl --request GET \
  --url https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download"

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

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

print(response.text)

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

fetch('https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download', 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.nugen.in/api/v3/evaluations/{evaluation_id}/download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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.nugen.in/api/v3/evaluations/{evaluation_id}/download"

	req, _ := http.NewRequest("GET", 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.get("https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download")

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

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

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

{
  "evaluation_id": "eval-xyz789",
  "status": "READY",
  "model_id": "alignment-abc123-deployed",
  "benchmark_id": "task-def456",
  "method": "eval",
  "metrics": {
    "accuracy": 0.92,
    "relevance": 0.88,
    "overall_score": 0.9,
    "uncertainty": 0.15,
    "domain_violations": 2
  },
  "raw_answers_count": 50,
  "detailed_results": [
    {
      "question_id": "q1",
      "question": "What is the main purpose of the product?",
      "expected_answer": "To provide customer support automation",
      "model_answer": "The main purpose is to provide automated customer support solutions",
      "score": 0.95,
      "relevance": 0.92
    },
    {
      "question_id": "q2",
      "question": "How does the pricing work?",
      "expected_answer": "Monthly subscription based on usage",
      "model_answer": "Pricing is based on a monthly subscription model",
      "score": 0.88,
      "relevance": 0.85
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:45:00Z"
}

Evaluations

Download Evaluation Results

Download evaluation results as a JSON file.

This endpoint returns the complete evaluation results as a downloadable JSON file. The file includes all metrics, scores, and detailed evaluation data.

Path Parameters:

evaluation_id: Unique evaluation identifier

Returns:

JSON file download containing:

Single model evaluation: All metrics, scores, and detailed results
Comparison mode: Both models’ metrics, scores, and comparison data

Response Headers:

Content-Type: application/json
Content-Disposition: attachment; filename=evaluation_results_{evaluation_id}.json or evaluation_comparison_{evaluation_id}.json

Raises:

404: If evaluation not found or doesn’t belong to the authenticated user
400: If evaluation is not yet completed

Example Request:

GET /api/v3/evaluations/eval-xyz789/download
Headers: {"Authorization": "Bearer <api_key>"}

Example Downloaded File (Single Model):

{
  "evaluation_id": "eval-xyz789",
  "status": "READY",
  "model_id": "aligned-model-01kmqm4nrn9fw6r",
  "benchmark_id": "task-abc123",
  "metrics": {
    "accuracy": 0.92,
    "relevance": 0.88,
    "average_score": 0.90
  },
  "detailed_results": [
    {
      "question": "What is the main purpose?",
      "expected_answer": "To provide...",
      "model_answer": "The main purpose is to provide...",
      "score": 0.95
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:45:00Z"
}

Notes:

Returns formatted JSON with proper indentation
Only available for completed evaluations

GET

api

evaluations

{evaluation_id}

download

Download Evaluation Results

curl --request GET \
  --url https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download"

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

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

print(response.text)

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

fetch('https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download', 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.nugen.in/api/v3/evaluations/{evaluation_id}/download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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.nugen.in/api/v3/evaluations/{evaluation_id}/download"

	req, _ := http.NewRequest("GET", 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.get("https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/evaluations/{evaluation_id}/download")

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

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

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

{
  "evaluation_id": "eval-xyz789",
  "status": "READY",
  "model_id": "alignment-abc123-deployed",
  "benchmark_id": "task-def456",
  "method": "eval",
  "metrics": {
    "accuracy": 0.92,
    "relevance": 0.88,
    "overall_score": 0.9,
    "uncertainty": 0.15,
    "domain_violations": 2
  },
  "raw_answers_count": 50,
  "detailed_results": [
    {
      "question_id": "q1",
      "question": "What is the main purpose of the product?",
      "expected_answer": "To provide customer support automation",
      "model_answer": "The main purpose is to provide automated customer support solutions",
      "score": 0.95,
      "relevance": 0.92
    },
    {
      "question_id": "q2",
      "question": "How does the pricing work?",
      "expected_answer": "Monthly subscription based on usage",
      "model_answer": "Pricing is based on a monthly subscription model",
      "score": 0.88,
      "relevance": 0.85
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:45:00Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

evaluation_id

string

required

Response

Successfully returns evaluation results as a downloadable JSON file

Get Evaluation Results Delete Evaluation

Alignment Project

Models

Agents

Documents

Benchmark

Evaluations

Inference

Download Evaluation Results

Authorizations

Path Parameters

Response