rubric

package

Go to main page

Versions in this module

v0

v0.11.0

Jul 20, 2026

Changes in this version

type CategoryResult

+ Severity Severity

type Severity

+ func WorstSeverity(findings []Finding) Severity

v0.10.0

Jul 20, 2026

Changes in this version

type Category

+ Criteria []Criterion

+ func (c *Category) IsComposite() bool

+ type Criterion struct

+ Fail CriterionLevel

+ ID string

+ Name string

+ Partial CriterionLevel

+ Pass CriterionLevel

+ Weight float64

+ type CriterionLevel struct

+ Description string

+ Indicators []string

type RubricPassCriteria

+ ScoreThresholds *ScoreThresholds

+ type ScoreThresholds struct

+ Partial int

+ Pass int

v0.9.0

Jul 12, 2026

Changes in this version

+ const CategoryARCH

+ const CategoryDOC

+ const CategoryINFRA

+ const CategoryMETRIC

+ const CategoryREQ

+ const CategorySCALE

+ const CategorySCOPE

+ const CategorySEC

+ const CategoryUSER

+ const CategoryUX

+ const ExtensionKeyCoverage

+ const SchemaVersionV2

+ var LegacyCodeMapping = map[ReasonCode]ReasonCode

+ var ReasonCodeRegistry = map[ReasonCode]ReasonCodeInfo

+ func AllReasonCodeCategories() []string

+ func CountFindingsByCode(findings []Finding) map[ReasonCode]int

+ func GetRepairPrompt(code ReasonCode) string

+ func RequiresHumanReview(code ReasonCode) bool

+ func ValidIntegerScoreValues() []int

+ func ValidReasonCodes() []string

type CategoryResult

+ Confidence float64

+ IntScore IntegerScore

+ ReasonCodes []ReasonCode

+ func NewCategoryResultWithIntScore(category string, intScore IntegerScore, confidence float64, reasoning string) *CategoryResult

+ func (cr *CategoryResult) AddReasonCode(code ReasonCode) *CategoryResult

+ func (cr *CategoryResult) AddReasonCodes(codes ...ReasonCode) *CategoryResult

+ func (cr *CategoryResult) HasLowConfidence(threshold ...float64) bool

+ func (cr *CategoryResult) SetConfidence(confidence float64) *CategoryResult

+ func (cr *CategoryResult) SetIntScore(score IntegerScore) *CategoryResult

+ type CoverageReport struct

+ Overall int

+ Sections map[string]CoverageSection

+ func NewCoverageReport() *CoverageReport

+ func (cr *CoverageReport) AddSection(name string, section CoverageSection)

+ func (cr *CoverageReport) AllComplete() bool

+ func (cr *CoverageReport) ComputeOverall() int

+ func (cr *CoverageReport) ComputeOverallWeighted(weights map[string]float64) int

+ func (cr *CoverageReport) GetSection(name string) CoverageSection

+ func (cr *CoverageReport) HasSection(name string) bool

+ func (cr *CoverageReport) MeetsThreshold(threshold int) bool

+ func (cr *CoverageReport) SectionsAboveThreshold(threshold int) []string

+ func (cr *CoverageReport) SectionsBelowThreshold(threshold int) []string

+ func (cr *CoverageReport) SetSection(name string, total, complete int, missing []string) *CoverageReport

+ type CoverageSection struct

+ Complete int

+ Missing []string

+ Percentage int

+ Total int

type Finding

+ Code ReasonCode

+ Location string

+ func NewFinding(id, category string, severity Severity, title, description string) *Finding

+ func NewFindingWithCode(id, category string, code ReasonCode, title, description string) *Finding

+ func (f *Finding) GetCodeInfo() *ReasonCodeInfo

+ func (f *Finding) GetRepairHint() string

+ func (f *Finding) GetRepairPrompt() string

+ func (f *Finding) SetCode(code ReasonCode) *Finding

+ func (f *Finding) SetEffort(effort string) *Finding

+ func (f *Finding) SetEvidence(evidence string) *Finding

+ func (f *Finding) SetLocation(location string) *Finding

