Interface: SortDto
@kortexya/reasoninglayer / SortDto
Interface: SortDto
Section titled “Interface: SortDto”Defined in: src/types/sorts.ts:386
A sort (type) in the sort hierarchy lattice.
Sorts are types with multiple inheritance forming a lattice structure. They define feature declarations and constraints that their instances (terms) must satisfy.
Properties
Section titled “Properties”altLabels?
Section titled “altLabels?”
optionalaltLabels?:string[]
Defined in: src/types/sorts.ts:443
Synonyms (skos:altLabel) — the other words people use for this
concept, each of which resolves to it in label search, extraction and NL
query.
Remarks
Section titled “Remarks”Written by BulkSortDefinition.altLabels and curated by PatchSortRequest.altLabels / PatchSortRequest.addAltLabels.
annotations?
Section titled “annotations?”
optionalannotations?:Record<string,string>
Defined in: src/types/sorts.ts:414
Custom annotations, as declared — the map CreateSortRequest.annotations wrote and PatchSortRequest.annotations merges into.
boundConstraints?
Section titled “boundConstraints?”
optionalboundConstraints?:BoundConstraintDto[]
Defined in: src/types/sorts.ts:398
Inter-feature ordering constraints.
coextensive?
Section titled “coextensive?”
optionalcoextensive?:CoextensiveDefinitionDto[]
Defined in: src/types/sorts.ts:473
Formulas observed coextensive with SortDto.definition on some corpus, each with the number of examples it held over.
Remarks
Section titled “Remarks”These are equivalence hypotheses a curator confirms — never identities the engine asserts.
definition?
Section titled “definition?”
optionaldefinition?:string|null
Defined in: src/types/sorts.ts:464
The ONE defining formula of a defined sort, rendered
(mod_3∘id(day) = 1). undefined for a nominal sort.
Remarks
Section titled “Remarks”Without it a client reading a generated class can only guess its meaning from the name.
description?
Section titled “description?”
optionaldescription?:string|null
Defined in: src/types/sorts.ts:400
Human-readable description.
externalMatches?
Section titled “externalMatches?”
optionalexternalMatches?:ExternalMatchDto[]
Defined in: src/types/sorts.ts:478
SKOS external-ontology alignments (BFO/CCO and the like) attached to this sort by the upper-ontology aligner.
featureDeclarations?
Section titled “featureDeclarations?”
optionalfeatureDeclarations?:FeatureDescriptorDto[]
Defined in: src/types/sorts.ts:396
Feature declarations as an array of descriptors.
featureEquations?
Section titled “featureEquations?”
optionalfeatureEquations?:string[]
Defined in: src/types/sorts.ts:483
Defined (functional) features — feature = function(paths), computed
from the term rather than asserted on it, rendered one per entry.
hiddenLabels?
Section titled “hiddenLabels?”
optionalhiddenLabels?:string[]
Defined in: src/types/sorts.ts:448
Search-only labels (skos:hiddenLabel) — misspellings, abbreviations,
legacy terms. They resolve like synonyms but are never displayed.
id:
string
Defined in: src/types/sorts.ts:388
Unique identifier (UUID).
name:
string
Defined in: src/types/sorts.ts:390
Sort name (unique within tenant).
needsReview?
Section titled “needsReview?”
optionalneedsReview?:boolean
Defined in: src/types/sorts.ts:406
Whether this sort needs human review.
origin?
Section titled “origin?”
optionalorigin?:SortOriginDto|null
Defined in: src/types/sorts.ts:402
How this sort was created.
parents
Section titled “parents”parents:
string[]
Defined in: src/types/sorts.ts:394
Parent sort IDs (multiple inheritance).
pluginId?
Section titled “pluginId?”
optionalpluginId?:string|null
Defined in: src/types/sorts.ts:425
The plugin that contributed this sort, when a marketplace install created
it. undefined for every ordinary sort.
Remarks
Section titled “Remarks”A plugin’s sorts are committed under a namespaced name
(plugin:<plugin-name>:<local>) so two plugins never collide on the same
local name. This field and SortDto.pluginLocalName are what tie
that name back to its author.
pluginLocalName?
Section titled “pluginLocalName?”
optionalpluginLocalName?:string|null
Defined in: src/types/sorts.ts:433
The name the plugin author wrote, before namespacing.
Remarks
Section titled “Remarks”GET /api/v1/sorts/tenant/{id}?name_prefix=… matches this form as well as
the committed SortDto.name.
related?
Section titled “related?”
optionalrelated?:string[]
Defined in: src/types/sorts.ts:455
Associative links (skos:related) — sort ids, non-hierarchical.
scopeNote?
Section titled “scopeNote?”
optionalscopeNote?:string|null
Defined in: src/types/sorts.ts:453
Usage guidance (skos:scopeNote) — when to reach for this concept
rather than a neighbouring one. The disambiguator for near-homonyms.
status?
Section titled “status?”
optionalstatus?:SortStatusDto|null
Defined in: src/types/sorts.ts:404
Lifecycle status.
tenantId
Section titled “tenantId”tenantId:
string
Defined in: src/types/sorts.ts:392
Tenant that owns this sort.
worldMode?
Section titled “worldMode?”
optionalworldMode?:WorldModeDto
Defined in: src/types/sorts.ts:408
The world assumption this sort makes — open (default) or closed.