Retriever Evaluations

Generate evaluation dataset from interactions

Changed on

Auto-generate a ground truth evaluation dataset by mining user interactions for this retriever. Queries with sufficient positive interactions (click, purchase, bookmark, etc.) are used to infer relevance labels, creating a dataset suitable for offline evaluation.

post/v1/retrievers/{retriever_id}/evaluations/generate-from-interactions

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations/generate-from-interactions
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

retriever_idstring required

Request body

dataset_namestring nullable

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

min_interactionsinteger

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.

lookback_daysinteger

How many days of interaction history to consider.

positive_interaction_typesstring[] nullable

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

Response

Successful Response

dataset_idstring required

Unique dataset identifier

dataset_namestring required

Human-readable dataset name

descriptionstring nullable

Dataset description

created_atstring date-time required

When dataset was created

updated_atstring date-time required

Last update timestamp

namespace_idstring required

Namespace this dataset belongs to

internal_idstring required

Internal organization ID

query_countinteger required

Number of queries in dataset

metadataobject nullable

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

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 38e0822db900Revision changes
    • breaking

      removed the success response with the status

    • info

      added the success response with the status