Interface: ReviewCandidateInput
@kortexya/reasoninglayer / ReviewCandidateInput
Interface: ReviewCandidateInput
Section titled “Interface: ReviewCandidateInput”Defined in: src/types/reviews.ts:132
An existing term a queued entity may duplicate, as addPendingReview takes it.
Remarks
Section titled “Remarks”Only the identity and the similarity are stored; the candidate’s display
name, sort and features are read from the knowledge base when the review
is listed (as a ReviewCandidateMatchDto). The engine refuses any
other key with 422.
Properties
Section titled “Properties”similarity
Section titled “similarity”similarity:
number
Defined in: src/types/reviews.ts:136
Similarity score, within 0 to 1 (review_similarity_out_of_range).
termId
Section titled “termId”termId:
string
Defined in: src/types/reviews.ts:134
The candidate term (UUID). It must exist for the tenant (review_candidate_unknown).