Skip to main content

PromptEvaluationsClient

adaline.prompts.evaluations kicks off evaluation runs against a prompt, inspects their status, and cancels them. Per-row results are accessed through the nested .results sub-client. For long-running evaluations, prefer adaline.initEvaluationResults() — it wraps .results.list in a self-refreshing cache.

Access

The class is also exported directly:

Sub-client

Types from @adaline/api:

list()

List evaluations for a prompt (paginated). Filter by status, evaluator, or dataset.

Parameters

Returns

Promise<ListEvaluationsResponse> with { data: Evaluation[]; pagination: Pagination }.

Example


create()

Start a new evaluation run. Runs asynchronously on the server — poll results with evaluations.results.list(...) or wrap with adaline.initEvaluationResults().

Parameters

Returns

Promise<Evaluation> — the queued evaluation.

Example


get()

Fetch a single evaluation by ID (metadata + aggregate scores, not per-row results).

Example


cancel()

Cancel an in-flight evaluation. In-progress rows keep running to completion, but no new rows will start.

Example


See Also