Skip to content
KortexyaKortexyaReasoning Layer SDK

Vocabulary

@kortexya/reasoninglayer

@kortexya/reasoninglayer / Vocabulary

Vocabulary

Section titled “Vocabulary”

Shipped types of the governed controlled vocabulary (/api/v1/vocabulary/*).

Remarks

Section titled “Remarks”

A tenant’s vocabulary is a chain of immutable candidate revisions, decisions and releases. One release at a time is ACTIVE; activation materializes its records as Psi-terms of the first-party knowledge-organization plugin (com.kortexya.knowledge-organization). Nothing in the vocabulary creates a sort, a parent edge or a rule.

Wire format: snake_case JSON, mapped to camelCase by src/normalizers/vocabulary.ts. A wire field that is optional or null is an absent (undefined) property here. Record unions are internally tagged: kind for a record, by for a record reference and op for a record operation; the tag values travel verbatim.

Keys of a user-keyed map (mintedIds client references, assessment metrics, release recordCounts, manifest policies) are data and keep their wire spelling.

References

Section titled “References”

ActivateVocabularyReleaseRequest

Section titled “ActivateVocabularyReleaseRequest”

Re-exports ActivateVocabularyReleaseRequest

ApproveVocabularyCandidateRequest

Section titled “ApproveVocabularyCandidateRequest”

Re-exports ApproveVocabularyCandidateRequest

AssessVocabularyRevisionRequest

Section titled “AssessVocabularyRevisionRequest”

Re-exports AssessVocabularyRevisionRequest

CreateVocabularyCandidateRequest

Section titled “CreateVocabularyCandidateRequest”

Re-exports CreateVocabularyCandidateRequest

GetVocabularyConceptQuery

Section titled “GetVocabularyConceptQuery”

Re-exports GetVocabularyConceptQuery

ListVocabularyCandidatesQuery

Section titled “ListVocabularyCandidatesQuery”

Re-exports ListVocabularyCandidatesQuery

ListVocabularyConceptsQuery

Section titled “ListVocabularyConceptsQuery”

Re-exports ListVocabularyConceptsQuery

ListVocabularyReleaseRecordsQuery

Section titled “ListVocabularyReleaseRecordsQuery”

Re-exports ListVocabularyReleaseRecordsQuery

ListVocabularySchemesQuery

Section titled “ListVocabularySchemesQuery”

Re-exports ListVocabularySchemesQuery

RebaseVocabularyCandidateRequest

Section titled “RebaseVocabularyCandidateRequest”

Re-exports RebaseVocabularyCandidateRequest

RejectVocabularyCandidateRequest

Section titled “RejectVocabularyCandidateRequest”

Re-exports RejectVocabularyCandidateRequest

ReleaseVocabularyCandidateRequest

Section titled “ReleaseVocabularyCandidateRequest”

Re-exports ReleaseVocabularyCandidateRequest

ReviewVocabularyCandidateRequest

Section titled “ReviewVocabularyCandidateRequest”

Re-exports ReviewVocabularyCandidateRequest

SaveVocabularyRevisionRequest

Section titled “SaveVocabularyRevisionRequest”

Re-exports SaveVocabularyRevisionRequest

SubmitVocabularyCandidateRequest

Section titled “SubmitVocabularyCandidateRequest”

Re-exports SubmitVocabularyCandidateRequest

VocabularyAboutnessInput

Section titled “VocabularyAboutnessInput”

Re-exports VocabularyAboutnessInput

VocabularyAboutnessRecord

Section titled “VocabularyAboutnessRecord”

Re-exports VocabularyAboutnessRecord

VocabularyActivation

Section titled “VocabularyActivation”

Re-exports VocabularyActivation

VocabularyActivationPage

Section titled “VocabularyActivationPage”

Re-exports VocabularyActivationPage

VocabularyActivationResult

Section titled “VocabularyActivationResult”

Re-exports VocabularyActivationResult

VocabularyActiveRelease

Section titled “VocabularyActiveRelease”

Re-exports VocabularyActiveRelease

VocabularyAssessment

Section titled “VocabularyAssessment”

Re-exports VocabularyAssessment

VocabularyAssessmentCompleteness

Section titled “VocabularyAssessmentCompleteness”

Re-exports VocabularyAssessmentCompleteness

VocabularyAssessmentLimits

Section titled “VocabularyAssessmentLimits”

Re-exports VocabularyAssessmentLimits

VocabularyAssessmentLimitsInput

Section titled “VocabularyAssessmentLimitsInput”

Re-exports VocabularyAssessmentLimitsInput

VocabularyAssessmentOutcome

Section titled “VocabularyAssessmentOutcome”

Re-exports VocabularyAssessmentOutcome

VocabularyAssessmentSummary

Section titled “VocabularyAssessmentSummary”

Re-exports VocabularyAssessmentSummary

VocabularyAuthorityCheck

Section titled “VocabularyAuthorityCheck”

Re-exports VocabularyAuthorityCheck

VocabularyAuthorityReferenceInput

Section titled “VocabularyAuthorityReferenceInput”

Re-exports VocabularyAuthorityReferenceInput

VocabularyAuthorityReferenceRecord

Section titled “VocabularyAuthorityReferenceRecord”

Re-exports VocabularyAuthorityReferenceRecord

VocabularyBaseline

Section titled “VocabularyBaseline”

Re-exports VocabularyBaseline

VocabularyBaselineStatus

Section titled “VocabularyBaselineStatus”

Re-exports VocabularyBaselineStatus

VocabularyCandidate

Section titled “VocabularyCandidate”

Re-exports VocabularyCandidate

VocabularyCandidateDetail

Section titled “VocabularyCandidateDetail”

Re-exports VocabularyCandidateDetail

VocabularyCandidatePage

Section titled “VocabularyCandidatePage”

Re-exports VocabularyCandidatePage

VocabularyCandidateRevision

Section titled “VocabularyCandidateRevision”

Re-exports VocabularyCandidateRevision

VocabularyCandidateState

Section titled “VocabularyCandidateState”

Re-exports VocabularyCandidateState

VocabularyCommittedResult

Section titled “VocabularyCommittedResult”

Re-exports VocabularyCommittedResult

VocabularyConceptDetail

Section titled “VocabularyConceptDetail”

Re-exports VocabularyConceptDetail

VocabularyConceptHistory

Section titled “VocabularyConceptHistory”

Re-exports VocabularyConceptHistory

VocabularyConceptInput

Section titled “VocabularyConceptInput”

Re-exports VocabularyConceptInput

VocabularyConceptPage

Section titled “VocabularyConceptPage”

Re-exports VocabularyConceptPage

VocabularyConceptRecord

Section titled “VocabularyConceptRecord”

Re-exports VocabularyConceptRecord

VocabularyConceptRelease

Section titled “VocabularyConceptRelease”

Re-exports VocabularyConceptRelease

VocabularyConceptStatus

Section titled “VocabularyConceptStatus”

Re-exports VocabularyConceptStatus

VocabularyConceptSummary

Section titled “VocabularyConceptSummary”

Re-exports VocabularyConceptSummary

VocabularyConceptView

Section titled “VocabularyConceptView”

Re-exports VocabularyConceptView

VocabularyContext

Section titled “VocabularyContext”

Re-exports VocabularyContext

VocabularyContextComponent

Section titled “VocabularyContextComponent”

Re-exports VocabularyContextComponent

VocabularyContextManifest

Section titled “VocabularyContextManifest”

Re-exports VocabularyContextManifest

VocabularyContextRef

Section titled “VocabularyContextRef”

Re-exports VocabularyContextRef

VocabularyContextState

Section titled “VocabularyContextState”

Re-exports VocabularyContextState

VocabularyCriterion

Section titled “VocabularyCriterion”

Re-exports VocabularyCriterion

VocabularyCriterionResult

Section titled “VocabularyCriterionResult”

Re-exports VocabularyCriterionResult

VocabularyCriterionStatus

Section titled “VocabularyCriterionStatus”

Re-exports VocabularyCriterionStatus

VocabularyCurrentState

Section titled “VocabularyCurrentState”

Re-exports VocabularyCurrentState

VocabularyDecision

Section titled “VocabularyDecision”

Re-exports VocabularyDecision

VocabularyDecisionKind

Section titled “VocabularyDecisionKind”

Re-exports VocabularyDecisionKind

VocabularyDecisionResult

Section titled “VocabularyDecisionResult”

Re-exports VocabularyDecisionResult

VocabularyDefinitionGuidance

Section titled “VocabularyDefinitionGuidance”

Re-exports VocabularyDefinitionGuidance

VocabularyDefinitionInput

Section titled “VocabularyDefinitionInput”

Re-exports VocabularyDefinitionInput

VocabularyDefinitionRecord

Section titled “VocabularyDefinitionRecord”

Re-exports VocabularyDefinitionRecord

VocabularyDisplayLabel

Section titled “VocabularyDisplayLabel”

Re-exports VocabularyDisplayLabel

VocabularyEvidenceInput

Section titled “VocabularyEvidenceInput”

Re-exports VocabularyEvidenceInput

VocabularyEvidenceProvenance

Section titled “VocabularyEvidenceProvenance”

Re-exports VocabularyEvidenceProvenance

VocabularyEvidenceRecord

Section titled “VocabularyEvidenceRecord”

Re-exports VocabularyEvidenceRecord

VocabularyEvidenceSubject

Section titled “VocabularyEvidenceSubject”

Re-exports VocabularyEvidenceSubject

VocabularyEvidenceSubjectKind

Section titled “VocabularyEvidenceSubjectKind”

Re-exports VocabularyEvidenceSubjectKind

VocabularyEvidenceSupportInput

Section titled “VocabularyEvidenceSupportInput”

Re-exports VocabularyEvidenceSupportInput

VocabularyEvidenceSupportRecord

Section titled “VocabularyEvidenceSupportRecord”

Re-exports VocabularyEvidenceSupportRecord

VocabularyEvidenceView

Section titled “VocabularyEvidenceView”

Re-exports VocabularyEvidenceView

VocabularyFinding

Section titled “VocabularyFinding”

Re-exports VocabularyFinding

VocabularyFindingCode

Section titled “VocabularyFindingCode”

Re-exports VocabularyFindingCode

VocabularyFindingContext

Section titled “VocabularyFindingContext”

Re-exports VocabularyFindingContext

VocabularyFindingDisposition

Section titled “VocabularyFindingDisposition”

Re-exports VocabularyFindingDisposition

VocabularyFindingDispositionInput

Section titled “VocabularyFindingDispositionInput”

Re-exports VocabularyFindingDispositionInput

VocabularyFindingDispositionView

Section titled “VocabularyFindingDispositionView”

Re-exports VocabularyFindingDispositionView

VocabularyFindingSeverity

Section titled “VocabularyFindingSeverity”

Re-exports VocabularyFindingSeverity

VocabularyIdentityDecisionInput

Section titled “VocabularyIdentityDecisionInput”

Re-exports VocabularyIdentityDecisionInput

VocabularyIdentityDecisionRecord

Section titled “VocabularyIdentityDecisionRecord”

Re-exports VocabularyIdentityDecisionRecord

VocabularyIdentityOutcome

Section titled “VocabularyIdentityOutcome”

Re-exports VocabularyIdentityOutcome

VocabularyLabelRecord

Section titled “VocabularyLabelRecord”

Re-exports VocabularyLabelRecord

VocabularyLabelRole

Section titled “VocabularyLabelRole”

Re-exports VocabularyLabelRole

VocabularyLabelSearchHit

Section titled “VocabularyLabelSearchHit”

Re-exports VocabularyLabelSearchHit

VocabularyLabelSearchResult

Section titled “VocabularyLabelSearchResult”

Re-exports VocabularyLabelSearchResult

VocabularyLabelUseInput

Section titled “VocabularyLabelUseInput”

Re-exports VocabularyLabelUseInput

VocabularyLabelUseRecord

Section titled “VocabularyLabelUseRecord”

Re-exports VocabularyLabelUseRecord

VocabularyLabelUseView

Section titled “VocabularyLabelUseView”

Re-exports VocabularyLabelUseView

VocabularyLanguageObligation

Section titled “VocabularyLanguageObligation”

Re-exports VocabularyLanguageObligation

VocabularyMatchKind

Section titled “VocabularyMatchKind”

Re-exports VocabularyMatchKind

VocabularyMaterialized

Section titled “VocabularyMaterialized”

Re-exports VocabularyMaterialized

VocabularyMembershipInput

Section titled “VocabularyMembershipInput”

Re-exports VocabularyMembershipInput

VocabularyMembershipRecord

Section titled “VocabularyMembershipRecord”

Re-exports VocabularyMembershipRecord

VocabularyMembershipStatus

Section titled “VocabularyMembershipStatus”

Re-exports VocabularyMembershipStatus

VocabularyMembershipView

Section titled “VocabularyMembershipView”

Re-exports VocabularyMembershipView

VocabularyMigrationClass

Section titled “VocabularyMigrationClass”

Re-exports VocabularyMigrationClass

VocabularyMigrationPreview

Section titled “VocabularyMigrationPreview”

Re-exports VocabularyMigrationPreview

VocabularyMigrationPreviewEntry

Section titled “VocabularyMigrationPreviewEntry”

Re-exports VocabularyMigrationPreviewEntry

VocabularyMutationOptions

Section titled “VocabularyMutationOptions”

Re-exports VocabularyMutationOptions

VocabularyOperation

Section titled “VocabularyOperation”

Re-exports VocabularyOperation

VocabularyPageQuery

Section titled “VocabularyPageQuery”

Re-exports VocabularyPageQuery

VocabularyPersistenceState

Section titled “VocabularyPersistenceState”

Re-exports VocabularyPersistenceState

VocabularyPluginBinding

Section titled “VocabularyPluginBinding”

Re-exports VocabularyPluginBinding

VocabularyPluginFinding

Section titled “VocabularyPluginFinding”

Re-exports VocabularyPluginFinding

VocabularyPluginObservation

Section titled “VocabularyPluginObservation”

Re-exports VocabularyPluginObservation

VocabularyPolicies

Section titled “VocabularyPolicies”

Re-exports VocabularyPolicies

VocabularyProposedConcept

Section titled “VocabularyProposedConcept”

Re-exports VocabularyProposedConcept

VocabularyProposedLabel

Section titled “VocabularyProposedLabel”

Re-exports VocabularyProposedLabel

VocabularyRebaseConflict

Section titled “VocabularyRebaseConflict”

Re-exports VocabularyRebaseConflict

VocabularyRebaseKeep

Section titled “VocabularyRebaseKeep”

Re-exports VocabularyRebaseKeep

VocabularyRebaseResolution

Section titled “VocabularyRebaseResolution”

Re-exports VocabularyRebaseResolution

VocabularyRecordChange

Section titled “VocabularyRecordChange”

Re-exports VocabularyRecordChange

VocabularyRecordError

Section titled “VocabularyRecordError”

Re-exports VocabularyRecordError

VocabularyRecordErrorCode

Section titled “VocabularyRecordErrorCode”

Re-exports VocabularyRecordErrorCode

VocabularyRecordFeatureChange

Section titled “VocabularyRecordFeatureChange”

Re-exports VocabularyRecordFeatureChange

VocabularyRecordInput

Section titled “VocabularyRecordInput”

Re-exports VocabularyRecordInput

VocabularyRecordKind

Section titled “VocabularyRecordKind”

Re-exports VocabularyRecordKind

VocabularyRecordOperation

Section titled “VocabularyRecordOperation”

Re-exports VocabularyRecordOperation

VocabularyRecordPage

Section titled “VocabularyRecordPage”

Re-exports VocabularyRecordPage

VocabularyRecordRef

Section titled “VocabularyRecordRef”

Re-exports VocabularyRecordRef

VocabularyRecordView

Section titled “VocabularyRecordView”

Re-exports VocabularyRecordView

VocabularyRecovery

Section titled “VocabularyRecovery”

Re-exports VocabularyRecovery

VocabularyRefusal

Section titled “VocabularyRefusal”

Re-exports VocabularyRefusal

VocabularyRefusalCode

Section titled “VocabularyRefusalCode”

Re-exports VocabularyRefusalCode

VocabularyRelease

Section titled “VocabularyRelease”

Re-exports VocabularyRelease

VocabularyReleaseDetail

Section titled “VocabularyReleaseDetail”

Re-exports VocabularyReleaseDetail

VocabularyReleasePage

Section titled “VocabularyReleasePage”

Re-exports VocabularyReleasePage

VocabularyReleaseResult

Section titled “VocabularyReleaseResult”

Re-exports VocabularyReleaseResult

VocabularyReleaseState

Section titled “VocabularyReleaseState”

Re-exports VocabularyReleaseState

VocabularyRequestOutcome

Section titled “VocabularyRequestOutcome”

Re-exports VocabularyRequestOutcome

VocabularyReviewDisposition

Section titled “VocabularyReviewDisposition”

Re-exports VocabularyReviewDisposition

VocabularyRevisionDiff

Section titled “VocabularyRevisionDiff”

Re-exports VocabularyRevisionDiff

VocabularyRevisionMutationOptions

Section titled “VocabularyRevisionMutationOptions”

Re-exports VocabularyRevisionMutationOptions

VocabularyRevisionSummary

Section titled “VocabularyRevisionSummary”

Re-exports VocabularyRevisionSummary

VocabularySchemeInput

Section titled “VocabularySchemeInput”

Re-exports VocabularySchemeInput

VocabularySchemeLanguageInput

Section titled “VocabularySchemeLanguageInput”

Re-exports VocabularySchemeLanguageInput

VocabularySchemeLanguageRecord

Section titled “VocabularySchemeLanguageRecord”

Re-exports VocabularySchemeLanguageRecord

VocabularySchemeLanguageView

Section titled “VocabularySchemeLanguageView”

Re-exports VocabularySchemeLanguageView

VocabularySchemeList

Section titled “VocabularySchemeList”

Re-exports VocabularySchemeList

VocabularySchemeRecord

Section titled “VocabularySchemeRecord”

Re-exports VocabularySchemeRecord

VocabularySchemeView

Section titled “VocabularySchemeView”

Re-exports VocabularySchemeView

VocabularySearchQuery

Section titled “VocabularySearchQuery”

Re-exports VocabularySearchQuery

VocabularySortUsage

Section titled “VocabularySortUsage”

Re-exports VocabularySortUsage

VocabularySourceGroupInput

Section titled “VocabularySourceGroupInput”

Re-exports VocabularySourceGroupInput

VocabularySourceGroupRecord

Section titled “VocabularySourceGroupRecord”

Re-exports VocabularySourceGroupRecord

VocabularyStatus

Section titled “VocabularyStatus”

Re-exports VocabularyStatus

VocabularyStopReason

Section titled “VocabularyStopReason”

Re-exports VocabularyStopReason

VocabularyTermVersionEntry

Section titled “VocabularyTermVersionEntry”

Re-exports VocabularyTermVersionEntry

VocabularyViewKind

Section titled “VocabularyViewKind”

Re-exports VocabularyViewKind

VocabularyViewRef

Section titled “VocabularyViewRef”

Re-exports VocabularyViewRef

VocabularyViewSelector

Section titled “VocabularyViewSelector”

Re-exports VocabularyViewSelector

WithdrawVocabularyCandidateRequest

Section titled “WithdrawVocabularyCandidateRequest”

Re-exports WithdrawVocabularyCandidateRequest