Rulvar API reference / @rulvar/rulvar / CitationAuditPlanOptions
Interface: CitationAuditPlanOptions
Defined in: packages/core/dist/index.d.ts
The declared audit options, exactly OrchestrateCitationAudit.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
auditScope? | "sample" | "all" | What the audit judges (RV4407): 'sample' (the default) keeps the deterministic stratified sample above byte for byte; 'all' judges EVERY anchor row of the document, no per-section pick and no maxSampled ceiling, so the verdict is a census instead of a sample. Requires resolver 2 (the census enumerates every anchor of every citing sentence, which is v2's row semantics), and one judge invocation still carries all rows: the cost scales through the prompt, so size judge.estCost for the whole document. The seventh comparison experiment's improvement plan asked for exactly this census for regulated classes. | packages/core/dist/index.d.ts |
maxSampled? | number | The hard whole-document ceiling; default 24, the judge's own budget. | packages/core/dist/index.d.ts |
pattern? | string | Overrides DEFAULT_CITATION_PATTERN; must expose path:line[-end]. | packages/core/dist/index.d.ts |
resolver? | 2 | 1 | The resolver generation (RV4208): 1, the default, is the fixed downward window above, byte identical for every existing config. 2 excerpts the bounded LOGICAL UNIT the cited line belongs to (citationUnitExcerptOf) and audits EVERY anchor of a compound sentence as its own row against its nearest claim clause. The sixth comparison experiment's false negatives were exactly window artifacts: a section heading whose support lives below the window, and only a sentence's first anchor ever sampled. Opt-in because the sample derives from the document hash: v2 changes which rows exist and what the judge reads, so a declared config must choose it. | packages/core/dist/index.d.ts |
samplePerSection? | number | Sampled citing sentences per H2 section; default 2, the judge's own method. | packages/core/dist/index.d.ts |
window? | number | Lines after the cited line an excerpt may carry; default 3. | packages/core/dist/index.d.ts |