Retriever Evaluations

Create evaluation dataset

Changed on

Create a ground truth dataset for evaluating retrievers. Include queries with their relevant documents and optional graded relevance scores.

post/v1/retrievers/evaluations/datasets

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/retrievers/evaluations/datasets
  • Auth: HTTP bearer and API key in header X-Namespace

Request body

dataset_namestring required

Unique name for this dataset

descriptionstring nullable

Description of what this dataset measures

metadataobject nullable

Additional metadata

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

  • 436f07a84cc9Revision changes
    • breaking

      removed the success response with the status

    • info

      added the success response with the status