Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/rulvar / CitationAuditRow

Interface: CitationAuditRow

Defined in: packages/core/dist/index.d.ts

One sampled citation occurrence, before any verdict.

Properties

PropertyTypeDescriptionDefined in
anchorstringThe raw citation text as it appears in the sentence.packages/core/dist/index.d.ts
anchorOrdinal?numberWhich anchor of a compound sentence this row audits (RV4208, resolver v2 only): zero-based, in sentence order. Resolver v1 samples only a sentence's FIRST anchor, so the field is absent there and on every earlier row.packages/core/dist/index.d.ts
clause?stringThe claim clause NEAREST this row's anchor (RV4208, resolver v2 only): the sentence segment, split at clause boundaries, that contains the anchor. A compound sentence cites three files for three different claims; judging each anchor against the WHOLE sentence asks whether the lines entail claims they were never cited for.packages/core/dist/index.d.ts
endLine?numberThe range end when the citation is path:start-end.packages/core/dist/index.d.ts
excerpt?stringThe resolved lines, L<n>: <text> per line. Absent when the FIRST cited line does not resolve in the host snapshot, which is itself an unsupported verdict: a citation nothing resolves is not provenance (the citedValueValidator doctrine).packages/core/dist/index.d.ts
linenumber-packages/core/dist/index.d.ts
pathstring-packages/core/dist/index.d.ts
rownumberZero-based row index, the judge's addressing.packages/core/dist/index.d.ts
sectionstringThe owning H2 marker, or '' for text above the first heading.packages/core/dist/index.d.ts
sentencestringThe citing sentence, verbatim.packages/core/dist/index.d.ts
unit?CitationExcerptUnitWhat resolver v2 excerpted (RV4208): the bounded logical unit's type, its line count, and whether the caps clipped it. Absent under resolver v1, whose window is fixed and self-describing.packages/core/dist/index.d.ts