SkillKit.Eval.Check (SkillKit v0.4.0)

Copy Markdown View Source

A single pass/fail assertion produced while scoring an eval.

A SkillKit.Eval.Result is the collection of checks for one eval run; the run passes only when every check passes. :detail carries a human-readable explanation, surfaced in ExUnit failure output. :warning carries a non-fatal note on a passing check — a minor, non-critical deviation the judge flagged but did not fail on.

Summary

Types

t()

Functions

fail(name, detail)

Builds a failing check.

new(name, passed, detail \\ nil)

Builds a check with an explicit pass/fail and optional detail.

pass(name, detail \\ nil, warning \\ nil)

Builds a passing check, optionally carrying a non-fatal warning note.

Types

t()

@type t() :: %SkillKit.Eval.Check{
  detail: String.t() | nil,
  name: String.t(),
  passed: boolean(),
  warning: String.t() | nil
}

Functions

fail(name, detail)

@spec fail(String.t(), String.t()) :: t()

Builds a failing check.

new(name, passed, detail \\ nil)

@spec new(String.t(), boolean(), String.t() | nil) :: t()

Builds a check with an explicit pass/fail and optional detail.

pass(name, detail \\ nil, warning \\ nil)

@spec pass(String.t(), String.t() | nil, String.t() | nil) :: t()

Builds a passing check, optionally carrying a non-fatal warning note.