Skip to main content
GET
/
v1
/
retrievers
/
{retriever_id}
/
evaluations
/
{evaluation_id}
Get evaluation results
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/{evaluation_id}
{
  "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"
    ]
  },
  "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": {},
  "error_message": "<string>"
}

Headers

​
Authorization
string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

​
authorization
string
​
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

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

​
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

Aggregated metrics across all queries

​
metrics_by_k
Metrics By K · object

Metrics broken down by K value (keys are string K values like '5', '10', '20')

​
error_message
string | null

Error message if failed