Skip to main content
POST
Generate evaluation dataset from interactions

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 header returns 403; an invalid or revoked key returns 401.

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

Body

application/json

Request to auto-generate an evaluation dataset from user interactions.

dataset_name
string | null

Name for the generated dataset. If omitted, defaults to 'auto_{retriever_id}_{date}'.

min_interactions
integer
default:5

Minimum number of positive interactions a query must have to be included in the dataset. Queries with fewer interactions are excluded as low-confidence ground truth.

Required range: x >= 1
lookback_days
integer
default:30

How many days of interaction history to consider.

Required range: 1 <= x <= 365
positive_interaction_types
string[] | null

Interaction types considered positive signals. Defaults to: click, purchase, positive_feedback, bookmark, share.

Response

Successful Response

Complete evaluation dataset with metadata.

An evaluation dataset is a collection of queries with ground truth relevance labels, used to measure retriever quality.

dataset_id
string
required

Unique dataset identifier

dataset_name
string
required

Human-readable dataset name

queries
GroundTruthQuery · object[]
required

List of queries with ground truth

created_at
string<date-time>
required

When dataset was created

updated_at
string<date-time>
required

Last update timestamp

namespace_id
string
required

Namespace this dataset belongs to

internal_id
string
required

Internal organization ID

query_count
integer
required

Number of queries in dataset

description
string | null

Dataset description

metadata
Metadata · object | null

Additional metadata (e.g., labeling instructions, version info)