+ func (f *Finding) SetOwner(owner string) *Finding

+ func (f *Finding) SetRecommendation(recommendation string) *Finding

+ type IntegerScore int

+ const ScoreAcceptable

+ const ScoreExcellent

+ const ScoreGood

+ const ScoreMajorRevisions

+ const ScoreUnacceptable

+ func AllIntegerScores() []IntegerScore

+ func ParseIntegerScore(score int) IntegerScore

+ func (s IntegerScore) Icon() string

+ func (s IntegerScore) IsPassing() bool

+ func (s IntegerScore) IsValid() bool

+ func (s IntegerScore) String() string

+ func (s IntegerScore) ToCategorical() ScoreValue

type PassCriteria

+ MinIntScore IntegerScore

+ type ReasonCode string

+ const CodeARCHCircularDep

+ const CodeARCHGap

+ const CodeARCHMissingDep

+ const CodeARCHNoAPI

+ const CodeARCHNoDataModel

+ const CodeARCHNoErrorHandling

+ const CodeARCHNoInterface

+ const CodeARCHTightCoupling

+ const CodeDOCInconsistent

+ const CodeDOCInsufficient

+ const CodeDOCNoDiagram

+ const CodeDOCNoExamples

+ const CodeDOCOutdated

+ const CodeINFRAEnvMismatch

+ const CodeINFRANoAlert

+ const CodeINFRANoBackup

+ const CodeINFRANoDeploy

+ const CodeINFRANoMonitor

+ const CodeINFRANoRecovery

+ const CodeINFRANoRollback

+ const CodeINFRANoRunbook

+ const CodeMETRICMissingKPI

+ const CodeMETRICNoBaseline

+ const CodeMETRICNoTarget

+ const CodeMETRICNoTracking

+ const CodeMETRICUnmeasurable

+ const CodeMETRICUnrealistic

+ const CodeMETRICVanity

+ const CodeOther

+ const CodeREQAmbiguous

+ const CodeREQConflict

+ const CodeREQIncomplete

+ const CodeREQMissingReason

+ const CodeREQNoCriteria

+ const CodeREQUntestable

+ const CodeSCALEBlockingOp

+ const CodeSCALEConcern

+ const CodeSCALENoCache

+ const CodeSCALENoCapacity

+ const CodeSCALENoRateLimit

+ const CodeSCALEPerformance

+ const CodeSCALESPOF

+ const CodeSCOPECreep

+ const CodeSCOPEMVPUnclear

+ const CodeSCOPENoConstr

+ const CodeSCOPENoNonGoals

+ const CodeSCOPENoTimeline

+ const CodeSCOPEUnbounded

+ const CodeSECGap

+ const CodeSECHardcodedSecret

+ const CodeSECInjectionRisk

+ const CodeSECNoAuth

+ const CodeSECNoAuthz

+ const CodeSECNoEncryption

+ const CodeSECNoValidation

+ const CodeSECPrivacy

+ const CodeUSERIncomplete

+ const CodeUSERNoGoals

+ const CodeUSERNoJourney

+ const CodeUSERNoPainPoints

+ const CodeUSERNoPersona

+ const CodeUSERUnclearProblem

+ const CodeUXIncompleteNav

+ const CodeUXNoARIA

+ const CodeUXNoEmpty

+ const CodeUXNoErrorState

+ const CodeUXNoFeedback

+ const CodeUXNoKeyboard

+ const CodeUXNoLoading

+ const CodeUXNoResponsive

+ func GetBlockingCodes(findings []Finding) []ReasonCode

+ func GetReasonCodesByCategory(category string) []ReasonCode

+ func GetReasonCodesBySpecType(specType string) []ReasonCode

+ func NormalizeCode(code ReasonCode) ReasonCode

+ type ReasonCodeInfo struct

+ Category string

+ Code ReasonCode

+ DefaultSeverity Severity

+ Description string

+ RepairPrompt string

+ RequiresHuman bool

+ SpecTypes []string

+ func GetReasonCodeInfo(code ReasonCode) *ReasonCodeInfo

type Rubric

