Sign in
latestOpenAPI 3.1.02026-08-235731,1372.9 MB

5307993e44d3

Retriever Benchmarks

Get benchmark

Get benchmark status and results by ID

get/v1/retrievers/benchmarks/{benchmark_id}

Path parameters

benchmark_idstring required

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.