Interface: CheckDocumentRequest

Defined in: src/types/document-check.ts:98

Request to check a contract document.

Remarks

Exactly one of CheckDocumentRequest.documentId or CheckDocumentRequest.document must be supplied. When both are present the already-ingested documentId wins.

optional document?: InlineDocument | null

Defined in: src/types/document-check.ts:102

…or inline content (markdown/plain text) to ingest and then check.

optional documentId?: string | null

Defined in: src/types/document-check.ts:100

Already-ingested contract document id…

optional includeFixSuggestions?: boolean

Defined in: src/types/document-check.ts:121

Include fix suggestions on findings.

true

optional includeProofTraces?: boolean

Defined in: src/types/document-check.ts:116

Include per-rule proof traces on rule-violation findings.

true

optional referenceDocumentIds?: string[]

Defined in: src/types/document-check.ts:104

Reference documents (templates/policies) to diff the contract against.

optional ruleSortFilter?: string[]

Defined in: src/types/document-check.ts:106

Rule-sort filter for the knowledge-base rules pass (empty = all rule sorts).

optional runKbRules?: boolean

Defined in: src/types/document-check.ts:111

Run the knowledge-base rules pass (needs inline document content).

true

optional threshold?: number | null

Defined in: src/types/document-check.ts:126

Entity/clause match threshold for the diff, clamped server-side to 0.1-1.0.

0.7