+ Blocking []ReasonCode

+ Confidence float64

+ Extensions map[string]any

+ IntScore IntegerScore

+ Pass bool

+ SchemaVersion string

+ func (r *Rubric) AddBlocking(code ReasonCode) *Rubric

+ func (r *Rubric) CollectBlockingCodes() []ReasonCode

+ func (r *Rubric) ComputeOverallConfidence() float64

+ func (r *Rubric) ComputeOverallIntScore(rubricSet *RubricSet) IntegerScore

+ func (r *Rubric) GetCoverage() *CoverageReport

+ func (r *Rubric) GetExtension(key string) any

+ func (r *Rubric) HasExtension(key string) bool

+ func (r *Rubric) HasLowConfidence(threshold ...float64) bool

+ func (r *Rubric) IsV2() bool

+ func (r *Rubric) NeedsHumanReview(confidenceThreshold ...float64) bool

+ func (r *Rubric) SetBlocking(codes []ReasonCode) *Rubric

+ func (r *Rubric) SetConfidence(confidence float64) *Rubric

+ func (r *Rubric) SetCoverage(coverage *CoverageReport)

+ func (r *Rubric) SetExtension(key string, value any)

+ func (r *Rubric) SetIntScore(score IntegerScore) *Rubric

+ func (r *Rubric) SetPass(pass bool) *Rubric

v0.8.0

Jun 20, 2026

v0.7.0

Jun 7, 2026

Changes in this version

+ func ValidDecisionStatusValues() []string

+ func ValidEvaluationTypeValues() []string

+ func ValidScaleTypeValues() []string

+ func ValidScoreValues() []string

+ func ValidSeverityValues() []string

+ type ValidationIssue struct

+ ActualValue string

+ AllowedValues []string

+ Code string

+ Message string

+ Path string

+ Severity ValidationSeverity

+ type ValidationResult struct

+ ErrorCount int

+ Issues []ValidationIssue

+ Valid bool

+ WarningCount int

+ func ValidateReport(r *Rubric) *ValidationResult

+ func ValidateRubricSetV2(rs *RubricSet) *ValidationResult

+ func (r *ValidationResult) HasErrors() bool

+ func (r *ValidationResult) HasWarnings() bool

+ func (r *ValidationResult) String() string

+ type ValidationSeverity string

+ const ValidationError

+ const ValidationWarning

v0.6.0

Jun 1, 2026

Changes in this version

+ func AllRequiredPassing(results []CategoryResult, rubric *RubricSet) bool

+ type ActionItem struct

+ Action string

+ Category string

+ Effort string

+ Owner string

+ Severity Severity

+ type AggregationMethod string

+ const AggregationConservative

+ const AggregationMajority

+ const AggregationOptimistic

+ const AggregationUnanimous

+ type Annotation struct

+ AnnotatorID string

+ AnnotatorType string

+ Explanation string

+ Label string

+ Name string

+ Score float64

+ type CategoricalAgreement struct

+ ConfusionMatrix map[string]int

+ ExactAgreement float64

+ SampleSize int

+ func ComputeCategoricalAgreement(results1, results2 []CategoryResult) *CategoricalAgreement

+ type Category struct

+ Description string

+ EvaluationPrompt string

+ Examples *CategoryExamples

+ ID string

+ Name string

+ Required bool

+ Scale Scale

+ Weight float64

+ func NewCategory(id, name, description string) *Category

+ func (c *Category) AddOption(value, label string, criteria ...string) *Category

+ func (c *Category) GetOptionForValue(value string) *ScaleOption

+ func (c *Category) SetEvaluationPrompt(prompt string) *Category

+ func (c *Category) SetExamples(examples *CategoryExamples) *Category

+ func (c *Category) SetRequired(required bool) *Category

+ func (c *Category) SetWeight(weight float64) *Category

+ func (c *Category) WithBinary(passCriteria, failCriteria []string) *Category

+ func (c *Category) WithChecklist(required, optional []string, threshold *ChecklistThreshold) *Category

+ func (c *Category) WithLikert(config *LikertConfig) *Category

