Skip to content

Installation

Go Module

Add structured-evaluation to your Go project:

go get github.com/plexusone/structured-evaluation

CLI Tool

Install the sevaluation command-line tool:

go install github.com/plexusone/structured-evaluation/cmd/sevaluation@latest

Verify installation:

sevaluation version

TypeScript / JavaScript

For consumers that read reports in TypeScript, @plexusone/structured-evaluation provides generated Zod schemas and TS types (Rubric, RubricSet, ClaimsReport, SummaryReport) — downstream of the same Go structs, never hand-maintained:

npm install @plexusone/structured-evaluation

import { RubricSchema, type Rubric } from '@plexusone/structured-evaluation'

const report: Rubric = RubricSchema.parse(JSON.parse(rawJson))
console.log(report.intScore) // the 1-5 score, correctly typed

Every schema is .strict() — an unrecognized key fails parsing loudly instead of silently reading undefined. See the package README for regeneration instructions and known limitations.

Requirements

  • Go 1.21 or later
  • No external dependencies required

Package Structure

Package Import Path Description
evaluation github.com/plexusone/structured-evaluation/evaluation Core evaluation types
summary github.com/plexusone/structured-evaluation/summary GO/NO-GO summary reports
combine github.com/plexusone/structured-evaluation/combine DAG-based aggregation
render/terminal github.com/plexusone/structured-evaluation/render/terminal ANSI terminal renderer
render/markdown github.com/plexusone/structured-evaluation/render/markdown Markdown renderer
render/detailed github.com/plexusone/structured-evaluation/render/detailed Detailed terminal renderer
render/box github.com/plexusone/structured-evaluation/render/box Box-format renderer
schema github.com/plexusone/structured-evaluation/schema JSON Schema definitions

Next Steps