Skip to content
KortexyaKortexyaReasoning Layer SDK

Interface: CompareDocumentsRequest

@kortexya/reasoninglayer

@kortexya/reasoninglayer / CompareDocumentsRequest

Interface: CompareDocumentsRequest

Section titled “Interface: CompareDocumentsRequest”

Defined in: src/types/osf-diff.ts:273

Request to compare two documents by ID.

Remarks

Section titled “Remarks”

Sent to POST /api/v1/documents/compare. A convenience over OsfDiffRequest for the common document-to-document case; it returns the same OsfDiffResponse.

Example

Section titled “Example”
const request: CompareDocumentsRequest = {
  documentAId: 'a1b2c3d4-...',
  documentBId: 'e5f6a7b8-...',
  includeEntityDiff: true,
};

Properties

Section titled “Properties”

documentAId

Section titled “documentAId”

documentAId: string

Defined in: src/types/osf-diff.ts:275

UUID of document A.

documentBId

Section titled “documentBId”

documentBId: string

Defined in: src/types/osf-diff.ts:278

UUID of document B.

includeClauseDiff?

Section titled “includeClauseDiff?”

optional includeClauseDiff?: boolean

Defined in: src/types/osf-diff.ts:281

Include the clause-level delta in the report.

includeEntityDiff?

Section titled “includeEntityDiff?”

optional includeEntityDiff?: boolean

Defined in: src/types/osf-diff.ts:284

Include the entity-level delta in the report.

threshold?

Section titled “threshold?”

optional threshold?: number | null

Defined in: src/types/osf-diff.ts:287

Minimum match degree for two entities to be considered the same (default 0.7).