Skip to content

question_gaps

Search each need once (one per words, one per skill) and say which find nothing.

Name Type Required Default Description
grade string yes
arm string no null
language string no "pl"
skills string[] no null
words string[] no null

version 1, and in needs one row per need asked: the need, a verdict (found, gap or degraded), rows (how many sets came back), top (the first 3 set ids) and state (the arms that were asked). gaps and degraded count the rows with that verdict. A need is degraded when no arm could be asked, which is not a gap.

The JSON Schema of Need, the shape of each row's need
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"words": {
"type": "string",
"description": "The need in plain words, in the caller's language"
},
"words_en": {
"type": "string",
"description": "English terms for the keyword arm when the need is not in English; never stored on a page"
},
"skills": {
"type": "array",
"items": {
"type": "string"
}
},
"mistakes": {
"type": "array",
"items": {
"type": "string"
}
},
"can_do": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
},
"curriculum_tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "e.g. pl-2017:II.3.3, ccss:3.OA.C.7"
},
"resemble": {
"type": "string",
"description": "A task to resemble, e.g. a homework problem's text"
},
"language": {
"type": "string",
"enum": [
"pl",
"en",
"uk"
]
},
"grade": {
"type": "string",
"description": "Canonical form: the bare number, e.g. \"3\""
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"language",
"grade"
],
"additionalProperties": false,
"description": "A search need, from jadwigo-bank schemas/need.schema.json at commit 703b679. It carries at least one of words, skills, can_do or resemble."
}