Skip to main content
POST
/
v1
/
retrievers
/
{retriever_id}
/
evaluations
Run evaluation
curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '
{
  "dataset_name": "<string>",
  "evaluation_config": {
    "k_values": [
      1,
      5,
      10,
      20
    ],
    "metrics": [
      "precision",
      "recall",
      "f1",
      "map",
      "ndcg",
      "mrr"
    ]
  }
}
'
{
  "task_id": "<string>",
  "evaluation_id": "<string>",
  "created_at": "<string>",
  "task_type": "retriever.evaluation",
  "status": "pending"
}

Headers

​
Authorization
string
required

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

​
X-Namespace
string
required

REQUIRED: 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'

Path Parameters

​
retriever_id
string
required

Body

application/json

Request to start an evaluation.

​
dataset_name
string
required

Name of the evaluation dataset to use

Minimum string length: 1
​
evaluation_config
EvaluationConfig · object

Optional evaluation configuration (uses defaults if not provided)

Response

Successful Response

Response when starting an evaluation.

​
task_id
string
required

Task ID for tracking progress

​
evaluation_id
string
required

Evaluation ID

​
created_at
string
required

Creation timestamp

​
task_type
string
default:retriever.evaluation

Task type

​
status
string
default:pending

Initial status