Interface: SimilaritySearchResponse
@kortexya/reasoninglayer / SimilaritySearchResponse
Interface: SimilaritySearchResponse
Section titled “Interface: SimilaritySearchResponse”Defined in: src/types/fuzzy.ts:226
Response from similarity search.
Remarks
Section titled “Remarks”Wraps a list of SimilarityMatch results with a total count.
Used by both findSimilar and searchTopK endpoints.
Properties
Section titled “Properties”count:
number
Defined in: src/types/fuzzy.ts:228
Number of results returned.
coverage?
Section titled “coverage?”
optionalcoverage?:SearchCoverageDto|null
Defined in: src/types/fuzzy.ts:248
What the search caps dropped, when they dropped anything.
Remarks
Section titled “Remarks”Absent on an exhaustive search. Tells a caller whether to narrow the sort or raise the caps.
exhaustive
Section titled “exhaustive”exhaustive:
boolean
Defined in: src/types/fuzzy.ts:240
Whether the search saw everything it should have.
Remarks
Section titled “Remarks”false means candidates were dropped BEFORE any similarity degree was
computed, so a better match may exist among them: this response is a
SAMPLE, not an answer. See SimilaritySearchResponse.coverage for
what was dropped.
results
Section titled “results”results:
SimilarityMatch[]
Defined in: src/types/fuzzy.ts:230
List of matching terms with similarity scores.