Retriever Evaluations

Run evaluation

Changed on

Evaluate a retriever's quality using a ground truth dataset. Returns immediately with a task ID - evaluation runs asynchronously.

post/v1/retrievers/{retriever_id}/evaluations

Request

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

Path parameters

retriever_idstring required

Request body

dataset_namestring required

Name of the evaluation dataset to use

Response

Successful Response

task_idstring required

Task ID for tracking progress

evaluation_idstring required

Evaluation ID

task_typestring

Task type

statusstring

Initial status

created_atstring required

Creation timestamp

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

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API