Skip to content

rulvar API reference


rulvar API reference / @rulvar/evals

@rulvar/evals

Classes

ClassDescription
EvalJudgeErrorThrown when a judge run does not settle ok.

Interfaces

InterfaceDescription
CanaryDriftReport-
CanaryProbeSet-
CheckpointArm-
CheckpointCell-
CheckpointLadderOne declared checkpoint ladder: rungs are concrete pool members.
CheckpointPool-
CheckpointReport-
CriterionOneReport-
CriterionTwoReport-
EvalCaseOne quality-measurement case. The shape is the documented interface verbatim; display names derive from the workflow name (the suite runner disambiguates duplicates by ordinal).
EvalCaseResultThe measured result of one EvalCase.
EvalCommitterOptions-
EvalMatrixReport-
EvalSuiteResultAggregate view of a suite run.
GoldenGraderOptions-
Grader@rulvar/evals: quality measurement strictly on the public APIs (L6). EvalCase with golden, rubric, and LLM-judge graders; judge calls run through the engine (journaled, budgeted, VCR-recordable), so eval CI is deterministic; config-matrix comparison reports pass-rate, cost, and latency per cell. Matrix sweeps feeding ModelKnowledge, the eval-committer identity, and canary fingerprints are the M11 round-3 extensions.
GraderContextWhat a grader sees; judge() is the only channel back into the engine.
GraderVerdictOne grader's outcome for one case.
JudgeGraderOptions-
JudgeSpecA judge invocation specification. The judge runs through the engine as an ordinary journaled, budgeted invocation; model selection is subject to the router quality floors, and @rulvar/evals ships NO default judge model: weak defaults for judging are forbidden, so the model is always explicit.
MatrixCellOne configuration under comparison.
MatrixCellReport-
MeasuredClaimInput-
OrchestratedCase-
RubricCriterion-
RubricGraderOptions-
RunCheckpointOptions-
RunEvalCaseOptions@rulvar/evals: quality measurement strictly on the public APIs (L6). EvalCase with golden, rubric, and LLM-judge graders; judge calls run through the engine (journaled, budgeted, VCR-recordable), so eval CI is deterministic; config-matrix comparison reports pass-rate, cost, and latency per cell. Matrix sweeps feeding ModelKnowledge, the eval-committer identity, and canary fingerprints are the M11 round-3 extensions.
RunEvalSuiteOptions@rulvar/evals: quality measurement strictly on the public APIs (L6). EvalCase with golden, rubric, and LLM-judge graders; judge calls run through the engine (journaled, budgeted, VCR-recordable), so eval CI is deterministic; config-matrix comparison reports pass-rate, cost, and latency per cell. Matrix sweeps feeding ModelKnowledge, the eval-committer identity, and canary fingerprints are the M11 round-3 extensions.
RunSweepOptions-
SweepCaseAn eval case bound to the taskClass axis of the matrix.
SweepCellReport-
SweepModelOne fixed pool member; effort is part of the claim subject identity.
SweepPool-
SweepReport-
SweepThresholds-

Variables

VariableDescription
JUDGE_VERDICT_SCHEMAThe default judge verdict shape.
SWEEP_THRESHOLD_DEFAULTS-

Functions

FunctionDescription
canaryFingerprintRuns the fixed probe set through the ordinary engine and returns the fingerprint. Probes run sequentially in declaration order, one run per probe, so recordings replay deterministically.
commitEvalMeasuredCommits measured claims through the eval-committer gate with the documented rebase recipe: on a CAS rejection, re-read current() and retry against the fresh version. Returns the committed version.
evalMeasuredClaimOne measured claim; claimExpiry applies the TTL from the decay table.
flipStaleOnCanaryDriftFlips the model's ACTIVE eval-measured claims to stale when their recorded canary fingerprint differs from the fresh one. Claims without a recorded fingerprint have no baseline and stay untouched (the documented no-probe posture); a second run is an idempotent noop. CAS-rebased like every maintenance commit.
goldenGrader-
judgeGrader-
normalizeCanaryOutputThe committed v1 normalization (OQ-06): NFC, trim, collapse whitespace.
renderCheckpointReportThe deterministic render for the M12 gate docs amendment.
rubricGrader-
runEvalCase@rulvar/evals: quality measurement strictly on the public APIs (L6). EvalCase with golden, rubric, and LLM-judge graders; judge calls run through the engine (journaled, budgeted, VCR-recordable), so eval CI is deterministic; config-matrix comparison reports pass-rate, cost, and latency per cell. Matrix sweeps feeding ModelKnowledge, the eval-committer identity, and canary fingerprints are the M11 round-3 extensions.
runEvalMatrixRuns the same case list against every cell's engine, sequentially and in declaration order (deterministic cassette consumption), and reports per-cell aggregates for side-by-side comparison.
runEvalSuite@rulvar/evals: quality measurement strictly on the public APIs (L6). EvalCase with golden, rubric, and LLM-judge graders; judge calls run through the engine (journaled, budgeted, VCR-recordable), so eval CI is deterministic; config-matrix comparison reports pass-rate, cost, and latency per cell. Matrix sweeps feeding ModelKnowledge, the eval-committer identity, and canary fingerprints are the M11 round-3 extensions.
rungRuleHoldsThe OQ-09 cell rule (shared by the per-cell and pooled verdicts).
runSweepMatrixRuns the fixed matrix sequentially in declaration order (deterministic cassette consumption), aggregates per (model, taskClass) cell, emits threshold-crossing claims, and commits them through the eval-committer identity when a store is given.
runValueCheckpointRuns the checkpoint over the fixed pool. Sequential in declaration order (deterministic cassette consumption when recorded); every cell runs baseline then treatment.