+ func (c *Category) WithLikert5(anchors []LikertAnchor) *Category

+ func (c *Category) WithPassPartialFail(passCriteria, partialCriteria, failCriteria []string) *Category

+ type CategoryExamples struct

+ Fail *Example

+ Partial *Example

+ Pass *Example

+ type CategoryResult struct

+ Category string

+ ChecklistResults *ChecklistResults

+ Evidence []string

+ Findings []Finding

+ NumericScore *float64

+ Reasoning string

+ Score ScoreValue

+ func NewCategoryResult(category string, score ScoreValue, reasoning string) *CategoryResult

+ func NewCategoryResultFromLikert(category string, likertScore int, config *LikertConfig, reasoning string) *CategoryResult

+ func NewCategoryResultWithNumeric(category string, score ScoreValue, numericScore float64, reasoning string) *CategoryResult

+ func (cr *CategoryResult) AddEvidence(evidence ...string) *CategoryResult

+ func (cr *CategoryResult) AddFinding(f Finding) *CategoryResult

+ func (cr *CategoryResult) GetNumericScore() float64

+ func (cr *CategoryResult) HasNumericScore() bool

+ func (cr *CategoryResult) IsPassing() bool

+ func (cr *CategoryResult) SetChecklistResults(results *ChecklistResults) *CategoryResult

+ func (cr *CategoryResult) SetNumericScore(score float64) *CategoryResult

+ type CategoryResultCounts struct

+ Fail int

+ Partial int

+ Pass int

+ Total int

+ func CountResults(results []CategoryResult) CategoryResultCounts

+ func (c CategoryResultCounts) AllPassing() bool

+ type ChecklistResults struct

+ OptionalMissing []string

+ OptionalPresent []string

+ RequiredMissing []string

+ RequiredPresent []string

+ type ChecklistThreshold struct

+ Optional int

+ Required string

+ type Decision struct

+ CategoryCounts CategoryResultCounts

+ FindingCounts FindingCounts

+ Passed bool

+ Rationale string

+ Status DecisionStatus

+ func EvaluateResults(results []CategoryResult, findings []Finding, criteria PassCriteria, ...) Decision

+ type DecisionStatus string

+ const DecisionConditional

+ const DecisionFail

+ const DecisionHumanReview

+ const DecisionPass

+ type EvaluationType string

+ const EvaluationTypeAnalytic

+ const EvaluationTypeHolistic

+ type Example struct

+ Excerpt string

+ Reasoning string

+ type Finding struct

+ Category string

+ Description string

+ Effort string

+ Evidence string

+ ID string

+ Owner string

+ Recommendation string

+ Severity Severity

+ Title string

+ func (f *Finding) IsBlocking() bool

+ type FindingCounts struct

+ Critical int

+ High int

+ Info int

+ Low int

+ Medium int

+ Total int

+ func CountFindings(findings []Finding) FindingCounts

+ func (c FindingCounts) BlockingCount() int

+ func (c FindingCounts) HasBlocking() bool

+ type FindingLimits struct

+ Critical int

+ High int

+ Low int

+ Medium int

+ type IRRMetrics struct

+ AdjacentAgreement float64

+ ExactAgreement float64

+ MeanAbsoluteDifference float64

+ PearsonCorrelation float64

+ SampleSize int

+ func ComputeIRR(pairs []RatingPair) *IRRMetrics

+ func ComputeIRRFromResults(results1, results2 []CategoryResult) *IRRMetrics

+ type JudgeCategoricalScore struct

+ JudgeID string

+ Score ScoreValue

+ type JudgeDisagreement struct

+ Category string

+ Scores []JudgeCategoricalScore

+ UniqueScores int

+ type JudgeMetadata struct

+ EvaluatedAt time.Time

+ JudgeID string

+ Latency time.Duration

+ MaxTokens int

+ Model string

+ ModelProvider string

+ ModelVersion string

+ PromptTemplate string

+ PromptVersion string

+ RubricID string

+ RubricVersion string

+ SpanID string

+ SystemPrompt string

+ Temperature float64

+ TokensUsed *TokenUsage

+ TraceID string

