Interface: CreateCompetencyQuestionRequest
@kortexya/reasoninglayer / CreateCompetencyQuestionRequest
Interface: CreateCompetencyQuestionRequest
Section titled “Interface: CreateCompetencyQuestionRequest”Defined in: src/types/ontology.ts:380
Request to record a competency question.
Remarks
Section titled “Remarks”A question a person writes is stored as accepted at once. The engine
refuses an empty or blank question with 400. It stores any kind other
than pitfall as positive.
Properties
Section titled “Properties”description?
Section titled “description?”
optionaldescription?:string|null
Defined in: src/types/ontology.ts:391
Longer text — a use case’s description.
optionalkind?:CompetencyQuestionKind|null
Defined in: src/types/ontology.ts:389
positive (the default) or pitfall.
osfql?
Section titled “osfql?”
optionalosfql?:string|null
Defined in: src/types/ontology.ts:387
Executable OSFQL. Optional: a question that nobody has compiled yet is still a requirement, but the engine cannot measure it.
question
Section titled “question”question:
string
Defined in: src/types/ontology.ts:382
The question in the user’s language. Must not be blank.
sorts?
Section titled “sorts?”
optionalsorts?:string[]
Defined in: src/types/ontology.ts:393
Sorts the question is about.
useCase?
Section titled “useCase?”
optionaluseCase?:string|null
Defined in: src/types/ontology.ts:398
The use case this question tests (a use_case entry’s id). For a
use_case entry, its own id (defaults to a key derived from the text).