Interface: AddPendingReviewRequest
@kortexya/reasoninglayer / AddPendingReviewRequest
Interface: AddPendingReviewRequest
Section titled “Interface: AddPendingReviewRequest”Defined in: src/types/reviews.ts:341
Request to add a pending review for an entity.
Remarks
Section titled “Remarks”Creates a new review entry for human review of an extracted or ingested entity. The tenant and the owner are the authenticated principal’s: the body cannot name either.
Properties
Section titled “Properties”candidates
Section titled “candidates”candidates:
ReviewCandidateInput[]
Defined in: src/types/reviews.ts:343
Existing terms the entity may duplicate, best match first.
confidence
Section titled “confidence”confidence:
number
Defined in: src/types/reviews.ts:345
Confidence score, within 0 to 1.
entityId
Section titled “entityId”entityId:
string
Defined in: src/types/reviews.ts:347
Entity local identifier.
features
Section titled “features”features:
Record<string,unknown>
Defined in: src/types/reviews.ts:349
Entity features.
reason
Section titled “reason”reason:
ReviewReason
Defined in: src/types/reviews.ts:351
Reason why an entity requires review.
reasonDetail?
Section titled “reasonDetail?”
optionalreasonDetail?:string|null
Defined in: src/types/reviews.ts:353
The producer’s own sentence about the reason.
sort:
string
Defined in: src/types/reviews.ts:355
Sort name assigned to the entity; it must exist for the tenant.
sortSuggestions
Section titled “sortSuggestions”sortSuggestions:
ReviewSortSuggestion[]
Defined in: src/types/reviews.ts:357
Alternative sort suggestions for the entity; each must exist for the tenant.
sourceDocument?
Section titled “sourceDocument?”
optionalsourceDocument?:string|null
Defined in: src/types/reviews.ts:359
Source document reference.
sourceText?
Section titled “sourceText?”
optionalsourceText?:string|null
Defined in: src/types/reviews.ts:361
Source text excerpt.