Skip to main content
POST
Run evaluation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retriever_id
string
required

Body

application/json

Request to start an evaluation.

dataset_name
string
required

Name of the evaluation dataset to use

Minimum string length: 1
evaluation_config
EvaluationConfig · object | null

Optional evaluation configuration (uses defaults if not provided)

Response

Successful Response

Response when starting an evaluation.

task_id
string
required

Task ID for tracking progress

evaluation_id
string
required

Evaluation ID

created_at
string
required

Creation timestamp

task_type
string
default:retriever.evaluation

Task type

status
string
default:pending

Initial status