Start Eval Run

POST

/org/:org_id/project/:project_id/task/:task_id/eval/run

Create an eval run and dispatch background execution.

AuthorizationBearer

Bearer token authentication using JWT tokens from Ory Kratos/Hydra

org_idstringRequiredformat: "uuid"

The organization ID

project_idstringRequiredformat: "uuid"

The project ID

task_idstringRequiredformat: "uuid"

The task ID

This endpoint expects an object.

candidate_revision_idstring or nullOptionalformat: "uuid"

eval_set_idstring or nullOptionalformat: "uuid"

task_run_idslist of strings or nullOptional

last_ninteger or nullOptional1-20

judge_model_idstring or nullOptionalformat: "uuid"

Successful Response

idstringformat: "uuid"

task_idstringformat: "uuid"

project_idstringformat: "uuid"

candidate_revision_idstringformat: "uuid"

task_run_idslist of strings

statusenum

pass_countinteger

fail_countinteger

error_countinteger

createdstring

modifiedstring

pass_ratedouble or nullRead-only

eval_set_idstring or nullformat: "uuid"

started_atstring or null

completed_atstring or null

error_messagestring or null

created_by_user_idstring or nullformat: "uuid"

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/task/task_id/eval/run \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "string",
3	"task_id": "string",
4	"project_id": "string",
5	"candidate_revision_id": "string",
6	"task_run_ids": [
7	"string"
8	],
9	"status": "pending",
10	"pass_count": 1,
11	"fail_count": 1,
12	"error_count": 1,
13	"created": "string",
14	"modified": "string",
15	"pass_rate": 1.1,
16	"eval_set_id": "string",
17	"started_at": "string",
18	"completed_at": "string",
19	"error_message": "string",
20	"created_by_user_id": "string"
21	}