Get evaluation results

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

import requests

url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}"

headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Namespace': '<api-key>'}
};

fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_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.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}",
  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>",
    "X-Namespace: <api-key>"
  ],
]);

$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.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")

	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.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}")

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

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

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

{
  "evaluation_id": "<string>",
  "retriever_id": "<string>",
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "config": {
    "k_values": [
      1,
      5,
      10,
      20
    ],
    "metrics": [
      "precision",
      "recall",
      "f1",
      "map",
      "ndcg",
      "mrr"
    ],
    "k_multiples_of_relevant": [
      1,
      2
    ]
  },
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "namespace_id": "<string>",
  "internal_id": "<string>",
  "query_count": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "overall_metrics": {},
  "metrics_by_k": {},
  "total_queries": 123,
  "evaluated_queries": 123,
  "skipped_queries": 123,
  "error_message": "<string>",
  "query_results": [
    {
      "query_id": "<string>",
      "status": "<string>",
      "error": "<string>",
      "retrieved_count": 123,
      "relevant_count": 123,
      "metrics": {}
    }
  ],
  "baseline_evaluation_id": "<string>",
  "weight_set_id": "<string>",
  "verdict": {
    "passed": true,
    "reason": "<string>",
    "primary_metric": "<string>",
    "compared_metrics": 0,
    "regressed_metrics": [
      "<string>"
    ],
    "skipped_metrics": [
      "<string>"
    ],
    "per_metric": {}
  }
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

GET

retrievers

{retriever_id}

evaluations

{evaluation_id}

Get evaluation results

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

import requests

url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}"

headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Namespace': '<api-key>'}
};

fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_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.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}",
  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>",
    "X-Namespace: <api-key>"
  ],
]);

$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.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")

	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.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}")

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

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

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

{
  "evaluation_id": "<string>",
  "retriever_id": "<string>",
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "config": {
    "k_values": [
      1,
      5,
      10,
      20
    ],
    "metrics": [
      "precision",
      "recall",
      "f1",
      "map",
      "ndcg",
      "mrr"
    ],
    "k_multiples_of_relevant": [
      1,
      2
    ]
  },
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "namespace_id": "<string>",
  "internal_id": "<string>",
  "query_count": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "overall_metrics": {},
  "metrics_by_k": {},
  "total_queries": 123,
  "evaluated_queries": 123,
  "skipped_queries": 123,
  "error_message": "<string>",
  "query_results": [
    {
      "query_id": "<string>",
      "status": "<string>",
      "error": "<string>",
      "retrieved_count": 123,
      "relevant_count": 123,
      "metrics": {}
    }
  ],
  "baseline_evaluation_id": "<string>",
  "weight_set_id": "<string>",
  "verdict": {
    "passed": true,
    "reason": "<string>",
    "primary_metric": "<string>",
    "compared_metrics": 0,
    "regressed_metrics": [
      "<string>"
    ],
    "skipped_metrics": [
      "<string>"
    ],
    "per_metric": {}
  }
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

Authorizations

Authorization

string

header

required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

X-Namespace

string

header

required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

retriever_id

string

required

evaluation_id

string

required

Response

Successful Response

Complete evaluation record with results.

evaluation_id

string

required

Unique evaluation identifier

retriever_id

string

required

ID of retriever being evaluated

dataset_id

string

required

ID of dataset used for evaluation

dataset_name

string

required

Name of dataset

config

EvaluationConfig · object

required

Evaluation configuration

Show child attributes

status

enum<string>

required

Current status

Available options:

pending,

in_progress,

completed,

failed

created_at

string<date-time>

required

When evaluation was created

updated_at

string<date-time>

required

Last update timestamp

namespace_id

string

required

Namespace ID

internal_id

string

required

Internal organization ID

query_count

integer

required

Number of queries evaluated

completed_at

string<date-time> | null

When evaluation completed

overall_metrics

Overall Metrics · object | null

Aggregated metrics across all queries

Show child attributes

metrics_by_k

Metrics By K · object | null

Metrics broken down by K value (keys are string K values like '5', '10', '20', plus '2r' for each multiple in k_multiples_of_relevant)

Show child attributes

total_queries

integer | null

Total queries in the dataset for this run (= evaluated_queries + skipped_queries).

evaluated_queries

integer | null

Number of queries that produced metrics. May be < total_queries when some queries were skipped (skip-and-continue on empty/failing input).

skipped_queries

integer | null

Number of queries skipped during evaluation (empty query_input or a per-query execution failure) — these did not fail the whole eval.

error_message

string | null

Error message if failed

query_results

QueryOutcome · object[] | null

Per-query outcomes: which branch each attempted query took and the actual error for skips, so an all-skipped run is actionable from the record without worker-log access.

Show child attributes

baseline_evaluation_id

string | null

For a trained weight set's evaluation: the evaluation of the live configuration on the same dataset that this run was gated against.

weight_set_id

string | null

For a trained weight set's evaluation: the weight set this run scored. When the verdict passed, the stage's learning_config.shipped_weight_set carries the same id.

verdict

GateVerdict · object | null

For a trained weight set's evaluation: the gate verdict against baseline_evaluation_id, with both scores for every metric. A refused set keeps the live configuration.

Show child attributes

Namespaces

Buckets

Collections

Feature Extractors

Documents

Retrievers

Enrich & Improve

Automate

Administer

Advanced

Get evaluation results

Authorizations

Path Parameters

Response