pi-mega-compact 0.11.5 → 0.11.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/extensions/dashboard-server/api-contracts/cache-stripes.js +8 -0
- package/dist/extensions/dashboard-server/api-contracts/endpoints.js +13 -0
- package/dist/extensions/dashboard-server/api-contracts/memory-map.js +1 -0
- package/dist/extensions/dashboard-server/routes-cache.js +28 -0
- package/dist/extensions/dashboard-server/routes-game.js +3 -0
- package/dist/extensions/dashboard-server/routes-memory-map.js +50 -0
- package/dist/extensions/dashboard-server/routes-setup.js +105 -0
- package/dist/extensions/dashboard-server/routes.js +3 -1
- package/dist/extensions/dashboard-server/server.js +7 -1
- package/dist/extensions/mega-compact.js +5 -0
- package/dist/extensions/mega-config.js +5 -0
- package/dist/extensions/mega-events/context-handler.js +10 -2
- package/dist/extensions/mega-events/perf-handler.js +83 -1
- package/dist/extensions/mega-events/separated-prompt.js +248 -0
- package/dist/extensions/mega-runtime/env-loader.js +56 -0
- package/dist/extensions/mega-runtime/reset-runtime.js +1 -0
- package/dist/extensions/mega-runtime/runtime-snapshot.js +1 -0
- package/dist/extensions/mega-runtime/runtime.js +1 -0
- package/dist/extensions/mega-runtime/snapshot.js +1 -0
- package/dist/extensions/mega-runtime/widget.js +5 -0
- package/dist/src/cache-stripe-impl.js +288 -0
- package/dist/src/cache-stripe.js +11 -0
- package/dist/src/config/stopwords.js +24 -0
- package/dist/src/config.js +17 -0
- package/dist/src/memoryGraph.js +299 -0
- package/dist/src/monitoring.js +13 -0
- package/dist/src/queryExpansion.js +163 -0
- package/dist/src/queryReformulation/cache.js +123 -0
- package/dist/src/queryReformulation/rrf.js +29 -0
- package/dist/src/queryReformulation/tfidf.js +61 -0
- package/dist/src/queryReformulation/vagueness.js +33 -0
- package/dist/src/queryReformulation.js +225 -0
- package/dist/src/recallMetrics.js +258 -0
- package/dist/src/store/sqlite/cache-stripes.js +133 -0
- package/dist/src/store/sqlite/fts5-search.js +68 -0
- package/dist/src/store/sqlite/perf-samples.js +1 -0
- package/dist/src/store/sqlite/schema.js +60 -1
- package/dist/src/store/sqlite.js +1 -0
- package/dist/src/store/vectorIndex.js +29 -5
- package/dist/src/tiered-router/types.js +18 -0
- package/dist/src/tieredRouter.js +421 -0
- package/dist/src/vectorStore.js +8 -6
- package/extensions/dashboard-client/dist/assets/{AchievementTiles-BoL7qBOJ.js → AchievementTiles-DR9cLGDL.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{AchievementTiles-BoL7qBOJ.js.map → AchievementTiles-DR9cLGDL.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/{AchievementsTab-BFDE3HYc.js → AchievementsTab-svNUgJ1e.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{AchievementsTab-BFDE3HYc.js.map → AchievementsTab-svNUgJ1e.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/CacheTab-ASwhOMjR.js +2 -0
- package/extensions/dashboard-client/dist/assets/CacheTab-ASwhOMjR.js.map +1 -0
- package/extensions/dashboard-client/dist/assets/{ConfigTab-DDFE-ckA.js → ConfigTab-CmmWheuW.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{ConfigTab-DDFE-ckA.js.map → ConfigTab-CmmWheuW.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/{EventsTab-B6UxZ7PM.js → EventsTab-CFE7jLsa.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{EventsTab-B6UxZ7PM.js.map → EventsTab-CFE7jLsa.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/GameTab-CJAX_th_.js +2 -0
- package/extensions/dashboard-client/dist/assets/{GameTab-DehUX-KE.js.map → GameTab-CJAX_th_.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/{MaintenanceTab-0GWRt4wn.js → MaintenanceTab-P4SUsvMf.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{MaintenanceTab-0GWRt4wn.js.map → MaintenanceTab-P4SUsvMf.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/MemoryMapTab-BBiH76eF.js +2 -0
- package/extensions/dashboard-client/dist/assets/MemoryMapTab-BBiH76eF.js.map +1 -0
- package/extensions/dashboard-client/dist/assets/{MetricsTab-C3rwMVsN.js → MetricsTab-CHQscixy.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{MetricsTab-C3rwMVsN.js.map → MetricsTab-CHQscixy.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/{OverviewTab-39O9_x5j.js → OverviewTab-DBs4DJdd.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{OverviewTab-39O9_x5j.js.map → OverviewTab-DBs4DJdd.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/{ReposTab-Cfj6Q5sH.js → ReposTab-DeFz76L5.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{ReposTab-Cfj6Q5sH.js.map → ReposTab-DeFz76L5.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/{SessionsTab-DXDTCi3r.js → SessionsTab-BWNsj1OB.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{SessionsTab-DXDTCi3r.js.map → SessionsTab-BWNsj1OB.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/SetupTab-uS6A0xmw.js +2 -0
- package/extensions/dashboard-client/dist/assets/SetupTab-uS6A0xmw.js.map +1 -0
- package/extensions/dashboard-client/dist/assets/{TimeSavedCard-Cw1dJ4e9.js → TimeSavedCard-CiqCOQuL.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{TimeSavedCard-Cw1dJ4e9.js.map → TimeSavedCard-CiqCOQuL.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/{TopicsTab-BAw972BV.js → TopicsTab-BWWQxltv.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{TopicsTab-BAw972BV.js.map → TopicsTab-BWWQxltv.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/{TurnsTab-Cf5mGIdl.js → TurnsTab-CVz4f4-o.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{TurnsTab-Cf5mGIdl.js.map → TurnsTab-CVz4f4-o.js.map} +1 -1
- package/extensions/dashboard-client/dist/assets/index-CUNn22iV.css +1 -0
- package/extensions/dashboard-client/dist/assets/{index-4gQ7auad.js → index-DrktNOoT.js} +11 -11
- package/extensions/dashboard-client/dist/assets/index-DrktNOoT.js.map +1 -0
- package/extensions/dashboard-client/dist/assets/{useSSE-DNgMuyP6.js → useSSE-Bf5LOLSi.js} +2 -2
- package/extensions/dashboard-client/dist/assets/{useSSE-DNgMuyP6.js.map → useSSE-Bf5LOLSi.js.map} +1 -1
- package/extensions/dashboard-client/dist/index.html +2 -2
- package/extensions/dashboard-client/src/App.tsx +24 -8
- package/extensions/dashboard-client/src/api/client.ts +15 -0
- package/extensions/dashboard-client/src/components/CacheHitRateTrendCard.tsx +100 -0
- package/extensions/dashboard-client/src/components/StripeDistributionCard.tsx +110 -0
- package/extensions/dashboard-client/src/components/TabBar.tsx +49 -4
- package/extensions/dashboard-client/src/main.tsx +1 -0
- package/extensions/dashboard-client/src/styles/base.css +30 -0
- package/extensions/dashboard-client/src/styles/cache.css +167 -0
- package/extensions/dashboard-client/src/tabs/CacheTab.tsx +75 -13
- package/extensions/dashboard-client/src/tabs/MemoryMapTab.tsx +440 -0
- package/extensions/dashboard-client/src/tabs/SetupTab.tsx +65 -2
- package/extensions/dashboard-server/api-contracts/cache-stripes.ts +49 -0
- package/extensions/dashboard-server/api-contracts/endpoints.ts +31 -1
- package/extensions/dashboard-server/api-contracts/index.ts +16 -1
- package/extensions/dashboard-server/api-contracts/memory-map.ts +50 -0
- package/extensions/dashboard-server/api-contracts/setup.ts +22 -0
- package/extensions/dashboard-server/routes-cache.ts +36 -1
- package/extensions/dashboard-server/routes-game.ts +3 -0
- package/extensions/dashboard-server/routes-memory-map.ts +105 -0
- package/extensions/dashboard-server/routes-setup.ts +112 -0
- package/extensions/dashboard-server/routes.ts +3 -1
- package/extensions/dashboard-server/server.ts +6 -0
- package/extensions/mega-compact.ts +5 -0
- package/extensions/mega-config.ts +17 -0
- package/extensions/mega-events/context-handler.ts +10 -2
- package/extensions/mega-events/perf-handler.ts +111 -1
- package/extensions/mega-events/separated-prompt.ts +329 -0
- package/extensions/mega-runtime/env-loader.ts +55 -0
- package/extensions/mega-runtime/helpers.ts +2 -0
- package/extensions/mega-runtime/reset-runtime.ts +1 -0
- package/extensions/mega-runtime/runtime-snapshot.ts +1 -0
- package/extensions/mega-runtime/runtime.ts +1 -0
- package/extensions/mega-runtime/snapshot.ts +6 -0
- package/extensions/mega-runtime/widget-types.ts +3 -0
- package/extensions/mega-runtime/widget.ts +5 -0
- package/package.json +1 -1
- package/src/cache-stripe-impl.ts +385 -0
- package/src/cache-stripe.ts +18 -0
- package/src/config/stopwords.ts +25 -0
- package/src/config.ts +26 -0
- package/src/memoryGraph.ts +438 -0
- package/src/monitoring.ts +35 -0
- package/src/queryExpansion.ts +206 -0
- package/src/queryReformulation/cache.ts +169 -0
- package/src/queryReformulation/rrf.ts +51 -0
- package/src/queryReformulation/tfidf.ts +79 -0
- package/src/queryReformulation/vagueness.ts +38 -0
- package/src/queryReformulation.ts +355 -0
- package/src/recallMetrics.ts +388 -0
- package/src/store/sqlite/cache-stripes.ts +196 -0
- package/src/store/sqlite/fts5-search.ts +90 -0
- package/src/store/sqlite/perf-samples.ts +3 -1
- package/src/store/sqlite/schema.ts +60 -1
- package/src/store/sqlite.ts +1 -0
- package/src/store/vectorIndex.ts +38 -7
- package/src/tiered-router/types.ts +64 -0
- package/src/tieredRouter.ts +489 -0
- package/src/vectorStore.ts +9 -5
- package/extensions/dashboard-client/dist/assets/CacheTab-eKVc-NV1.js +0 -2
- package/extensions/dashboard-client/dist/assets/CacheTab-eKVc-NV1.js.map +0 -1
- package/extensions/dashboard-client/dist/assets/GameTab-DehUX-KE.js +0 -2
- package/extensions/dashboard-client/dist/assets/SetupTab-mMlfunJa.js +0 -2
- package/extensions/dashboard-client/dist/assets/SetupTab-mMlfunJa.js.map +0 -1
- package/extensions/dashboard-client/dist/assets/index-4gQ7auad.js.map +0 -1
- package/extensions/dashboard-client/dist/assets/index-BEdKlpAB.css +0 -1
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* tfidf.ts — TF-IDF term extraction from neighbor documents (S43A-6).
|
|
3
|
+
*
|
|
4
|
+
* Extracts the highest-IDF-weighted terms from a set of neighbor documents
|
|
5
|
+
* for query expansion.
|
|
6
|
+
*
|
|
7
|
+
* Term frequency = raw count of the term in the neighbor document (normalized
|
|
8
|
+
* by document length for cross-doc comparability).
|
|
9
|
+
* Inverse document frequency = log(N / df) where N = total docs in corpus.
|
|
10
|
+
*
|
|
11
|
+
* This is NOT a stopword list: frequent terms like "the" naturally get a low
|
|
12
|
+
* IDF and rank below rare terms like "jwt" even when both have similar TF.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Extract the top-N terms by TF-IDF weight from the given neighbor documents.
|
|
16
|
+
*
|
|
17
|
+
* Returns an empty array when:
|
|
18
|
+
* - neighbors list is empty
|
|
19
|
+
* - totalDocs <= 0
|
|
20
|
+
* - no terms survive filtering (all numeric, all single-char, etc.)
|
|
21
|
+
*/
|
|
22
|
+
export function extractExpansionTerms(neighbors, corpus, topTerms) {
|
|
23
|
+
if (neighbors.length === 0)
|
|
24
|
+
return [];
|
|
25
|
+
const { totalDocs, docFreq } = corpus;
|
|
26
|
+
if (totalDocs <= 0)
|
|
27
|
+
return [];
|
|
28
|
+
// Aggregate term frequency across all neighbor documents
|
|
29
|
+
const termTf = new Map();
|
|
30
|
+
for (const neighbor of neighbors) {
|
|
31
|
+
const words = neighbor.text.toLowerCase().split(/\W+/).filter(Boolean);
|
|
32
|
+
if (words.length === 0)
|
|
33
|
+
continue;
|
|
34
|
+
// Normalize TF by document length so longer docs don't dominate
|
|
35
|
+
const lenNorm = words.length;
|
|
36
|
+
for (const word of words) {
|
|
37
|
+
// Skip pure number tokens (short numbers)
|
|
38
|
+
if (/^\d+$/.test(word) && word.length <= 4)
|
|
39
|
+
continue;
|
|
40
|
+
// Skip single characters
|
|
41
|
+
if (word.length < 2)
|
|
42
|
+
continue;
|
|
43
|
+
// Accumulate across neighbors (multiple docs amplify a term's importance)
|
|
44
|
+
termTf.set(word, (termTf.get(word) ?? 0) + (1 / lenNorm));
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
// Compute TF-IDF for each term
|
|
48
|
+
const scored = [];
|
|
49
|
+
for (const [term, tf] of termTf) {
|
|
50
|
+
const df = docFreq(term);
|
|
51
|
+
// IDF = ln(1 + (N - df + 0.5) / (df + 0.5)) — smooth version
|
|
52
|
+
const idf = Math.log(1 + (totalDocs - df + 0.5) / (df + 0.5));
|
|
53
|
+
const tfIdf = tf * idf;
|
|
54
|
+
if (tfIdf > 0) {
|
|
55
|
+
scored.push({ term, tfIdf, df });
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
// Sort by TF-IDF descending, take top N
|
|
59
|
+
scored.sort((a, b) => b.tfIdf - a.tfIdf);
|
|
60
|
+
return scored.slice(0, topTerms);
|
|
61
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* vagueness.ts — heuristic vagueness detection for S43 query reformulation.
|
|
3
|
+
*
|
|
4
|
+
* Detects whether a query is "vague" enough to benefit from reformulation.
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Heuristic: is this query "vague" enough to benefit from reformulation?
|
|
8
|
+
* Returns true if the query is short, question-like, or lacks specific terms.
|
|
9
|
+
*
|
|
10
|
+
* ANY match -> vague:
|
|
11
|
+
* a) Total words <= `vagueMinWords` (e.g. "what about auth")
|
|
12
|
+
* b) Contains a question word AND total words <= `vagueVeryShortWords`
|
|
13
|
+
*
|
|
14
|
+
* NOTE: Misclassification is low-cost: a specific query that's wrongly expanded
|
|
15
|
+
* just gets a slightly broader search; a vague query that's wrongly skipped
|
|
16
|
+
* just gets the raw-query search (today's behavior).
|
|
17
|
+
*/
|
|
18
|
+
export function isVagueQuery(query, opts) {
|
|
19
|
+
const cleaned = query.replace(/[^\w\s]/g, "").trim();
|
|
20
|
+
if (!cleaned)
|
|
21
|
+
return true; // empty or punctuation-only query is vague
|
|
22
|
+
const words = cleaned.split(/\s+/).filter(Boolean);
|
|
23
|
+
const wordCount = words.length;
|
|
24
|
+
// Rule a: very short query
|
|
25
|
+
if (wordCount <= opts.vagueMinWords)
|
|
26
|
+
return true;
|
|
27
|
+
// Rule b: contains a question word AND is short-ish
|
|
28
|
+
const questionWords = /^(what|why|how|when|where|who|which|does|did|is|are|was|were|can|could|would|should)\b/i;
|
|
29
|
+
const hasQuestionWord = words.some((w) => questionWords.test(w));
|
|
30
|
+
if (hasQuestionWord && wordCount <= opts.vagueVeryShortWords)
|
|
31
|
+
return true;
|
|
32
|
+
return false;
|
|
33
|
+
}
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* queryReformulation.ts — fully local, zero-LLM query reformulation for vague
|
|
3
|
+
* recall queries (S43).
|
|
4
|
+
*
|
|
5
|
+
* Shell: delegates TF-IDF extraction to queryReformulation/tfidf.ts and
|
|
6
|
+
* vagueness detection to queryReformulation/vagueness.ts. Orchestrates the
|
|
7
|
+
* pipeline here.
|
|
8
|
+
*
|
|
9
|
+
* Pipeline:
|
|
10
|
+
* 1. Embed the raw query via the project's default TrigramEmbedder.
|
|
11
|
+
* 2. Linear-scan the real `context_chunks` store for top-N cosine neighbors.
|
|
12
|
+
* 3. Extract high-IDF terms from those neighbors (real TF-IDF, no stopword
|
|
13
|
+
* list — high-frequency terms naturally get low IDF).
|
|
14
|
+
* 4. Expand the query with the top-IDF terms.
|
|
15
|
+
* 5. Re-embed the expanded query and fuse both ranked lists via RRF.
|
|
16
|
+
*
|
|
17
|
+
* Pi-agnostic: no pi runtime types. Pure src/ module.
|
|
18
|
+
*/
|
|
19
|
+
import { isVagueQuery } from "./queryReformulation/vagueness.js";
|
|
20
|
+
import { extractExpansionTerms } from "./queryReformulation/tfidf.js";
|
|
21
|
+
import { reciprocalRankFusion } from "./queryReformulation/rrf.js";
|
|
22
|
+
import { cacheGet, cacheSet, maybeLogCacheStats, computeUncalibrated, QUERY_REFORM_CACHE_TTL_SECONDS, EXPANSION_NEIGHBOR_COUNT, EXPANSION_TOP_TERMS, VAGUE_MIN_WORDS, VAGUE_VERY_SHORT_WORDS, RRF_K, } from "./queryReformulation/cache.js";
|
|
23
|
+
export { isVagueQuery } from "./queryReformulation/vagueness.js";
|
|
24
|
+
export { extractExpansionTerms } from "./queryReformulation/tfidf.js";
|
|
25
|
+
export { reciprocalRankFusion } from "./queryReformulation/rrf.js";
|
|
26
|
+
export { readCacheStats } from "./queryReformulation/cache.js";
|
|
27
|
+
// ---------------------------------------------------------------------------
|
|
28
|
+
// Embedding Neighbor Finder (S43A-5)
|
|
29
|
+
// ---------------------------------------------------------------------------
|
|
30
|
+
/**
|
|
31
|
+
* Find the top-N nearest neighbor chunks by real cosine similarity over the
|
|
32
|
+
* real `context_chunks` store. Uses the provided embedder + scan function.
|
|
33
|
+
*/
|
|
34
|
+
export function findExpansionNeighbors(query, embedder, scan, neighborCount) {
|
|
35
|
+
const embedding = embedder.embed(query);
|
|
36
|
+
if (embedding.length === 0)
|
|
37
|
+
return [];
|
|
38
|
+
return scan(embedding, neighborCount);
|
|
39
|
+
}
|
|
40
|
+
// ---------------------------------------------------------------------------
|
|
41
|
+
// Build Expanded Query
|
|
42
|
+
// ---------------------------------------------------------------------------
|
|
43
|
+
/**
|
|
44
|
+
* Build an expanded query by appending the top IDF-weighted terms from the
|
|
45
|
+
* expansion neighbors to the original query. Simple concatenation: the
|
|
46
|
+
* expanded string is `"originalQuery topTerm1 topTerm2 ..."`.
|
|
47
|
+
*/
|
|
48
|
+
export function buildExpandedQuery(original, terms, maxTerms = EXPANSION_TOP_TERMS) {
|
|
49
|
+
if (terms.length === 0)
|
|
50
|
+
return original;
|
|
51
|
+
const extra = terms.slice(0, maxTerms).map((t) => t.term).join(" ");
|
|
52
|
+
return `${original} ${extra}`;
|
|
53
|
+
}
|
|
54
|
+
// ---------------------------------------------------------------------------
|
|
55
|
+
// Public API: reformulateQuery (S43A-9)
|
|
56
|
+
// ---------------------------------------------------------------------------
|
|
57
|
+
/**
|
|
58
|
+
* Reformulate a query using the fully local pipeline:
|
|
59
|
+
* 1. Check cache (TTL-gated)
|
|
60
|
+
* 2. Check vagueness — skip if not vague
|
|
61
|
+
* 3. Find embedding neighbors
|
|
62
|
+
* 4. Extract TF-IDF terms from neighbor texts
|
|
63
|
+
* 5. Build expanded query
|
|
64
|
+
* 6. Optionally re-embed and search (caller handles RRF fusion)
|
|
65
|
+
*
|
|
66
|
+
* Error contract:
|
|
67
|
+
* - If the embedder throws OR the scan fails: the error propagates to the
|
|
68
|
+
* caller (NOT caught here). The caller is responsible for the
|
|
69
|
+
* `query_reformulation_failed` event + fallback to raw query.
|
|
70
|
+
* - If the corpus is empty: returns raw query with rrfApplied: false and
|
|
71
|
+
* skipReason: "empty_corpus".
|
|
72
|
+
* - If the corpus is too thin (< 2 neighbors): returns raw query with
|
|
73
|
+
* rrfApplied: false and skipReason: "thin_corpus".
|
|
74
|
+
* - If the query is not vague: returns raw query with rrfApplied: false and
|
|
75
|
+
* skipReason: "not_vague".
|
|
76
|
+
*/
|
|
77
|
+
export function reformulateQuery(query, embedder, scan, corpus, neighborTexts, opts = {}, log) {
|
|
78
|
+
const config = {
|
|
79
|
+
neighborCount: opts.neighborCount ?? EXPANSION_NEIGHBOR_COUNT,
|
|
80
|
+
topTerms: opts.topTerms ?? EXPANSION_TOP_TERMS,
|
|
81
|
+
vagueMinWords: opts.vagueMinWords ?? VAGUE_MIN_WORDS,
|
|
82
|
+
vagueVeryShortWords: opts.vagueVeryShortWords ?? VAGUE_VERY_SHORT_WORDS,
|
|
83
|
+
cacheTtlSeconds: opts.cacheTtlSeconds ?? QUERY_REFORM_CACHE_TTL_SECONDS,
|
|
84
|
+
rrfK: opts.rrfK ?? RRF_K,
|
|
85
|
+
searchLimit: opts.searchLimit ?? 5,
|
|
86
|
+
};
|
|
87
|
+
const ttlMs = config.cacheTtlSeconds * 1000;
|
|
88
|
+
// 0. Check cache
|
|
89
|
+
const cached = cacheGet(query, ttlMs);
|
|
90
|
+
if (cached) {
|
|
91
|
+
maybeLogCacheStats(log);
|
|
92
|
+
return {
|
|
93
|
+
result: cached,
|
|
94
|
+
rawNeighbors: cached.neighbors,
|
|
95
|
+
rawTerms: cached.neighbors.map((n) => ({ id: n.id, text: "" })),
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
// 1. Vagueness check
|
|
99
|
+
if (!isVagueQuery(query, { vagueMinWords: config.vagueMinWords, vagueVeryShortWords: config.vagueVeryShortWords })) {
|
|
100
|
+
const result = {
|
|
101
|
+
expanded: query,
|
|
102
|
+
original: query,
|
|
103
|
+
neighbors: [],
|
|
104
|
+
terms: [],
|
|
105
|
+
rrfApplied: false,
|
|
106
|
+
fromCache: false,
|
|
107
|
+
uncalibrated: computeUncalibrated(config),
|
|
108
|
+
skipReason: "not_vague",
|
|
109
|
+
};
|
|
110
|
+
cacheSet(query, result);
|
|
111
|
+
maybeLogCacheStats(log);
|
|
112
|
+
log?.info("query_reformulation_skipped", { query: query.slice(0, 80), reason: "not_vague" });
|
|
113
|
+
return { result, rawNeighbors: [], rawTerms: [] };
|
|
114
|
+
}
|
|
115
|
+
// 2. Corpus check
|
|
116
|
+
if (corpus.totalDocs <= 0) {
|
|
117
|
+
const result = {
|
|
118
|
+
expanded: query,
|
|
119
|
+
original: query,
|
|
120
|
+
neighbors: [],
|
|
121
|
+
terms: [],
|
|
122
|
+
rrfApplied: false,
|
|
123
|
+
fromCache: false,
|
|
124
|
+
uncalibrated: computeUncalibrated(config),
|
|
125
|
+
skipReason: "empty_corpus",
|
|
126
|
+
};
|
|
127
|
+
cacheSet(query, result);
|
|
128
|
+
maybeLogCacheStats(log);
|
|
129
|
+
log?.info("query_reformulation_skipped", { query: query.slice(0, 80), reason: "empty_corpus" });
|
|
130
|
+
return { result, rawNeighbors: [], rawTerms: [] };
|
|
131
|
+
}
|
|
132
|
+
// 3. Find embedding neighbors
|
|
133
|
+
const neighbors = findExpansionNeighbors(query, embedder, scan, config.neighborCount);
|
|
134
|
+
if (neighbors.length < 2) {
|
|
135
|
+
const result = {
|
|
136
|
+
expanded: query,
|
|
137
|
+
original: query,
|
|
138
|
+
neighbors,
|
|
139
|
+
terms: [],
|
|
140
|
+
rrfApplied: false,
|
|
141
|
+
fromCache: false,
|
|
142
|
+
uncalibrated: computeUncalibrated(config),
|
|
143
|
+
skipReason: "thin_corpus",
|
|
144
|
+
};
|
|
145
|
+
cacheSet(query, result);
|
|
146
|
+
maybeLogCacheStats(log);
|
|
147
|
+
log?.info("query_reformulation_skipped", { query: query.slice(0, 80), reason: "thin_corpus" });
|
|
148
|
+
return { result, rawNeighbors: neighbors, rawTerms: [] };
|
|
149
|
+
}
|
|
150
|
+
// 4. Fetch neighbor texts for TF-IDF
|
|
151
|
+
const neighborIds = neighbors.map((n) => n.id);
|
|
152
|
+
const rawTerms = neighborTexts(neighborIds);
|
|
153
|
+
// 5. Extract expansion terms via TF-IDF
|
|
154
|
+
const expansionTerms = extractExpansionTerms(rawTerms, corpus, config.topTerms);
|
|
155
|
+
if (expansionTerms.length === 0) {
|
|
156
|
+
const result = {
|
|
157
|
+
expanded: query,
|
|
158
|
+
original: query,
|
|
159
|
+
neighbors,
|
|
160
|
+
terms: [],
|
|
161
|
+
rrfApplied: false,
|
|
162
|
+
fromCache: false,
|
|
163
|
+
uncalibrated: computeUncalibrated(config),
|
|
164
|
+
skipReason: "thin_corpus",
|
|
165
|
+
};
|
|
166
|
+
cacheSet(query, result);
|
|
167
|
+
maybeLogCacheStats(log);
|
|
168
|
+
log?.info("query_reformulation_skipped", { query: query.slice(0, 80), reason: "thin_corpus" });
|
|
169
|
+
return { result, rawNeighbors: neighbors, rawTerms };
|
|
170
|
+
}
|
|
171
|
+
// 6. Build expanded query
|
|
172
|
+
const expanded = buildExpandedQuery(query, expansionTerms, config.topTerms);
|
|
173
|
+
const uncalibrated = computeUncalibrated(config);
|
|
174
|
+
const result = {
|
|
175
|
+
expanded,
|
|
176
|
+
original: query,
|
|
177
|
+
neighbors: neighbors.map((n) => ({ id: n.id, score: n.score })),
|
|
178
|
+
terms: expansionTerms,
|
|
179
|
+
rrfApplied: true,
|
|
180
|
+
fromCache: false,
|
|
181
|
+
uncalibrated,
|
|
182
|
+
};
|
|
183
|
+
cacheSet(query, result);
|
|
184
|
+
maybeLogCacheStats(log);
|
|
185
|
+
log?.info("query_reformulation", {
|
|
186
|
+
query: query.slice(0, 80),
|
|
187
|
+
expanded: expanded.slice(0, 120),
|
|
188
|
+
neighborCount: neighbors.length,
|
|
189
|
+
topTerms: expansionTerms.slice(0, 5).map((t) => t.term),
|
|
190
|
+
rrfApplied: true,
|
|
191
|
+
fromCache: false,
|
|
192
|
+
uncalibrated,
|
|
193
|
+
});
|
|
194
|
+
return { result, rawNeighbors: neighbors, rawTerms };
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* Full reformulation search pipeline:
|
|
198
|
+
* 1. Reformulate the query (embedding neighbors -> TF-IDF -> expansion).
|
|
199
|
+
* 2. If RRF was applied: run BOTH raw + expanded queries and fuse via RRF.
|
|
200
|
+
* 3. If no RRF: return raw-query results only.
|
|
201
|
+
*/
|
|
202
|
+
export function reformulationSearch(query, embedder, scan, corpus, neighborTexts, search, opts = {}, log) {
|
|
203
|
+
const config = {
|
|
204
|
+
neighborCount: opts.neighborCount ?? EXPANSION_NEIGHBOR_COUNT,
|
|
205
|
+
topTerms: opts.topTerms ?? EXPANSION_TOP_TERMS,
|
|
206
|
+
vagueMinWords: opts.vagueMinWords ?? VAGUE_MIN_WORDS,
|
|
207
|
+
vagueVeryShortWords: opts.vagueVeryShortWords ?? VAGUE_VERY_SHORT_WORDS,
|
|
208
|
+
cacheTtlSeconds: opts.cacheTtlSeconds ?? QUERY_REFORM_CACHE_TTL_SECONDS,
|
|
209
|
+
rrfK: opts.rrfK ?? RRF_K,
|
|
210
|
+
searchLimit: opts.searchLimit ?? 5,
|
|
211
|
+
};
|
|
212
|
+
const { result: reformulation } = reformulateQuery(query, embedder, scan, corpus, neighborTexts, opts, log);
|
|
213
|
+
// Always run the raw query search (needed for the S41 quality gate and as
|
|
214
|
+
// a fallback when RRF is not applied).
|
|
215
|
+
const rawSearchResults = search(query, config.searchLimit);
|
|
216
|
+
if (!reformulation.rrfApplied) {
|
|
217
|
+
return { fused: rawSearchResults, reformulation, rawSearchResults };
|
|
218
|
+
}
|
|
219
|
+
// RRF path: run expanded query search and fuse
|
|
220
|
+
const expandedResults = search(reformulation.expanded, config.searchLimit);
|
|
221
|
+
const rawRanked = rawSearchResults.map((r, i) => ({ id: r.id, rank: i + 1 }));
|
|
222
|
+
const expandedRanked = expandedResults.map((r, i) => ({ id: r.id, rank: i + 1 }));
|
|
223
|
+
const fused = reciprocalRankFusion([rawRanked, expandedRanked], config.rrfK);
|
|
224
|
+
return { fused, reformulation, rawSearchResults };
|
|
225
|
+
}
|
|
@@ -0,0 +1,258 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* recallMetrics.ts — S45 CRAG quality metrics for recall evaluation.
|
|
3
|
+
*
|
|
4
|
+
* Four metrics evaluate the quality of a set of recall hits:
|
|
5
|
+
* - relevance: average cosine similarity (SearchHit.score) across hits
|
|
6
|
+
* - coverage: fraction of query sub-terms found in at least one hit summary
|
|
7
|
+
* - diversity: average pairwise cosine distance among top-K embeddings (MMR-style)
|
|
8
|
+
* - specificity: inverse document-frequency proxy via average chunk length
|
|
9
|
+
*
|
|
10
|
+
* Pi-agnostic: no pi runtime types, no network calls (PREVENT-PI-004).
|
|
11
|
+
* All config is passed explicitly; defaults are documented but NOT hardcoded
|
|
12
|
+
* inside the metric functions (the four constants from S45A.5 are also received
|
|
13
|
+
* via config, not baked in).
|
|
14
|
+
*
|
|
15
|
+
* Best-effort: all functions handle degenerate inputs (empty hits, missing
|
|
16
|
+
* embeddings, zero query terms) and return sensible defaults instead of NaN.
|
|
17
|
+
*/
|
|
18
|
+
import { cosineSimilarity } from "./embedder.js";
|
|
19
|
+
import { STOP_WORDS } from "./config/stopwords.js";
|
|
20
|
+
/** Default config — all values marked "uncalibrated" unless CRAG_CALIBRATED=true. */
|
|
21
|
+
export const DEFAULT_RECALL_QUALITY_CONFIG = {
|
|
22
|
+
minDiversity: 0.3,
|
|
23
|
+
minCoverage: 0.4,
|
|
24
|
+
minRelevance: 0.5,
|
|
25
|
+
minOverallScore: 0.4,
|
|
26
|
+
weights: { relevance: 0.35, coverage: 0.25, diversity: 0.25, specificity: 0.15 },
|
|
27
|
+
specificityDivisor: 300,
|
|
28
|
+
specificityOptimalMin: 100,
|
|
29
|
+
specificityOptimalMax: 500,
|
|
30
|
+
idfBroadenRatio: 0.5,
|
|
31
|
+
stopwords: STOP_WORDS,
|
|
32
|
+
calibrated: false,
|
|
33
|
+
};
|
|
34
|
+
// ---------------------------------------------------------------------------
|
|
35
|
+
// Metric helpers (exported individually for unit testing)
|
|
36
|
+
// ---------------------------------------------------------------------------
|
|
37
|
+
/**
|
|
38
|
+
* S45A.2: Relevance — average of SearchHit.score across all hits.
|
|
39
|
+
* Scores are already cosine similarities in [0, 1].
|
|
40
|
+
* Empty hits → 0.
|
|
41
|
+
*/
|
|
42
|
+
export function computeRelevance(hits) {
|
|
43
|
+
if (hits.length === 0)
|
|
44
|
+
return 0;
|
|
45
|
+
let sum = 0;
|
|
46
|
+
for (const h of hits)
|
|
47
|
+
sum += h.score;
|
|
48
|
+
return sum / hits.length;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* S45A.3: Coverage — fraction of query subterms present in at least one
|
|
52
|
+
* hit's `checkpoint.summary`. Tokenization removes stopwords and short terms.
|
|
53
|
+
* Zero query terms after filtering → coverage = 1.0 (trivially satisfied).
|
|
54
|
+
*/
|
|
55
|
+
export function computeCoverage(query, hits, stopwords = STOP_WORDS) {
|
|
56
|
+
const queryTerms = tokenizeTerms(query, stopwords);
|
|
57
|
+
if (queryTerms.length === 0)
|
|
58
|
+
return 1.0;
|
|
59
|
+
if (hits.length === 0)
|
|
60
|
+
return 0;
|
|
61
|
+
let foundCount = 0;
|
|
62
|
+
for (const qt of queryTerms) {
|
|
63
|
+
const found = hits.some((h) => {
|
|
64
|
+
const summary = h.checkpoint.summary ?? "";
|
|
65
|
+
return summary.toLowerCase().includes(qt);
|
|
66
|
+
});
|
|
67
|
+
if (found)
|
|
68
|
+
foundCount++;
|
|
69
|
+
}
|
|
70
|
+
return foundCount / queryTerms.length;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* S45A.4: Diversity — average pairwise cosine distance (1 - similarity)
|
|
74
|
+
* among hit embeddings. Filtered to hits with non-empty embedding arrays.
|
|
75
|
+
*
|
|
76
|
+
* Edge cases:
|
|
77
|
+
* - < 2 valid hits → 1.0 (nothing to compare)
|
|
78
|
+
* - empty-embedding checkpoints are skipped (no NaN path)
|
|
79
|
+
*/
|
|
80
|
+
export function computeDiversity(hits) {
|
|
81
|
+
const valid = hits.filter((h) => Array.isArray(h.checkpoint.embedding) && h.checkpoint.embedding.length > 0);
|
|
82
|
+
if (valid.length < 2)
|
|
83
|
+
return 1.0;
|
|
84
|
+
let totalDist = 0;
|
|
85
|
+
let pairCount = 0;
|
|
86
|
+
for (let i = 0; i < valid.length; i++) {
|
|
87
|
+
for (let j = i + 1; j < valid.length; j++) {
|
|
88
|
+
const sim = cosineSimilarity(valid[i].checkpoint.embedding, valid[j].checkpoint.embedding);
|
|
89
|
+
// cosineSimilarity returns 0 for empty vectors, but we've filtered those out.
|
|
90
|
+
// NaN/Infinity could theoretically arise from degenerate floats; guard defensively.
|
|
91
|
+
const dist = Number.isFinite(sim) ? 1 - sim : 1.0;
|
|
92
|
+
totalDist += dist;
|
|
93
|
+
pairCount++;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
return pairCount > 0 ? totalDist / pairCount : 1.0;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* S45A.5: Specificity — average chunk length (tokenEstimate) as a proxy
|
|
100
|
+
* for information density.
|
|
101
|
+
*
|
|
102
|
+
* Formula (all constants from config, NOT hardcoded):
|
|
103
|
+
* avg = mean(tokenEstimate across hits; hits missing tokenEstimate → 0)
|
|
104
|
+
* If avg < optimalMin / 2 → 0 (too short to be specific)
|
|
105
|
+
* base = avg / divisor
|
|
106
|
+
* If avg > optimalMax:
|
|
107
|
+
* ramp = 1 - (avg - optimalMax) / optimalMax // linear to 0 at 2*optimalMax
|
|
108
|
+
* capped = max(0, ramp)
|
|
109
|
+
* specificity = min(base, capped)
|
|
110
|
+
* else:
|
|
111
|
+
* specificity = min(base, 1)
|
|
112
|
+
*
|
|
113
|
+
* Edge cases: empty hits → 1.0 (nothing to penalize).
|
|
114
|
+
*/
|
|
115
|
+
export function computeSpecificity(hits, config) {
|
|
116
|
+
if (hits.length === 0)
|
|
117
|
+
return 1.0;
|
|
118
|
+
const { specificityDivisor: divisor, specificityOptimalMin: optMin, specificityOptimalMax: optMax } = config;
|
|
119
|
+
let sum = 0;
|
|
120
|
+
for (const h of hits) {
|
|
121
|
+
sum += h.checkpoint.tokenEstimate ?? 0;
|
|
122
|
+
}
|
|
123
|
+
const avg = sum / hits.length;
|
|
124
|
+
// Below optMin/2 → too short to be specific
|
|
125
|
+
if (avg < optMin / 2)
|
|
126
|
+
return 0;
|
|
127
|
+
const base = divisor > 0 ? avg / divisor : 0;
|
|
128
|
+
const clamped = base > 1 ? 1 : base;
|
|
129
|
+
if (avg > optMax) {
|
|
130
|
+
// Linear ramp-down from optMax to 0 at 2*optMax
|
|
131
|
+
const ramp = optMax > 0 ? 1 - (avg - optMax) / optMax : 0;
|
|
132
|
+
const capped = ramp > 0 ? ramp : 0;
|
|
133
|
+
return clamped < capped ? clamped : capped;
|
|
134
|
+
}
|
|
135
|
+
return clamped;
|
|
136
|
+
}
|
|
137
|
+
// ---------------------------------------------------------------------------
|
|
138
|
+
// Composite evaluation
|
|
139
|
+
// ---------------------------------------------------------------------------
|
|
140
|
+
/**
|
|
141
|
+
* Normalize a four-weight vector so its components sum to 1.0.
|
|
142
|
+
* If all weights are 0, return equal weights (0.25 each).
|
|
143
|
+
* Used defensively since users may set non-sum-1 weights via env.
|
|
144
|
+
*/
|
|
145
|
+
export function normalizeWeights(w) {
|
|
146
|
+
const sum = w.relevance + w.coverage + w.diversity + w.specificity;
|
|
147
|
+
if (sum === 0)
|
|
148
|
+
return { relevance: 0.25, coverage: 0.25, diversity: 0.25, specificity: 0.25 };
|
|
149
|
+
return {
|
|
150
|
+
relevance: w.relevance / sum,
|
|
151
|
+
coverage: w.coverage / sum,
|
|
152
|
+
diversity: w.diversity / sum,
|
|
153
|
+
specificity: w.specificity / sum,
|
|
154
|
+
};
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* S45A.6: Evaluate recall quality — compute all four metrics and return a
|
|
158
|
+
* composite result with pass/fail + recommendation.
|
|
159
|
+
*/
|
|
160
|
+
export function evaluateRecall(query, hits, config) {
|
|
161
|
+
const weights = normalizeWeights(config.weights);
|
|
162
|
+
const breakdown = {
|
|
163
|
+
relevance: computeRelevance(hits),
|
|
164
|
+
coverage: computeCoverage(query, hits, config.stopwords),
|
|
165
|
+
diversity: computeDiversity(hits),
|
|
166
|
+
specificity: computeSpecificity(hits, config),
|
|
167
|
+
};
|
|
168
|
+
const score = weights.relevance * breakdown.relevance +
|
|
169
|
+
weights.coverage * breakdown.coverage +
|
|
170
|
+
weights.diversity * breakdown.diversity +
|
|
171
|
+
weights.specificity * breakdown.specificity;
|
|
172
|
+
const pass = score >= config.minOverallScore &&
|
|
173
|
+
breakdown.relevance >= config.minRelevance &&
|
|
174
|
+
breakdown.coverage >= config.minCoverage &&
|
|
175
|
+
breakdown.diversity >= config.minDiversity;
|
|
176
|
+
const recommendation = buildRecommendation(breakdown, score, config);
|
|
177
|
+
return {
|
|
178
|
+
pass,
|
|
179
|
+
score,
|
|
180
|
+
breakdown,
|
|
181
|
+
recommendation,
|
|
182
|
+
uncalibrated: !config.calibrated,
|
|
183
|
+
weights,
|
|
184
|
+
};
|
|
185
|
+
}
|
|
186
|
+
// ---------------------------------------------------------------------------
|
|
187
|
+
// Recommendation builder
|
|
188
|
+
// ---------------------------------------------------------------------------
|
|
189
|
+
/**
|
|
190
|
+
* Build a human-readable recommendation based on which metric is lowest.
|
|
191
|
+
* Uses env-overridable thresholds from config (not hardcoded).
|
|
192
|
+
*/
|
|
193
|
+
function buildRecommendation(breakdown, score, config) {
|
|
194
|
+
// Check each metric against its threshold (lowest first for specificity).
|
|
195
|
+
const issues = [];
|
|
196
|
+
if (breakdown.diversity < config.minDiversity) {
|
|
197
|
+
issues.push("chunks are too similar — consider expanding K or using MMR");
|
|
198
|
+
}
|
|
199
|
+
if (breakdown.coverage < config.minCoverage) {
|
|
200
|
+
issues.push("query terms not well covered — consider query expansion");
|
|
201
|
+
}
|
|
202
|
+
if (breakdown.relevance < config.minRelevance) {
|
|
203
|
+
issues.push("chunks may be irrelevant — consider stricter threshold");
|
|
204
|
+
}
|
|
205
|
+
if (score < config.minOverallScore) {
|
|
206
|
+
issues.push("quality is low — recommend re-retrieval with expanded query");
|
|
207
|
+
}
|
|
208
|
+
return issues.length > 0 ? issues.join("; ") : null;
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* Compute recall quality metrics for a set of search hits.
|
|
212
|
+
*
|
|
213
|
+
* Pi-agnostic: takes query text and SearchHit results directly, no pi types.
|
|
214
|
+
* The `config` parameter is optional — when omitted, DEFAULT_RECALL_QUALITY_CONFIG
|
|
215
|
+
* is used (labelled uncalibrated).
|
|
216
|
+
*
|
|
217
|
+
* This is the primary export for external callers (e.g., recall.ts integration).
|
|
218
|
+
*/
|
|
219
|
+
export function computeRecallMetrics(query, results, config) {
|
|
220
|
+
const effectiveConfig = {
|
|
221
|
+
...DEFAULT_RECALL_QUALITY_CONFIG,
|
|
222
|
+
...config,
|
|
223
|
+
// Merge weights shallowly if both sides exist
|
|
224
|
+
weights: {
|
|
225
|
+
...DEFAULT_RECALL_QUALITY_CONFIG.weights,
|
|
226
|
+
...(config?.weights ?? {}),
|
|
227
|
+
},
|
|
228
|
+
};
|
|
229
|
+
const result = evaluateRecall(query, results, effectiveConfig);
|
|
230
|
+
return {
|
|
231
|
+
breakdown: result.breakdown,
|
|
232
|
+
score: result.score,
|
|
233
|
+
pass: result.pass,
|
|
234
|
+
recommendation: result.recommendation,
|
|
235
|
+
uncalibrated: result.uncalibrated,
|
|
236
|
+
};
|
|
237
|
+
}
|
|
238
|
+
// ---------------------------------------------------------------------------
|
|
239
|
+
// Internal helpers
|
|
240
|
+
// ---------------------------------------------------------------------------
|
|
241
|
+
/**
|
|
242
|
+
* Tokenize text into lowercased alphanumeric terms, filtering stop words
|
|
243
|
+
* and terms shorter than 3 characters.
|
|
244
|
+
*/
|
|
245
|
+
function tokenizeTerms(text, stopwords) {
|
|
246
|
+
return text
|
|
247
|
+
.toLowerCase()
|
|
248
|
+
.split(/[^a-z0-9]+/)
|
|
249
|
+
.filter((t) => t.length >= 3 && !stopwords.has(t));
|
|
250
|
+
}
|
|
251
|
+
/**
|
|
252
|
+
* Estimate block tokens for a piece of text (rough approximation).
|
|
253
|
+
* Used by the specificity metric fallback when tokenEstimate is missing.
|
|
254
|
+
*/
|
|
255
|
+
export function estimateBlockTokens(text) {
|
|
256
|
+
// ~4 chars per token for English text
|
|
257
|
+
return Math.ceil(text.length / 4);
|
|
258
|
+
}
|