+ func NewJudgeMetadata(model string) *JudgeMetadata

+ func (j *JudgeMetadata) SetLatency(d time.Duration)

+ func (j *JudgeMetadata) WithPrompt(template, version string) *JudgeMetadata

+ func (j *JudgeMetadata) WithProvider(provider string) *JudgeMetadata

+ func (j *JudgeMetadata) WithRubric(id, version string) *JudgeMetadata

+ func (j *JudgeMetadata) WithTemperature(temp float64) *JudgeMetadata

+ func (j *JudgeMetadata) WithTokenUsage(input, output int) *JudgeMetadata

+ func (j *JudgeMetadata) WithTrace(traceID, spanID string) *JudgeMetadata

+ type LikertAnchor struct

+ Description string

+ Label string

+ Value int

+ func StandardLikert5Anchors() []LikertAnchor

+ type LikertConfig struct

+ Anchors []LikertAnchor

+ Max int

+ Min int

+ PartialThreshold *int

+ PassThreshold *int

+ type MultiJudgeResult struct

+ AggregatedCategories []CategoryResult

+ AggregationMethod AggregationMethod

+ Agreement float64

+ ConsolidatedDecision Decision

+ ConsolidatedFindings []Finding

+ Disagreements []JudgeDisagreement

+ Evaluations []*Rubric

+ Judges []*JudgeMetadata

+ func AggregateEvaluations(evaluations []*Rubric, method AggregationMethod) *MultiJudgeResult

+ type NextSteps struct

+ Immediate []ActionItem

+ Recommended []ActionItem

+ RerunCommand string

+ type PairwiseCategoryScore struct

+ Category string

+ Margin float64

+ Reasoning string

+ Winner PairwiseWinner

+ type PairwiseComparison struct

+ CategoryScores []PairwiseCategoryScore

+ Confidence float64

+ CreatedAt time.Time

+ ID string

+ Input string

+ Judge *JudgeMetadata

+ Metadata map[string]any

+ OutputA string

+ OutputB string

+ Reasoning string

+ Winner PairwiseWinner

+ func NewPairwiseComparison(input, outputA, outputB string) *PairwiseComparison

+ func (p *PairwiseComparison) AddCategoryScore(category string, winner PairwiseWinner, reasoning string, margin float64)

+ func (p *PairwiseComparison) SetWinner(winner PairwiseWinner, reasoning string, confidence float64)

+ func (p *PairwiseComparison) SwappedComparison() *PairwiseComparison

+ type PairwiseResult struct

+ Comparisons []PairwiseComparison

+ Confidence float64

+ OverallWinner PairwiseWinner

+ TieRate float64

+ WinRateA float64

+ WinRateB float64

+ func ComputePairwiseResult(comparisons []PairwiseComparison) *PairwiseResult

+ type PairwiseWinner string

+ const WinnerA

+ const WinnerB

+ const WinnerTie

+ const WinnerUncertain

+ type PassCriteria struct

+ MaxFindings *FindingLimits

+ MinCategoriesPassing string

+ func DefaultPassCriteria() PassCriteria

+ func StrictPassCriteria() PassCriteria

+ type RatingPair struct

+ Category string

+ ItemID string

+ Rater1 float64

+ Rater2 float64

+ type ReferenceData struct

+ Annotations []Annotation

+ Context []string

+ ExpectedOutput string

+ ExpectedOutputs []string

+ ID string

+ Input string

+ Metadata map[string]any

+ Source string

+ Tags []string

+ func NewReferenceData(input, expectedOutput string) *ReferenceData

+ func (r *ReferenceData) WithAnnotation(name string, score float64, annotatorID string) *ReferenceData

+ func (r *ReferenceData) WithContext(ctx ...string) *ReferenceData

+ type ReferenceDataset struct

+ Description string

+ ID string

+ Items []ReferenceData

+ Metadata map[string]any

+ Name string

+ Tags []string

+ Version string

+ func NewReferenceDataset(id, name string) *ReferenceDataset

+ func (d *ReferenceDataset) AddItem(item ReferenceData)

