Interface: OsfSearchEntityDto
@kortexya/reasoninglayer / OsfSearchEntityDto
Interface: OsfSearchEntityDto
Section titled “Interface: OsfSearchEntityDto”Defined in: src/types/query.ts:87
An entity matched by a structured (OSF) search.
Remarks
Section titled “Remarks”features keys are feature names of the matched term (data, not schema), so
they arrive verbatim. Each value is the feature’s value rendered as a string.
Properties
Section titled “Properties”communityId
Section titled “communityId”communityId:
string
Defined in: src/types/query.ts:95
Community the entity belongs to.
features
Section titled “features”features:
Record<string,string>
Defined in: src/types/query.ts:97
Key features of the entity, each value rendered as a string.
matchDegree
Section titled “matchDegree”matchDegree:
number
Defined in: src/types/query.ts:93
Match degree in [0, 1].
matchReason?
Section titled “matchReason?”
optionalmatchReason?:string
Defined in: src/types/query.ts:101
Why this entity matched.
optionalname?:string
Defined in: src/types/query.ts:99
Human-readable name, when the term has one.
sortId
Section titled “sortId”sortId:
string
Defined in: src/types/query.ts:91
Sort id of the matched entity. Resolve it to a name through the sort catalog.
termId
Section titled “termId”termId:
string
Defined in: src/types/query.ts:89
Term id of the matched entity.