Skip to main content
POST
Create Benchmark

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
project_id
integer
required

Project ID

golden_dataset_id
integer
required

Golden dataset ID

name
string
required

Benchmark name

Required string length: 1 - 255
description
string | null

Benchmark description

model_ids
integer[]

Embedding models to compare, with vector search only

variants
BenchmarkVariant · object[]

Configurations to compare: a model with hybrid search or a reranker. Added after model_ids; the first configuration is the baseline the others are compared with. At least two distinct configurations in all.

top_k
integer
default:5

Number of retrieved chunks the metrics are computed on

Required range: 1 <= x <= 50

Response

Successful Response

id
integer
required
project_id
integer
required
golden_dataset_id
integer
required
name
string
required
description
string | null
required
status
enum<string>
required
Available options:
pending,
running,
completed,
failed
top_k
integer
required
results
Results · object | null
required
error_message
string | null
required
created_at
string<date-time>
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required