API Reference v1

Public TypeScript surface exported by @icodenet/eval-dashboards.

Install and import

pnpm add @icodenet/eval-dashboards

import {
  validateEvalReport,
  summarizeReport,
  checkGates,
  createEvalReportArtifact,
  writeEvalReportArtifact,
} from '@icodenet/eval-dashboards';

Core model exports

  • EvalReportV1, EvalRow, EvalRun, EvalSuiteSummary
  • SuiteManifest, GatePolicy, RiskArea, DatasetSource, GraderKind
  • TraceReference, ConversationTurn, ToolCall
  • EVAL_REPORT_SCHEMA_VERSION, rowKey, rowMatchedExpectation, summarizeReport

Validation, history, and gating

  • validateEvalReport (ValidationResult)
  • assessBaselineCompatibility
  • buildHistory, compareRuns (RunHistoryEntry, RunComparison)
  • checkGates (GateConfig, GateResult)
  • lintReportTaxonomy, lintReportsTaxonomy (TaxonomyLintResult)

Reporting, publishing, and config

  • renderGroupedIndexHtml
  • publishReport (PublishOptions, PublishResult, PublishTarget)
  • loadConfig, mergeConfig (EvalReportsConfig)
  • BUILT_IN_THEMES, resolveTheme (EvalReportsTheme)
  • formatDate, formatPassRate, formatDuration, formatCount

Adapters and adjudication

  • createEvalReportArtifact, writeEvalReportArtifact
  • RunnerEvalResult, RunnerEvalCaseResult
  • exportUnresolvedRowsBundle, mergeAdjudicationBundle, validateAdjudicationBundle

Canonical references