Skip to main content

evals.routes

FastAPI routes for evaluation runs.

RunEvalsRequest Objects​

class RunEvalsRequest(BaseModel)

Request body for triggering an eval run.

EvalReportResponse Objects​

class EvalReportResponse(BaseModel)

Serialized eval report.

run_evals​

@router.post(
    "/agents/{agent_id}/evals/run",
    response_model=EvalReportResponse,
)
async def run_evals(agent_id: str,
                    body: RunEvalsRequest) -> EvalReportResponse

Trigger an evaluation run for the specified agent.

POST /api/v1/agents/{agent_id}/evals/run

list_evals​

@router.get(
    "/agents/{agent_id}/evals",
    response_model=list[EvalReportResponse],
)
async def list_evals(agent_id: str) -> list[EvalReportResponse]

List past evaluation runs for an agent.

GET /api/v1/agents/{agent_id}/evals

get_eval​

@router.get(
    "/agents/{agent_id}/evals/{eval_id}",
    response_model=EvalReportResponse,
)
async def get_eval(agent_id: str, eval_id: str) -> EvalReportResponse

Get a specific evaluation report.

GET /api/v1/agents/{agent_id}/evals/{eval_id}