+ func (d *ReferenceDataset) GetByID(id string) *ReferenceData

+ type ReportMetadata struct

+ Document string

+ DocumentID string

+ DocumentTitle string

+ DocumentVersion string

+ GeneratedAt time.Time

+ GeneratedBy string

+ ReviewerID string

+ type Rubric struct

+ Categories []CategoryResult

+ Decision Decision

+ Findings []Finding

+ Judge *JudgeMetadata

+ Metadata ReportMetadata

+ NextSteps NextSteps

+ OverallDecision string

+ PassCriteria PassCriteria

+ Reference *ReferenceData

+ ReviewType string

+ RubricID string

+ RubricVersion string

+ Schema string

+ Summary string

+ func NewRubric(reviewType, document string) *Rubric

+ func (r *Rubric) AddCategoryResult(cr CategoryResult)

+ func (r *Rubric) AddFinding(f Finding)

+ func (r *Rubric) Evaluate(rubricSet *RubricSet) Decision

+ func (r *Rubric) Finalize(rubricSet *RubricSet, rerunCommand string)

+ func (r *Rubric) GenerateNextSteps(rerunCommand string)

+ func (r *Rubric) GenerateSummary() string

+ func (r *Rubric) GetCategoryResult(categoryID string) *CategoryResult

+ func (r *Rubric) SetJudge(judge *JudgeMetadata)

+ func (r *Rubric) SetPassCriteria(criteria PassCriteria)

+ func (r *Rubric) SetReference(ref *ReferenceData)

+ func (r *Rubric) SetRubricInfo(rubricID, rubricVersion string)

+ type RubricMetadata struct

+ Author string

+ BasedOn []string

+ CreatedAt string

+ type RubricPassCriteria struct

+ MaxFindings *FindingLimits

+ MinCategoriesPassing string

+ type RubricSet struct

+ Categories []Category

+ Description string

+ EvaluationType EvaluationType

+ ID string

+ JudgePromptTemplate string

+ Metadata *RubricMetadata

+ Name string

+ PassCriteria RubricPassCriteria

+ Version string

+ func NewRubricSet(id, name, version string) *RubricSet

+ func (rs *RubricSet) AddCategory(cat Category) *RubricSet

+ func (rs *RubricSet) GetCategory(id string) *Category

+ func (rs *RubricSet) GetRequiredCategories() []Category

+ func (rs *RubricSet) SetJudgePrompt(template string) *RubricSet

+ func (rs *RubricSet) SetMetadata(meta *RubricMetadata) *RubricSet

+ func (rs *RubricSet) SetPassCriteria(criteria RubricPassCriteria) *RubricSet

+ func (rs *RubricSet) ToJSON() ([]byte, error)

+ func (rs *RubricSet) Validate() []string

+ type Scale struct

+ LikertConfig *LikertConfig

+ OptionalItems []string

+ Options []ScaleOption

+ PassingThreshold *ChecklistThreshold

+ RequiredItems []string

+ Type ScaleType

+ type ScaleOption struct

+ Criteria []string

+ Label string

+ Value string

+ type ScaleType string

+ const ScaleTypeBinary

+ const ScaleTypeCategorical

+ const ScaleTypeChecklist

+ const ScaleTypeLikert

+ type ScoreValue string

+ const ScoreFail

+ const ScorePartial

+ const ScorePass

+ func LikertToCategorical(score int, config *LikertConfig) ScoreValue

+ func (s ScoreValue) Icon() string

+ func (s ScoreValue) IsFailing() bool

+ func (s ScoreValue) IsPartial() bool

+ func (s ScoreValue) IsPassing() bool

+ type Severity string

+ const SeverityCritical

+ const SeverityHigh

+ const SeverityInfo

+ const SeverityLow

+ const SeverityMedium

+ func AllSeverities() []Severity

+ func (s Severity) Icon() string

+ func (s Severity) IsBlocking() bool

+ func (s Severity) Weight() int

+ type TokenUsage struct

+ CacheReadTokens int

+ CacheWriteTokens int

+ InputTokens int

+ OutputTokens int

+ TotalTokens int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL