Retriever Benchmarks

Create benchmark

Changed on

Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior.

post/v1/retrievers/benchmarks

Request

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

Request body

benchmark_namestring required

Human-readable name for this benchmark.

baseline_retriever_idstring required

ID of the baseline retriever pipeline to compare against.

candidate_retriever_idsstring[] required

IDs of candidate retriever pipelines to evaluate.

session_countinteger

Number of sessions to include in the benchmark.

Response

Successful Response

benchmark_idstring required

Unique benchmark identifier.

benchmark_namestring required

Human-readable name.

baseline_retriever_idstring required

Baseline retriever ID.

candidate_retriever_idsstring[] required

Candidate retriever IDs.

session_countinteger required

Number of sessions in benchmark.

status'pending' | 'building_sessions' | 'replaying' | 'computing_metrics' | 'completed' | 'failed' required

Status of a benchmark run.

comparisonBenchmarkComparison (unresolved $ref)
created_atstring date-time required

Creation timestamp.

started_atstring date-time nullable

Execution start time.

completed_atstring date-time nullable

Completion time.

error_messagestring nullable

Error message if failed.

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

    • breaking

      removed the success response with the status

    • info

      added the success response with the status