changedOutput schema / $defs / SimilarityHit / description
Previous value: -"One ranked similarity hit: a candidate document plus its score (ACC-001/ACC-002).\n\nParameters\n----------\ntype:\n The hit's domain name: one of the whole-body domains\n (``req``, ``uc``, ``tsk``, ``qa``, ``prb``, ``gol``, ``rsk``,\n ``dec``, ``sop``, ``feat``, ``vcr``, ``sysrs``) -- ``adr`` is\n structurally excluded from the candidate set (issue #46, ADR\n 750842b2's **corpus and registry** sub-decision).\nid:\n The hit document's specmgr-assigned id (the validated frontmatter\n value, the domain's own defaults applied for a blank key --\n exactly what ``list_<domain>`` surfaces), or ``None`` when the\n candidate file failed to parse (REQ-009: the marker rows are not\n addressable).\ntitle:\n The hit document's first H1 title, or the fixed marker\n ``\"<failed to parse>\"`` for an unparseable candidate.\nstatus:\n The hit document's validated ``frontmatter.status`` value, or the\n fixed marker ``\"<failed to parse>\"`` for an unparseable candidate.\npath:\n The real, absolute (``.resolve()``d) filesystem path to the hit\n document's on-disk file, for a caller that wants to read it\n directly instead of going through the matching ``get_<domain>``\n tool (which it cannot do for an unparseable candidate -- its\n ``id`` is ``None``).\nscore:\n The cosine similarity of the hit document's embedding against the\n query (dot product on L2-normalized vectors, in [-1, 1]); the\n result list is sorted by ``score`` descending, ties in the\n candidate enumeration's own deterministic order."New value: +"One ranked similarity hit: a candidate document plus its score (ACC-001/ACC-002).\n\nParameters\n----------\ntype:\n The hit's domain name: one of the whole-body domains\n (``req``, ``uc``, ``tsk``, ``qa``, ``prb``, ``gol``, ``rsk``,\n ``dec``, ``sop``, ``feat``, ``vcr``, ``sysrs``, ``txt``) -- ``adr``\n is structurally excluded from the candidate set (issue #46, ADR\n 750842b2's **corpus and registry** sub-decision).\nid:\n The hit document's specmgr-assigned id (the validated frontmatter\n value, the domain's own defaults applied for a blank key --\n exactly what ``list_<domain>`` surfaces), or ``None`` when the\n candidate file failed to parse (REQ-009: the marker rows are not\n addressable).\ntitle:\n The hit document's first H1 title, or the fixed marker\n ``\"<failed to parse>\"`` for an unparseable candidate.\nstatus:\n The hit document's validated ``frontmatter.status`` value, or the\n fixed marker ``\"<failed to parse>\"`` for an unparseable candidate.\npath:\n The real, absolute (``.resolve()``d) filesystem path to the hit\n document's on-disk file, for a caller that wants to read it\n directly instead of going through the matching ``get_<domain>``\n tool (which it cannot do for an unparseable candidate -- its\n ``id`` is ``None``).\nscore:\n The cosine similarity of the hit document's embedding against the\n query (dot product on L2-normalized vectors, in [-1, 1]); the\n result list is sorted by ``score`` descending, ties in the\n candidate enumeration's own deterministic order."
