Skip to content
KortexyaKortexyaReasoning Layer SDK

Interface: PatchSortRequest

@kortexya/reasoninglayer

@kortexya/reasoninglayer / PatchSortRequest

Interface: PatchSortRequest

Section titled “Interface: PatchSortRequest”

Defined in: src/types/sorts.ts:1312

Curate one concept’s vocabulary and lifecycle.

Remarks

Section titled “Remarks”

Every field is optional and only present fields mutate, so adding a synonym cannot blank a scope note the caller never read.

altLabels / hiddenLabels REPLACE the set; addAltLabels appends to it. Both exist because a tree view edits a whole set while an “add synonym” box appends one term without re-sending the rest.

This route does not edit feature declarations — the engine refuses a features key rather than dropping it. Add or amend a declaration with SortsClient.bulkCreateSorts, remove one with SortsClient.removeSortFeature, rename one or clear its description or index directive with SortsClient.patchSortFeature.

Properties

Section titled “Properties”

addAltLabels?

Section titled “addAltLabels?”

optional addAltLabels?: string[] | null

Defined in: src/types/sorts.ts:1320

Append synonyms, keeping the existing ones.

altLabels?

Section titled “altLabels?”

optional altLabels?: string[] | null

Defined in: src/types/sorts.ts:1318

Replace the synonym set (skos:altLabel).

annotations?

Section titled “annotations?”

optional annotations?: Record<string, string> | null

Defined in: src/types/sorts.ts:1328

Set custom annotations, merged key by key over the existing map.

description?

Section titled “description?”

optional description?: string | null

Defined in: src/types/sorts.ts:1316

Set the human-readable definition (skos:definition).

hiddenLabels?

Section titled “hiddenLabels?”

optional hiddenLabels?: string[] | null

Defined in: src/types/sorts.ts:1322

Replace the search-only label set (skos:hiddenLabel).

name?

Section titled “name?”

optional name?: string | null

Defined in: src/types/sorts.ts:1314

Rename the concept. skos:prefLabel for a sort IS its name.

Section titled “related?”

optional related?: string[] | null

Defined in: src/types/sorts.ts:1324

Replace the skos:related set. Symmetric — the other side gains the edge too.

scopeNote?

Section titled “scopeNote?”

optional scopeNote?: string | null

Defined in: src/types/sorts.ts:1326

Set the scope note. An empty string clears it.

worldMode?

Section titled “worldMode?”

optional worldMode?: WorldModeDto | null

Defined in: src/types/sorts.ts:1338

Change the sort’s world assumption.

Remarks

Section titled “Remarks”

Closing an open sort makes its required features bite and its undeclared features inadmissible — existing terms that break either are not retro-validated, but the next write to them is judged by the new mode.