| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621 |
- /**
- * QMD Store - Core data access and retrieval functions
- *
- * This module provides all database operations, search functions, and document
- * retrieval for QMD. It returns raw data structures that can be formatted by
- * CLI or MCP consumers.
- *
- * Usage:
- * const store = createStore("/path/to/db.sqlite");
- * // or use default path:
- * const store = createStore();
- */
- import { openDatabase, loadSqliteVec } from "./db.js";
- import type { Database } from "./db.js";
- import picomatch from "picomatch";
- import { createHash } from "crypto";
- import { readFileSync, realpathSync, statSync, mkdirSync } from "node:fs";
- // Note: node:path resolve is not imported — we export our own cross-platform resolve()
- import fastGlob from "fast-glob";
- import {
- LlamaCpp,
- getDefaultLlamaCpp,
- formatQueryForEmbedding,
- formatDocForEmbedding,
- withLLMSessionForLlm,
- type RerankDocument,
- type ILLMSession,
- } from "./llm.js";
- import type {
- NamedCollection,
- Collection,
- CollectionConfig,
- ContextMap,
- } from "./collections.js";
- // =============================================================================
- // Configuration
- // =============================================================================
- const HOME = process.env.HOME || process.env.USERPROFILE || "/tmp";
- export const DEFAULT_EMBED_MODEL = "embeddinggemma";
- export const DEFAULT_RERANK_MODEL = "ExpedientFalcon/qwen3-reranker:0.6b-q8_0";
- export const DEFAULT_QUERY_MODEL = "Qwen/Qwen3-1.7B";
- export const DEFAULT_GLOB = "**/*.md";
- export const DEFAULT_MULTI_GET_MAX_BYTES = 10 * 1024; // 10KB
- export const DEFAULT_EMBED_MAX_DOCS_PER_BATCH = 64;
- export const DEFAULT_EMBED_MAX_BATCH_BYTES = 64 * 1024 * 1024; // 64MB
- // Chunking: 900 tokens per chunk with 15% overlap
- // Increased from 800 to accommodate smart chunking finding natural break points
- export const CHUNK_SIZE_TOKENS = 900;
- export const CHUNK_OVERLAP_TOKENS = Math.floor(CHUNK_SIZE_TOKENS * 0.15); // 135 tokens (15% overlap)
- // Fallback char-based approximation for sync chunking (~4 chars per token)
- export const CHUNK_SIZE_CHARS = CHUNK_SIZE_TOKENS * 4; // 3600 chars
- export const CHUNK_OVERLAP_CHARS = CHUNK_OVERLAP_TOKENS * 4; // 540 chars
- // Search window for finding optimal break points (in tokens, ~200 tokens)
- export const CHUNK_WINDOW_TOKENS = 200;
- export const CHUNK_WINDOW_CHARS = CHUNK_WINDOW_TOKENS * 4; // 800 chars
- /**
- * Get the LlamaCpp instance for a store — prefers the store's own instance,
- * falls back to the global singleton.
- */
- function getLlm(store: Store): LlamaCpp {
- return store.llm ?? getDefaultLlamaCpp();
- }
- // =============================================================================
- // Smart Chunking - Break Point Detection
- // =============================================================================
- /**
- * A potential break point in the document with a base score indicating quality.
- */
- export interface BreakPoint {
- pos: number; // character position
- score: number; // base score (higher = better break point)
- type: string; // for debugging: 'h1', 'h2', 'blank', etc.
- }
- /**
- * A region where a code fence exists (between ``` markers).
- * We should never split inside a code fence.
- */
- export interface CodeFenceRegion {
- start: number; // position of opening ```
- end: number; // position of closing ``` (or document end if unclosed)
- }
- /**
- * Patterns for detecting break points in markdown documents.
- * Higher scores indicate better places to split.
- * Scores are spread wide so headings decisively beat lower-quality breaks.
- * Order matters for scoring - more specific patterns first.
- */
- export const BREAK_PATTERNS: [RegExp, number, string][] = [
- [/\n#{1}(?!#)/g, 100, 'h1'], // # but not ##
- [/\n#{2}(?!#)/g, 90, 'h2'], // ## but not ###
- [/\n#{3}(?!#)/g, 80, 'h3'], // ### but not ####
- [/\n#{4}(?!#)/g, 70, 'h4'], // #### but not #####
- [/\n#{5}(?!#)/g, 60, 'h5'], // ##### but not ######
- [/\n#{6}(?!#)/g, 50, 'h6'], // ######
- [/\n```/g, 80, 'codeblock'], // code block boundary (same as h3)
- [/\n(?:---|\*\*\*|___)\s*\n/g, 60, 'hr'], // horizontal rule
- [/\n\n+/g, 20, 'blank'], // paragraph boundary
- [/\n[-*]\s/g, 5, 'list'], // unordered list item
- [/\n\d+\.\s/g, 5, 'numlist'], // ordered list item
- [/\n/g, 1, 'newline'], // minimal break
- ];
- /**
- * Scan text for all potential break points.
- * Returns sorted array of break points with higher-scoring patterns taking precedence
- * when multiple patterns match the same position.
- */
- export function scanBreakPoints(text: string): BreakPoint[] {
- const points: BreakPoint[] = [];
- const seen = new Map<number, BreakPoint>(); // pos -> best break point at that pos
- for (const [pattern, score, type] of BREAK_PATTERNS) {
- for (const match of text.matchAll(pattern)) {
- const pos = match.index!;
- const existing = seen.get(pos);
- // Keep higher score if position already seen
- if (!existing || score > existing.score) {
- const bp = { pos, score, type };
- seen.set(pos, bp);
- }
- }
- }
- // Convert to array and sort by position
- for (const bp of seen.values()) {
- points.push(bp);
- }
- return points.sort((a, b) => a.pos - b.pos);
- }
- /**
- * Find all code fence regions in the text.
- * Code fences are delimited by ``` and we should never split inside them.
- */
- export function findCodeFences(text: string): CodeFenceRegion[] {
- const regions: CodeFenceRegion[] = [];
- const fencePattern = /\n```/g;
- let inFence = false;
- let fenceStart = 0;
- for (const match of text.matchAll(fencePattern)) {
- if (!inFence) {
- fenceStart = match.index!;
- inFence = true;
- } else {
- regions.push({ start: fenceStart, end: match.index! + match[0].length });
- inFence = false;
- }
- }
- // Handle unclosed fence - extends to end of document
- if (inFence) {
- regions.push({ start: fenceStart, end: text.length });
- }
- return regions;
- }
- /**
- * Check if a position is inside a code fence region.
- */
- export function isInsideCodeFence(pos: number, fences: CodeFenceRegion[]): boolean {
- return fences.some(f => pos > f.start && pos < f.end);
- }
- /**
- * Find the best cut position using scored break points with distance decay.
- *
- * Uses squared distance for gentler early decay - headings far back still win
- * over low-quality breaks near the target.
- *
- * @param breakPoints - Pre-scanned break points from scanBreakPoints()
- * @param targetCharPos - The ideal cut position (e.g., maxChars boundary)
- * @param windowChars - How far back to search for break points (default ~200 tokens)
- * @param decayFactor - How much to penalize distance (0.7 = 30% score at window edge)
- * @param codeFences - Code fence regions to avoid splitting inside
- * @returns The best position to cut at
- */
- export function findBestCutoff(
- breakPoints: BreakPoint[],
- targetCharPos: number,
- windowChars: number = CHUNK_WINDOW_CHARS,
- decayFactor: number = 0.7,
- codeFences: CodeFenceRegion[] = []
- ): number {
- const windowStart = targetCharPos - windowChars;
- let bestScore = -1;
- let bestPos = targetCharPos;
- for (const bp of breakPoints) {
- if (bp.pos < windowStart) continue;
- if (bp.pos > targetCharPos) break; // sorted, so we can stop
- // Skip break points inside code fences
- if (isInsideCodeFence(bp.pos, codeFences)) continue;
- const distance = targetCharPos - bp.pos;
- // Squared distance decay: gentle early, steep late
- // At target: multiplier = 1.0
- // At 25% back: multiplier = 0.956
- // At 50% back: multiplier = 0.825
- // At 75% back: multiplier = 0.606
- // At window edge: multiplier = 0.3
- const normalizedDist = distance / windowChars;
- const multiplier = 1.0 - (normalizedDist * normalizedDist) * decayFactor;
- const finalScore = bp.score * multiplier;
- if (finalScore > bestScore) {
- bestScore = finalScore;
- bestPos = bp.pos;
- }
- }
- return bestPos;
- }
- // =============================================================================
- // Chunk Strategy
- // =============================================================================
- export type ChunkStrategy = "auto" | "regex";
- /**
- * Merge two sets of break points (e.g. regex + AST), keeping the highest
- * score at each position. Result is sorted by position.
- */
- export function mergeBreakPoints(a: BreakPoint[], b: BreakPoint[]): BreakPoint[] {
- const seen = new Map<number, BreakPoint>();
- for (const bp of a) {
- const existing = seen.get(bp.pos);
- if (!existing || bp.score > existing.score) {
- seen.set(bp.pos, bp);
- }
- }
- for (const bp of b) {
- const existing = seen.get(bp.pos);
- if (!existing || bp.score > existing.score) {
- seen.set(bp.pos, bp);
- }
- }
- return Array.from(seen.values()).sort((a, b) => a.pos - b.pos);
- }
- /**
- * Core chunk algorithm that operates on precomputed break points and code fences.
- * This is the shared implementation used by both regex-only and AST-aware chunking.
- */
- export function chunkDocumentWithBreakPoints(
- content: string,
- breakPoints: BreakPoint[],
- codeFences: CodeFenceRegion[],
- maxChars: number = CHUNK_SIZE_CHARS,
- overlapChars: number = CHUNK_OVERLAP_CHARS,
- windowChars: number = CHUNK_WINDOW_CHARS
- ): { text: string; pos: number }[] {
- if (content.length <= maxChars) {
- return [{ text: content, pos: 0 }];
- }
- const chunks: { text: string; pos: number }[] = [];
- let charPos = 0;
- while (charPos < content.length) {
- const targetEndPos = Math.min(charPos + maxChars, content.length);
- let endPos = targetEndPos;
- if (endPos < content.length) {
- const bestCutoff = findBestCutoff(
- breakPoints,
- targetEndPos,
- windowChars,
- 0.7,
- codeFences
- );
- if (bestCutoff > charPos && bestCutoff <= targetEndPos) {
- endPos = bestCutoff;
- }
- }
- if (endPos <= charPos) {
- endPos = Math.min(charPos + maxChars, content.length);
- }
- chunks.push({ text: content.slice(charPos, endPos), pos: charPos });
- if (endPos >= content.length) {
- break;
- }
- charPos = endPos - overlapChars;
- const lastChunkPos = chunks.at(-1)!.pos;
- if (charPos <= lastChunkPos) {
- charPos = endPos;
- }
- }
- return chunks;
- }
- // Hybrid query: strong BM25 signal detection thresholds
- // Skip expensive LLM expansion when top result is strong AND clearly separated from runner-up
- export const STRONG_SIGNAL_MIN_SCORE = 0.85;
- export const STRONG_SIGNAL_MIN_GAP = 0.15;
- // Max candidates to pass to reranker — balances quality vs latency.
- // 40 keeps rank 31-40 visible to the reranker (matters for recall on broad queries).
- export const RERANK_CANDIDATE_LIMIT = 40;
- /**
- * A typed query expansion result. Decoupled from llm.ts internal Queryable —
- * same shape, but store.ts owns its own public API type.
- *
- * - lex: keyword variant → routes to FTS only
- * - vec: semantic variant → routes to vector only
- * - hyde: hypothetical document → routes to vector only
- */
- export type ExpandedQuery = {
- type: 'lex' | 'vec' | 'hyde';
- query: string;
- /** Optional line number for error reporting (CLI parser) */
- line?: number;
- };
- // =============================================================================
- // Path utilities
- // =============================================================================
- export function homedir(): string {
- return HOME;
- }
- /**
- * Check if a path is absolute.
- * Supports:
- * - Unix paths: /path/to/file
- * - Windows native: C:\path or C:/path
- * - Git Bash: /c/path or /C/path (C-Z drives, excluding A/B floppy drives)
- *
- * Note: /c without trailing slash is treated as Unix path (directory named "c"),
- * while /c/ or /c/path are treated as Git Bash paths (C: drive).
- */
- export function isAbsolutePath(path: string): boolean {
- if (!path) return false;
-
- // Unix absolute path
- if (path.startsWith('/')) {
- // Check if it's a Git Bash style path like /c/ or /c/Users (C-Z only, not A or B)
- // Requires path[2] === '/' to distinguish from Unix paths like /c or /cache
- // Skipped on WSL where /c/ is a valid drvfs mount point, not a drive letter
- if (!isWSL() && path.length >= 3 && path[2] === '/') {
- const driveLetter = path[1];
- if (driveLetter && /[c-zC-Z]/.test(driveLetter)) {
- return true;
- }
- }
- // Any other path starting with / is Unix absolute
- return true;
- }
-
- // Windows native path: C:\ or C:/ (any letter A-Z)
- if (path.length >= 2 && /[a-zA-Z]/.test(path[0]!) && path[1] === ':') {
- return true;
- }
-
- return false;
- }
- /**
- * Normalize path separators to forward slashes.
- * Converts Windows backslashes to forward slashes.
- */
- export function normalizePathSeparators(path: string): string {
- return path.replace(/\\/g, '/');
- }
- /**
- * Detect if running inside WSL (Windows Subsystem for Linux).
- * On WSL, paths like /c/work/... are valid drvfs mount points, not Git Bash paths.
- */
- function isWSL(): boolean {
- return !!(process.env.WSL_DISTRO_NAME || process.env.WSL_INTEROP);
- }
- /**
- * Get the relative path from a prefix.
- * Returns null if path is not under prefix.
- * Returns empty string if path equals prefix.
- */
- export function getRelativePathFromPrefix(path: string, prefix: string): string | null {
- // Empty prefix is invalid
- if (!prefix) {
- return null;
- }
-
- const normalizedPath = normalizePathSeparators(path);
- const normalizedPrefix = normalizePathSeparators(prefix);
-
- // Ensure prefix ends with / for proper matching
- const prefixWithSlash = !normalizedPrefix.endsWith('/')
- ? normalizedPrefix + '/'
- : normalizedPrefix;
-
- // Exact match
- if (normalizedPath === normalizedPrefix) {
- return '';
- }
-
- // Check if path starts with prefix
- if (normalizedPath.startsWith(prefixWithSlash)) {
- return normalizedPath.slice(prefixWithSlash.length);
- }
-
- return null;
- }
- export function resolve(...paths: string[]): string {
- if (paths.length === 0) {
- throw new Error("resolve: at least one path segment is required");
- }
-
- // Normalize all paths to use forward slashes
- const normalizedPaths = paths.map(normalizePathSeparators);
-
- let result = '';
- let windowsDrive = '';
-
- // Check if first path is absolute
- const firstPath = normalizedPaths[0]!;
- if (isAbsolutePath(firstPath)) {
- result = firstPath;
-
- // Extract Windows drive letter if present
- if (firstPath.length >= 2 && /[a-zA-Z]/.test(firstPath[0]!) && firstPath[1] === ':') {
- windowsDrive = firstPath.slice(0, 2);
- result = firstPath.slice(2);
- } else if (!isWSL() && firstPath.startsWith('/') && firstPath.length >= 3 && firstPath[2] === '/') {
- // Git Bash style: /c/ -> C: (C-Z drives only, not A or B)
- // Skipped on WSL where /c/ is a valid drvfs mount point, not a drive letter
- const driveLetter = firstPath[1];
- if (driveLetter && /[c-zC-Z]/.test(driveLetter)) {
- windowsDrive = driveLetter.toUpperCase() + ':';
- result = firstPath.slice(2);
- }
- }
- } else {
- // Start with PWD or cwd, then append the first relative path
- const pwd = normalizePathSeparators(process.env.PWD || process.cwd());
-
- // Extract Windows drive from PWD if present
- if (pwd.length >= 2 && /[a-zA-Z]/.test(pwd[0]!) && pwd[1] === ':') {
- windowsDrive = pwd.slice(0, 2);
- result = pwd.slice(2) + '/' + firstPath;
- } else {
- result = pwd + '/' + firstPath;
- }
- }
-
- // Process remaining paths
- for (let i = 1; i < normalizedPaths.length; i++) {
- const p = normalizedPaths[i]!;
- if (isAbsolutePath(p)) {
- // Absolute path replaces everything
- result = p;
-
- // Update Windows drive if present
- if (p.length >= 2 && /[a-zA-Z]/.test(p[0]!) && p[1] === ':') {
- windowsDrive = p.slice(0, 2);
- result = p.slice(2);
- } else if (!isWSL() && p.startsWith('/') && p.length >= 3 && p[2] === '/') {
- // Git Bash style (C-Z drives only, not A or B)
- // Skipped on WSL where /c/ is a valid drvfs mount point, not a drive letter
- const driveLetter = p[1];
- if (driveLetter && /[c-zC-Z]/.test(driveLetter)) {
- windowsDrive = driveLetter.toUpperCase() + ':';
- result = p.slice(2);
- } else {
- windowsDrive = '';
- }
- } else {
- windowsDrive = '';
- }
- } else {
- // Relative path - append
- result = result + '/' + p;
- }
- }
-
- // Normalize . and .. components
- const parts = result.split('/').filter(Boolean);
- const normalized: string[] = [];
- for (const part of parts) {
- if (part === '..') {
- normalized.pop();
- } else if (part !== '.') {
- normalized.push(part);
- }
- }
-
- // Build final path
- const finalPath = '/' + normalized.join('/');
-
- // Prepend Windows drive if present
- if (windowsDrive) {
- return windowsDrive + finalPath;
- }
-
- return finalPath;
- }
- // Flag to indicate production mode (set by qmd.ts at startup)
- let _productionMode = false;
- export function enableProductionMode(): void {
- _productionMode = true;
- }
- /** Reset production mode flag — only for testing. */
- export function _resetProductionModeForTesting(): void {
- _productionMode = false;
- }
- export function getDefaultDbPath(indexName: string = "index"): string {
- // Always allow override via INDEX_PATH (for testing)
- if (process.env.INDEX_PATH) {
- return process.env.INDEX_PATH;
- }
- // In non-production mode (tests), require explicit path
- if (!_productionMode) {
- throw new Error(
- "Database path not set. Tests must set INDEX_PATH env var or use createStore() with explicit path. " +
- "This prevents tests from accidentally writing to the global index."
- );
- }
- const cacheDir = process.env.XDG_CACHE_HOME || resolve(homedir(), ".cache");
- const qmdCacheDir = resolve(cacheDir, "qmd");
- try { mkdirSync(qmdCacheDir, { recursive: true }); } catch { }
- return resolve(qmdCacheDir, `${indexName}.sqlite`);
- }
- export function getPwd(): string {
- return process.env.PWD || process.cwd();
- }
- export function getRealPath(path: string): string {
- try {
- return realpathSync(path);
- } catch {
- return resolve(path);
- }
- }
- // =============================================================================
- // Virtual Path Utilities (qmd://)
- // =============================================================================
- export type VirtualPath = {
- collectionName: string;
- path: string; // relative path within collection
- indexName?: string;
- };
- /**
- * Normalize explicit virtual path formats to standard qmd:// format.
- * Only handles paths that are already explicitly virtual:
- * - qmd://collection/path.md (already normalized)
- * - qmd:////collection/path.md (extra slashes - normalize)
- * - //collection/path.md (missing qmd: prefix - add it)
- *
- * Does NOT handle:
- * - collection/path.md (bare paths - could be filesystem relative)
- * - :linenum suffix (should be parsed separately before calling this)
- */
- export function normalizeVirtualPath(input: string): string {
- let path = input.trim();
- // Handle qmd:// with extra slashes: qmd:////collection/path -> qmd://collection/path
- if (path.startsWith('qmd:')) {
- // Remove qmd: prefix and normalize slashes
- path = path.slice(4);
- // Remove leading slashes and re-add exactly two
- path = path.replace(/^\/+/, '');
- return `qmd://${path}`;
- }
- // Handle //collection/path (missing qmd: prefix)
- if (path.startsWith('//')) {
- path = path.replace(/^\/+/, '');
- return `qmd://${path}`;
- }
- // Return as-is for other cases (filesystem paths, docids, bare collection/path, etc.)
- return path;
- }
- /**
- * Parse a virtual path like "qmd://collection-name/path/to/file.md"
- * into its components.
- * Also supports collection root: "qmd://collection-name/" or "qmd://collection-name"
- */
- export function parseVirtualPath(virtualPath: string): VirtualPath | null {
- // Normalize the path first
- const normalized = normalizeVirtualPath(virtualPath);
- const [pathPart = normalized, queryString = ""] = normalized.split("?");
- // Match: qmd://collection-name[/optional-path]
- // Allows: qmd://name, qmd://name/, qmd://name/path
- const match = pathPart.match(/^qmd:\/\/([^\/]+)\/?(.*)$/);
- if (!match?.[1]) return null;
- const indexName = new URLSearchParams(queryString).get("index")?.trim() || undefined;
- return {
- collectionName: match[1],
- path: match[2] ?? '', // Empty string for collection root
- ...(indexName ? { indexName } : {}),
- };
- }
- /**
- * Build a virtual path from collection name and relative path.
- */
- export function buildVirtualPath(collectionName: string, path: string, indexName?: string): string {
- const base = `qmd://${collectionName}/${path}`;
- return indexName ? `${base}?index=${encodeURIComponent(indexName)}` : base;
- }
- /**
- * Check if a path is explicitly a virtual path.
- * Only recognizes explicit virtual path formats:
- * - qmd://collection/path.md
- * - //collection/path.md
- *
- * Does NOT consider bare collection/path.md as virtual - that should be
- * handled separately by checking if the first component is a collection name.
- */
- export function isVirtualPath(path: string): boolean {
- const trimmed = path.trim();
- // Explicit qmd:// prefix (with any number of slashes)
- if (trimmed.startsWith('qmd:')) return true;
- // //collection/path format (missing qmd: prefix)
- if (trimmed.startsWith('//')) return true;
- return false;
- }
- /**
- * Resolve a virtual path to absolute filesystem path.
- */
- export function resolveVirtualPath(db: Database, virtualPath: string): string | null {
- const parsed = parseVirtualPath(virtualPath);
- if (!parsed) return null;
- const coll = getCollectionByName(db, parsed.collectionName);
- if (!coll) return null;
- return resolve(coll.pwd, parsed.path);
- }
- /**
- * Convert an absolute filesystem path to a virtual path.
- * Returns null if the file is not in any indexed collection.
- */
- export function toVirtualPath(db: Database, absolutePath: string): string | null {
- // Get all collections from DB
- const collections = getStoreCollections(db);
- // Find which collection this absolute path belongs to
- for (const coll of collections) {
- if (absolutePath.startsWith(coll.path + '/') || absolutePath === coll.path) {
- // Extract relative path
- const relativePath = absolutePath.startsWith(coll.path + '/')
- ? absolutePath.slice(coll.path.length + 1)
- : '';
- // Verify this document exists in the database
- const doc = db.prepare(`
- SELECT d.path
- FROM documents d
- WHERE d.collection = ? AND d.path = ? AND d.active = 1
- LIMIT 1
- `).get(coll.name, relativePath) as { path: string } | null;
- if (doc) {
- return buildVirtualPath(coll.name, relativePath);
- }
- }
- }
- return null;
- }
- // =============================================================================
- // Database initialization
- // =============================================================================
- function createSqliteVecUnavailableError(reason: string): Error {
- return new Error(
- "sqlite-vec extension is unavailable. " +
- `${reason}. ` +
- "Install Homebrew SQLite so the sqlite-vec extension can be loaded, " +
- "and set BREW_PREFIX if Homebrew is installed in a non-standard location."
- );
- }
- let _sqliteVecUnavailableReason: string | null = null;
- function getErrorMessage(err: unknown): string {
- return err instanceof Error ? err.message : String(err);
- }
- export function verifySqliteVecLoaded(db: Database): void {
- try {
- const row = db.prepare(`SELECT vec_version() AS version`).get() as { version?: string } | null;
- if (!row?.version || typeof row.version !== "string") {
- throw new Error("vec_version() returned no version");
- }
- } catch (err) {
- const message = getErrorMessage(err);
- throw createSqliteVecUnavailableError(`sqlite-vec probe failed (${message})`);
- }
- }
- let _sqliteVecAvailable: boolean | null = null;
- function initializeDatabase(db: Database): void {
- try {
- loadSqliteVec(db);
- verifySqliteVecLoaded(db);
- _sqliteVecAvailable = true;
- _sqliteVecUnavailableReason = null;
- } catch (err) {
- // sqlite-vec is optional — vector search won't work but FTS is fine
- _sqliteVecAvailable = false;
- _sqliteVecUnavailableReason = getErrorMessage(err);
- console.warn(_sqliteVecUnavailableReason);
- }
- db.exec("PRAGMA journal_mode = WAL");
- db.exec("PRAGMA foreign_keys = ON");
- // Drop legacy tables that are now managed in YAML
- db.exec(`DROP TABLE IF EXISTS path_contexts`);
- db.exec(`DROP TABLE IF EXISTS collections`);
- // Content-addressable storage - the source of truth for document content
- db.exec(`
- CREATE TABLE IF NOT EXISTS content (
- hash TEXT PRIMARY KEY,
- doc TEXT NOT NULL,
- created_at TEXT NOT NULL
- )
- `);
- // Documents table - file system layer mapping virtual paths to content hashes
- // Collections are now managed in ~/.config/qmd/index.yml
- db.exec(`
- CREATE TABLE IF NOT EXISTS documents (
- id INTEGER PRIMARY KEY AUTOINCREMENT,
- collection TEXT NOT NULL,
- path TEXT NOT NULL,
- title TEXT NOT NULL,
- hash TEXT NOT NULL,
- created_at TEXT NOT NULL,
- modified_at TEXT NOT NULL,
- active INTEGER NOT NULL DEFAULT 1,
- FOREIGN KEY (hash) REFERENCES content(hash) ON DELETE CASCADE,
- UNIQUE(collection, path)
- )
- `);
- db.exec(`CREATE INDEX IF NOT EXISTS idx_documents_collection ON documents(collection, active)`);
- db.exec(`CREATE INDEX IF NOT EXISTS idx_documents_hash ON documents(hash)`);
- db.exec(`CREATE INDEX IF NOT EXISTS idx_documents_path ON documents(path, active)`);
- // Cache table for LLM API calls
- db.exec(`
- CREATE TABLE IF NOT EXISTS llm_cache (
- hash TEXT PRIMARY KEY,
- result TEXT NOT NULL,
- created_at TEXT NOT NULL
- )
- `);
- // Content vectors
- const cvInfo = db.prepare(`PRAGMA table_info(content_vectors)`).all() as { name: string }[];
- const hasSeqColumn = cvInfo.some(col => col.name === 'seq');
- if (cvInfo.length > 0 && !hasSeqColumn) {
- db.exec(`DROP TABLE IF EXISTS content_vectors`);
- db.exec(`DROP TABLE IF EXISTS vectors_vec`);
- }
- db.exec(`
- CREATE TABLE IF NOT EXISTS content_vectors (
- hash TEXT NOT NULL,
- seq INTEGER NOT NULL DEFAULT 0,
- pos INTEGER NOT NULL DEFAULT 0,
- model TEXT NOT NULL,
- embedded_at TEXT NOT NULL,
- PRIMARY KEY (hash, seq)
- )
- `);
- // Store collections — makes the DB self-contained (no external config needed)
- db.exec(`
- CREATE TABLE IF NOT EXISTS store_collections (
- name TEXT PRIMARY KEY,
- path TEXT NOT NULL,
- pattern TEXT NOT NULL DEFAULT '**/*.md',
- ignore_patterns TEXT,
- include_by_default INTEGER DEFAULT 1,
- update_command TEXT,
- context TEXT
- )
- `);
- // Store config — key-value metadata (e.g. config_hash for sync optimization)
- db.exec(`
- CREATE TABLE IF NOT EXISTS store_config (
- key TEXT PRIMARY KEY,
- value TEXT
- )
- `);
- // FTS - index filepath (collection/path), title, and content
- db.exec(`
- CREATE VIRTUAL TABLE IF NOT EXISTS documents_fts USING fts5(
- filepath, title, body,
- tokenize='porter unicode61'
- )
- `);
- // Triggers to keep FTS in sync
- db.exec(`
- CREATE TRIGGER IF NOT EXISTS documents_ai AFTER INSERT ON documents
- WHEN new.active = 1
- BEGIN
- INSERT INTO documents_fts(rowid, filepath, title, body)
- SELECT
- new.id,
- new.collection || '/' || new.path,
- new.title,
- (SELECT doc FROM content WHERE hash = new.hash)
- WHERE new.active = 1;
- END
- `);
- db.exec(`
- CREATE TRIGGER IF NOT EXISTS documents_ad AFTER DELETE ON documents BEGIN
- DELETE FROM documents_fts WHERE rowid = old.id;
- END
- `);
- db.exec(`
- CREATE TRIGGER IF NOT EXISTS documents_au AFTER UPDATE ON documents
- BEGIN
- -- Delete from FTS if no longer active
- DELETE FROM documents_fts WHERE rowid = old.id AND new.active = 0;
- -- Update FTS if still/newly active
- INSERT OR REPLACE INTO documents_fts(rowid, filepath, title, body)
- SELECT
- new.id,
- new.collection || '/' || new.path,
- new.title,
- (SELECT doc FROM content WHERE hash = new.hash)
- WHERE new.active = 1;
- END
- `);
- }
- // =============================================================================
- // Store Collections — DB accessor functions
- // =============================================================================
- type StoreCollectionRow = {
- name: string;
- path: string;
- pattern: string;
- ignore_patterns: string | null;
- include_by_default: number;
- update_command: string | null;
- context: string | null;
- };
- function rowToNamedCollection(row: StoreCollectionRow): NamedCollection {
- return {
- name: row.name,
- path: row.path,
- pattern: row.pattern,
- ...(row.ignore_patterns ? { ignore: JSON.parse(row.ignore_patterns) as string[] } : {}),
- ...(row.include_by_default === 0 ? { includeByDefault: false } : {}),
- ...(row.update_command ? { update: row.update_command } : {}),
- ...(row.context ? { context: JSON.parse(row.context) as ContextMap } : {}),
- };
- }
- export function getStoreCollections(db: Database): NamedCollection[] {
- const rows = db.prepare(`SELECT * FROM store_collections`).all() as StoreCollectionRow[];
- return rows.map(rowToNamedCollection);
- }
- export function getStoreCollection(db: Database, name: string): NamedCollection | null {
- const row = db.prepare(`SELECT * FROM store_collections WHERE name = ?`).get(name) as StoreCollectionRow | null | undefined;
- if (row == null) return null;
- return rowToNamedCollection(row);
- }
- export function getStoreGlobalContext(db: Database): string | undefined {
- const row = db.prepare(`SELECT value FROM store_config WHERE key = 'global_context'`).get() as { value: string } | null | undefined;
- if (row == null) return undefined;
- return row.value || undefined;
- }
- export function getStoreContexts(db: Database): Array<{ collection: string; path: string; context: string }> {
- const results: Array<{ collection: string; path: string; context: string }> = [];
- // Global context
- const globalCtx = getStoreGlobalContext(db);
- if (globalCtx) {
- results.push({ collection: "*", path: "/", context: globalCtx });
- }
- // Collection contexts
- const rows = db.prepare(`SELECT name, context FROM store_collections WHERE context IS NOT NULL`).all() as { name: string; context: string }[];
- for (const row of rows) {
- const ctxMap = JSON.parse(row.context) as ContextMap;
- for (const [path, context] of Object.entries(ctxMap)) {
- results.push({ collection: row.name, path, context });
- }
- }
- return results;
- }
- export function upsertStoreCollection(db: Database, name: string, collection: Omit<Collection, 'pattern'> & { pattern?: string }): void {
- db.prepare(`
- INSERT INTO store_collections (name, path, pattern, ignore_patterns, include_by_default, update_command, context)
- VALUES (?, ?, ?, ?, ?, ?, ?)
- ON CONFLICT(name) DO UPDATE SET
- path = excluded.path,
- pattern = excluded.pattern,
- ignore_patterns = excluded.ignore_patterns,
- include_by_default = excluded.include_by_default,
- update_command = excluded.update_command,
- context = excluded.context
- `).run(
- name,
- collection.path,
- collection.pattern || '**/*.md',
- collection.ignore ? JSON.stringify(collection.ignore) : null,
- collection.includeByDefault === false ? 0 : 1,
- collection.update || null,
- collection.context ? JSON.stringify(collection.context) : null,
- );
- }
- export function deleteStoreCollection(db: Database, name: string): boolean {
- const result = db.prepare(`DELETE FROM store_collections WHERE name = ?`).run(name);
- return result.changes > 0;
- }
- export function renameStoreCollection(db: Database, oldName: string, newName: string): boolean {
- // Check target doesn't exist
- const existing = db.prepare(`SELECT name FROM store_collections WHERE name = ?`).get(newName) as { name: string } | null | undefined;
- if (existing != null) {
- throw new Error(`Collection '${newName}' already exists`);
- }
- const result = db.prepare(`UPDATE store_collections SET name = ? WHERE name = ?`).run(newName, oldName);
- return result.changes > 0;
- }
- export function updateStoreContext(db: Database, collectionName: string, path: string, text: string): boolean {
- const row = db.prepare(`SELECT context FROM store_collections WHERE name = ?`).get(collectionName) as { context: string | null } | null | undefined;
- if (row == null) return false;
- const ctxMap: ContextMap = row.context ? JSON.parse(row.context) : {};
- ctxMap[path] = text;
- db.prepare(`UPDATE store_collections SET context = ? WHERE name = ?`).run(JSON.stringify(ctxMap), collectionName);
- return true;
- }
- export function removeStoreContext(db: Database, collectionName: string, path: string): boolean {
- const row = db.prepare(`SELECT context FROM store_collections WHERE name = ?`).get(collectionName) as { context: string | null } | null | undefined;
- if (row == null) return false;
- if (!row.context) return false;
- const ctxMap: ContextMap = JSON.parse(row.context);
- if (!(path in ctxMap)) return false;
- delete ctxMap[path];
- const newCtx = Object.keys(ctxMap).length > 0 ? JSON.stringify(ctxMap) : null;
- db.prepare(`UPDATE store_collections SET context = ? WHERE name = ?`).run(newCtx, collectionName);
- return true;
- }
- export function setStoreGlobalContext(db: Database, value: string | undefined): void {
- if (value === undefined) {
- db.prepare(`DELETE FROM store_config WHERE key = 'global_context'`).run();
- } else {
- db.prepare(`INSERT INTO store_config (key, value) VALUES ('global_context', ?) ON CONFLICT(key) DO UPDATE SET value = excluded.value`).run(value);
- }
- }
- /**
- * Sync external config (YAML/inline) into SQLite store_collections.
- * External config always wins. Skips sync if config hash hasn't changed.
- */
- export function syncConfigToDb(db: Database, config: CollectionConfig): void {
- // Check config hash — skip sync if unchanged
- const configJson = JSON.stringify(config);
- const hash = createHash('sha256').update(configJson).digest('hex');
- const existingHash = db.prepare(`SELECT value FROM store_config WHERE key = 'config_hash'`).get() as { value: string } | null | undefined;
- if (existingHash != null && existingHash.value === hash) {
- return; // Config unchanged, skip sync
- }
- // Sync collections
- const configNames = new Set(Object.keys(config.collections));
- for (const [name, coll] of Object.entries(config.collections)) {
- upsertStoreCollection(db, name, coll);
- }
- // Delete collections not in config
- const dbCollections = db.prepare(`SELECT name FROM store_collections`).all() as { name: string }[];
- for (const row of dbCollections) {
- if (!configNames.has(row.name)) {
- db.prepare(`DELETE FROM store_collections WHERE name = ?`).run(row.name);
- }
- }
- // Sync global context
- if (config.global_context !== undefined) {
- setStoreGlobalContext(db, config.global_context);
- } else {
- setStoreGlobalContext(db, undefined);
- }
- // Save config hash
- db.prepare(`INSERT INTO store_config (key, value) VALUES ('config_hash', ?) ON CONFLICT(key) DO UPDATE SET value = excluded.value`).run(hash);
- }
- export function isSqliteVecAvailable(): boolean {
- return _sqliteVecAvailable === true;
- }
- function ensureVecTableInternal(db: Database, dimensions: number): void {
- if (!_sqliteVecAvailable) {
- throw createSqliteVecUnavailableError(
- _sqliteVecUnavailableReason ?? "vector operations require a SQLite build with extension loading support"
- );
- }
- const tableInfo = db.prepare(`SELECT sql FROM sqlite_master WHERE type='table' AND name='vectors_vec'`).get() as { sql: string } | null;
- if (tableInfo) {
- const match = tableInfo.sql.match(/float\[(\d+)\]/);
- const hasHashSeq = tableInfo.sql.includes('hash_seq');
- const hasCosine = tableInfo.sql.includes('distance_metric=cosine');
- const existingDims = match?.[1] ? parseInt(match[1], 10) : null;
- if (existingDims === dimensions && hasHashSeq && hasCosine) return;
- if (existingDims !== null && existingDims !== dimensions) {
- throw new Error(
- `Embedding dimension mismatch: existing vectors are ${existingDims}d but the current model produces ${dimensions}d. ` +
- `Run 'qmd embed -f' to re-embed with the new model.`
- );
- }
- db.exec("DROP TABLE IF EXISTS vectors_vec");
- }
- db.exec(`CREATE VIRTUAL TABLE vectors_vec USING vec0(hash_seq TEXT PRIMARY KEY, embedding float[${dimensions}] distance_metric=cosine)`);
- }
- // =============================================================================
- // Store Factory
- // =============================================================================
- export type Store = {
- db: Database;
- dbPath: string;
- /** Optional LlamaCpp instance for this store (overrides the global singleton) */
- llm?: LlamaCpp;
- close: () => void;
- ensureVecTable: (dimensions: number) => void;
- // Index health
- getHashesNeedingEmbedding: () => number;
- getIndexHealth: () => IndexHealthInfo;
- getStatus: () => IndexStatus;
- // Caching
- getCacheKey: typeof getCacheKey;
- getCachedResult: (cacheKey: string) => string | null;
- setCachedResult: (cacheKey: string, result: string) => void;
- clearCache: () => void;
- // Cleanup and maintenance
- deleteLLMCache: () => number;
- deleteInactiveDocuments: () => number;
- cleanupOrphanedContent: () => number;
- cleanupOrphanedVectors: () => number;
- vacuumDatabase: () => void;
- // Context
- getContextForFile: (filepath: string) => string | null;
- getContextForPath: (collectionName: string, path: string) => string | null;
- getCollectionByName: (name: string) => { name: string; pwd: string; glob_pattern: string } | null;
- getCollectionsWithoutContext: () => { name: string; pwd: string; doc_count: number }[];
- getTopLevelPathsWithoutContext: (collectionName: string) => string[];
- // Virtual paths
- parseVirtualPath: typeof parseVirtualPath;
- buildVirtualPath: typeof buildVirtualPath;
- isVirtualPath: typeof isVirtualPath;
- resolveVirtualPath: (virtualPath: string) => string | null;
- toVirtualPath: (absolutePath: string) => string | null;
- // Search
- searchFTS: (query: string, limit?: number, collectionName?: string) => SearchResult[];
- searchVec: (query: string, model: string, limit?: number, collectionName?: string, session?: ILLMSession, precomputedEmbedding?: number[]) => Promise<SearchResult[]>;
- // Query expansion & reranking
- expandQuery: (query: string, model?: string, intent?: string) => Promise<ExpandedQuery[]>;
- rerank: (query: string, documents: { file: string; text: string }[], model?: string, intent?: string) => Promise<{ file: string; score: number }[]>;
- // Document retrieval
- findDocument: (filename: string, options?: { includeBody?: boolean }) => DocumentResult | DocumentNotFound;
- getDocumentBody: (doc: DocumentResult | { filepath: string }, fromLine?: number, maxLines?: number) => string | null;
- findDocuments: (pattern: string, options?: { includeBody?: boolean; maxBytes?: number }) => { docs: MultiGetResult[]; errors: string[] };
- // Fuzzy matching and docid lookup
- findSimilarFiles: (query: string, maxDistance?: number, limit?: number) => string[];
- matchFilesByGlob: (pattern: string) => { filepath: string; displayPath: string; bodyLength: number }[];
- findDocumentByDocid: (docid: string) => { filepath: string; hash: string } | null;
- // Document indexing operations
- insertContent: (hash: string, content: string, createdAt: string) => void;
- insertDocument: (collectionName: string, path: string, title: string, hash: string, createdAt: string, modifiedAt: string) => void;
- findActiveDocument: (collectionName: string, path: string) => { id: number; hash: string; title: string } | null;
- updateDocumentTitle: (documentId: number, title: string, modifiedAt: string) => void;
- updateDocument: (documentId: number, title: string, hash: string, modifiedAt: string) => void;
- deactivateDocument: (collectionName: string, path: string) => void;
- getActiveDocumentPaths: (collectionName: string) => string[];
- // Vector/embedding operations
- getHashesForEmbedding: () => { hash: string; body: string; path: string }[];
- clearAllEmbeddings: () => void;
- insertEmbedding: (hash: string, seq: number, pos: number, embedding: Float32Array, model: string, embeddedAt: string) => void;
- };
- // =============================================================================
- // Reindex & Embed — pure-logic functions for SDK and CLI
- // =============================================================================
- export type ReindexProgress = {
- file: string;
- current: number;
- total: number;
- };
- export type ReindexResult = {
- indexed: number;
- updated: number;
- unchanged: number;
- removed: number;
- orphanedCleaned: number;
- };
- /**
- * Re-index a single collection by scanning the filesystem and updating the database.
- * Pure function — no console output, no db lifecycle management.
- */
- export async function reindexCollection(
- store: Store,
- collectionPath: string,
- globPattern: string,
- collectionName: string,
- options?: {
- ignorePatterns?: string[];
- onProgress?: (info: ReindexProgress) => void;
- }
- ): Promise<ReindexResult> {
- const db = store.db;
- const now = new Date().toISOString();
- const excludeDirs = ["node_modules", ".git", ".cache", "vendor", "dist", "build"];
- const allIgnore = [
- ...excludeDirs.map(d => `**/${d}/**`),
- ...(options?.ignorePatterns || []),
- ];
- const allFiles: string[] = await fastGlob(globPattern, {
- cwd: collectionPath,
- onlyFiles: true,
- followSymbolicLinks: false,
- dot: false,
- ignore: allIgnore,
- });
- // Filter hidden files/folders
- const files = allFiles.filter(file => {
- const parts = file.split("/");
- return !parts.some(part => part.startsWith("."));
- });
- const total = files.length;
- let indexed = 0, updated = 0, unchanged = 0, processed = 0;
- const seenPaths = new Set<string>();
- for (const relativeFile of files) {
- const filepath = getRealPath(resolve(collectionPath, relativeFile));
- const path = handelize(relativeFile);
- seenPaths.add(path);
- let content: string;
- try {
- content = readFileSync(filepath, "utf-8");
- } catch {
- processed++;
- options?.onProgress?.({ file: relativeFile, current: processed, total });
- continue;
- }
- if (!content.trim()) {
- processed++;
- continue;
- }
- const hash = await hashContent(content);
- const title = extractTitle(content, relativeFile);
- const existing = findActiveDocument(db, collectionName, path);
- if (existing) {
- if (existing.hash === hash) {
- if (existing.title !== title) {
- updateDocumentTitle(db, existing.id, title, now);
- updated++;
- } else {
- unchanged++;
- }
- } else {
- insertContent(db, hash, content, now);
- const stat = statSync(filepath);
- updateDocument(db, existing.id, title, hash,
- stat ? new Date(stat.mtime).toISOString() : now);
- updated++;
- }
- } else {
- indexed++;
- insertContent(db, hash, content, now);
- const stat = statSync(filepath);
- insertDocument(db, collectionName, path, title, hash,
- stat ? new Date(stat.birthtime).toISOString() : now,
- stat ? new Date(stat.mtime).toISOString() : now);
- }
- processed++;
- options?.onProgress?.({ file: relativeFile, current: processed, total });
- }
- // Deactivate documents that no longer exist
- const allActive = getActiveDocumentPaths(db, collectionName);
- let removed = 0;
- for (const path of allActive) {
- if (!seenPaths.has(path)) {
- deactivateDocument(db, collectionName, path);
- removed++;
- }
- }
- const orphanedCleaned = cleanupOrphanedContent(db);
- return { indexed, updated, unchanged, removed, orphanedCleaned };
- }
- export type EmbedProgress = {
- chunksEmbedded: number;
- totalChunks: number;
- bytesProcessed: number;
- totalBytes: number;
- errors: number;
- };
- export type EmbedResult = {
- docsProcessed: number;
- chunksEmbedded: number;
- errors: number;
- durationMs: number;
- };
- export type EmbedOptions = {
- force?: boolean;
- model?: string;
- maxDocsPerBatch?: number;
- maxBatchBytes?: number;
- chunkStrategy?: ChunkStrategy;
- onProgress?: (info: EmbedProgress) => void;
- };
- type PendingEmbeddingDoc = {
- hash: string;
- path: string;
- bytes: number;
- };
- type EmbeddingDoc = PendingEmbeddingDoc & {
- body: string;
- };
- type ChunkItem = {
- hash: string;
- title: string;
- text: string;
- seq: number;
- pos: number;
- tokens: number;
- bytes: number;
- };
- function validatePositiveIntegerOption(name: string, value: number | undefined, fallback: number): number {
- if (value === undefined) return fallback;
- if (!Number.isInteger(value) || value < 1) {
- throw new Error(`${name} must be a positive integer`);
- }
- return value;
- }
- function resolveEmbedOptions(options?: EmbedOptions): Required<Pick<EmbedOptions, "maxDocsPerBatch" | "maxBatchBytes">> {
- return {
- maxDocsPerBatch: validatePositiveIntegerOption("maxDocsPerBatch", options?.maxDocsPerBatch, DEFAULT_EMBED_MAX_DOCS_PER_BATCH),
- maxBatchBytes: validatePositiveIntegerOption("maxBatchBytes", options?.maxBatchBytes, DEFAULT_EMBED_MAX_BATCH_BYTES),
- };
- }
- function getPendingEmbeddingDocs(db: Database): PendingEmbeddingDoc[] {
- return db.prepare(`
- SELECT d.hash, MIN(d.path) as path, length(CAST(c.doc AS BLOB)) as bytes
- FROM documents d
- JOIN content c ON d.hash = c.hash
- LEFT JOIN content_vectors v ON d.hash = v.hash AND v.seq = 0
- WHERE d.active = 1 AND v.hash IS NULL
- GROUP BY d.hash
- ORDER BY MIN(d.path)
- `).all() as PendingEmbeddingDoc[];
- }
- function buildEmbeddingBatches(
- docs: PendingEmbeddingDoc[],
- maxDocsPerBatch: number,
- maxBatchBytes: number,
- ): PendingEmbeddingDoc[][] {
- const batches: PendingEmbeddingDoc[][] = [];
- let currentBatch: PendingEmbeddingDoc[] = [];
- let currentBytes = 0;
- for (const doc of docs) {
- const docBytes = Math.max(0, doc.bytes);
- const wouldExceedDocs = currentBatch.length >= maxDocsPerBatch;
- const wouldExceedBytes = currentBatch.length > 0 && (currentBytes + docBytes) > maxBatchBytes;
- if (wouldExceedDocs || wouldExceedBytes) {
- batches.push(currentBatch);
- currentBatch = [];
- currentBytes = 0;
- }
- currentBatch.push(doc);
- currentBytes += docBytes;
- }
- if (currentBatch.length > 0) {
- batches.push(currentBatch);
- }
- return batches;
- }
- function getEmbeddingDocsForBatch(db: Database, batch: PendingEmbeddingDoc[]): EmbeddingDoc[] {
- if (batch.length === 0) return [];
- const placeholders = batch.map(() => "?").join(",");
- const rows = db.prepare(`
- SELECT hash, doc as body
- FROM content
- WHERE hash IN (${placeholders})
- `).all(...batch.map(doc => doc.hash)) as { hash: string; body: string }[];
- const bodyByHash = new Map(rows.map(row => [row.hash, row.body]));
- return batch.map((doc) => ({
- ...doc,
- body: bodyByHash.get(doc.hash) ?? "",
- }));
- }
- /**
- * Generate vector embeddings for documents that need them.
- * Pure function — no console output, no db lifecycle management.
- * Uses the store's LlamaCpp instance if set, otherwise the global singleton.
- */
- export async function generateEmbeddings(
- store: Store,
- options?: EmbedOptions
- ): Promise<EmbedResult> {
- const db = store.db;
- const model = options?.model ?? DEFAULT_EMBED_MODEL;
- const now = new Date().toISOString();
- const { maxDocsPerBatch, maxBatchBytes } = resolveEmbedOptions(options);
- const encoder = new TextEncoder();
- if (options?.force) {
- clearAllEmbeddings(db);
- }
- const docsToEmbed = getPendingEmbeddingDocs(db);
- if (docsToEmbed.length === 0) {
- return { docsProcessed: 0, chunksEmbedded: 0, errors: 0, durationMs: 0 };
- }
- const totalBytes = docsToEmbed.reduce((sum, doc) => sum + Math.max(0, doc.bytes), 0);
- const totalDocs = docsToEmbed.length;
- const startTime = Date.now();
- // Use store's LlamaCpp or global singleton, wrapped in a session
- const llm = getLlm(store);
- const embedModelUri = llm.embedModelName;
- // Create a session manager for this llm instance
- const result = await withLLMSessionForLlm(llm, async (session) => {
- let chunksEmbedded = 0;
- let errors = 0;
- let bytesProcessed = 0;
- let totalChunks = 0;
- let vectorTableInitialized = false;
- const BATCH_SIZE = 32;
- const batches = buildEmbeddingBatches(docsToEmbed, maxDocsPerBatch, maxBatchBytes);
- for (const batchMeta of batches) {
- // Abort early if session has been invalidated
- if (!session.isValid) {
- console.warn(`⚠ Session expired — skipping remaining document batches`);
- break;
- }
- const batchDocs = getEmbeddingDocsForBatch(db, batchMeta);
- const batchChunks: ChunkItem[] = [];
- const batchBytes = batchMeta.reduce((sum, doc) => sum + Math.max(0, doc.bytes), 0);
- for (const doc of batchDocs) {
- if (!doc.body.trim()) continue;
- const title = extractTitle(doc.body, doc.path);
- const chunks = await chunkDocumentByTokens(
- doc.body,
- undefined, undefined, undefined,
- doc.path,
- options?.chunkStrategy,
- session.signal,
- );
- for (let seq = 0; seq < chunks.length; seq++) {
- batchChunks.push({
- hash: doc.hash,
- title,
- text: chunks[seq]!.text,
- seq,
- pos: chunks[seq]!.pos,
- tokens: chunks[seq]!.tokens,
- bytes: encoder.encode(chunks[seq]!.text).length,
- });
- }
- }
- totalChunks += batchChunks.length;
- if (batchChunks.length === 0) {
- bytesProcessed += batchBytes;
- options?.onProgress?.({ chunksEmbedded, totalChunks, bytesProcessed, totalBytes, errors });
- continue;
- }
- if (!vectorTableInitialized) {
- const firstChunk = batchChunks[0]!;
- const firstText = formatDocForEmbedding(firstChunk.text, firstChunk.title, embedModelUri);
- const firstResult = await session.embed(firstText, { model });
- if (!firstResult) {
- throw new Error("Failed to get embedding dimensions from first chunk");
- }
- store.ensureVecTable(firstResult.embedding.length);
- vectorTableInitialized = true;
- }
- const totalBatchChunkBytes = batchChunks.reduce((sum, chunk) => sum + chunk.bytes, 0);
- let batchChunkBytesProcessed = 0;
- for (let batchStart = 0; batchStart < batchChunks.length; batchStart += BATCH_SIZE) {
- // Abort early if session has been invalidated (e.g. max duration exceeded)
- if (!session.isValid) {
- const remaining = batchChunks.length - batchStart;
- errors += remaining;
- console.warn(`⚠ Session expired — skipping ${remaining} remaining chunks`);
- break;
- }
- // Abort early if error rate is too high (>80% of processed chunks failed)
- const processed = chunksEmbedded + errors;
- if (processed >= BATCH_SIZE && errors > processed * 0.8) {
- const remaining = batchChunks.length - batchStart;
- errors += remaining;
- console.warn(`⚠ Error rate too high (${errors}/${processed}) — aborting embedding`);
- break;
- }
- const batchEnd = Math.min(batchStart + BATCH_SIZE, batchChunks.length);
- const chunkBatch = batchChunks.slice(batchStart, batchEnd);
- const texts = chunkBatch.map(chunk => formatDocForEmbedding(chunk.text, chunk.title, embedModelUri));
- try {
- const embeddings = await session.embedBatch(texts, { model });
- for (let i = 0; i < chunkBatch.length; i++) {
- const chunk = chunkBatch[i]!;
- const embedding = embeddings[i];
- if (embedding) {
- insertEmbedding(db, chunk.hash, chunk.seq, chunk.pos, new Float32Array(embedding.embedding), model, now);
- chunksEmbedded++;
- } else {
- errors++;
- }
- batchChunkBytesProcessed += chunk.bytes;
- }
- } catch {
- // Batch failed — try individual embeddings as fallback
- // But skip if session is already invalid (avoids N doomed retries)
- if (!session.isValid) {
- errors += chunkBatch.length;
- batchChunkBytesProcessed += chunkBatch.reduce((sum, c) => sum + c.bytes, 0);
- } else {
- for (const chunk of chunkBatch) {
- try {
- const text = formatDocForEmbedding(chunk.text, chunk.title, embedModelUri);
- const result = await session.embed(text, { model });
- if (result) {
- insertEmbedding(db, chunk.hash, chunk.seq, chunk.pos, new Float32Array(result.embedding), model, now);
- chunksEmbedded++;
- } else {
- errors++;
- }
- } catch {
- errors++;
- }
- batchChunkBytesProcessed += chunk.bytes;
- }
- }
- }
- const proportionalBytes = totalBatchChunkBytes === 0
- ? batchBytes
- : Math.min(batchBytes, Math.round((batchChunkBytesProcessed / totalBatchChunkBytes) * batchBytes));
- options?.onProgress?.({
- chunksEmbedded,
- totalChunks,
- bytesProcessed: bytesProcessed + proportionalBytes,
- totalBytes,
- errors,
- });
- }
- bytesProcessed += batchBytes;
- options?.onProgress?.({ chunksEmbedded, totalChunks, bytesProcessed, totalBytes, errors });
- }
- return { chunksEmbedded, errors };
- }, { maxDuration: 30 * 60 * 1000, name: 'generateEmbeddings' });
- return {
- docsProcessed: totalDocs,
- chunksEmbedded: result.chunksEmbedded,
- errors: result.errors,
- durationMs: Date.now() - startTime,
- };
- }
- /**
- * Create a new store instance with the given database path.
- * If no path is provided, uses the default path (~/.cache/qmd/index.sqlite).
- *
- * @param dbPath - Path to the SQLite database file
- * @returns Store instance with all methods bound to the database
- */
- export function createStore(dbPath?: string): Store {
- const resolvedPath = dbPath || getDefaultDbPath();
- const db = openDatabase(resolvedPath);
- initializeDatabase(db);
- const store: Store = {
- db,
- dbPath: resolvedPath,
- close: () => db.close(),
- ensureVecTable: (dimensions: number) => ensureVecTableInternal(db, dimensions),
- // Index health
- getHashesNeedingEmbedding: () => getHashesNeedingEmbedding(db),
- getIndexHealth: () => getIndexHealth(db),
- getStatus: () => getStatus(db),
- // Caching
- getCacheKey,
- getCachedResult: (cacheKey: string) => getCachedResult(db, cacheKey),
- setCachedResult: (cacheKey: string, result: string) => setCachedResult(db, cacheKey, result),
- clearCache: () => clearCache(db),
- // Cleanup and maintenance
- deleteLLMCache: () => deleteLLMCache(db),
- deleteInactiveDocuments: () => deleteInactiveDocuments(db),
- cleanupOrphanedContent: () => cleanupOrphanedContent(db),
- cleanupOrphanedVectors: () => cleanupOrphanedVectors(db),
- vacuumDatabase: () => vacuumDatabase(db),
- // Context
- getContextForFile: (filepath: string) => getContextForFile(db, filepath),
- getContextForPath: (collectionName: string, path: string) => getContextForPath(db, collectionName, path),
- getCollectionByName: (name: string) => getCollectionByName(db, name),
- getCollectionsWithoutContext: () => getCollectionsWithoutContext(db),
- getTopLevelPathsWithoutContext: (collectionName: string) => getTopLevelPathsWithoutContext(db, collectionName),
- // Virtual paths
- parseVirtualPath,
- buildVirtualPath,
- isVirtualPath,
- resolveVirtualPath: (virtualPath: string) => resolveVirtualPath(db, virtualPath),
- toVirtualPath: (absolutePath: string) => toVirtualPath(db, absolutePath),
- // Search
- searchFTS: (query: string, limit?: number, collectionName?: string) => searchFTS(db, query, limit, collectionName),
- searchVec: (query: string, model: string, limit?: number, collectionName?: string, session?: ILLMSession, precomputedEmbedding?: number[]) => searchVec(db, query, model, limit, collectionName, session, precomputedEmbedding),
- // Query expansion & reranking
- expandQuery: (query: string, model?: string, intent?: string) => expandQuery(query, model, db, intent, store.llm),
- rerank: (query: string, documents: { file: string; text: string }[], model?: string, intent?: string) => rerank(query, documents, model, db, intent, store.llm),
- // Document retrieval
- findDocument: (filename: string, options?: { includeBody?: boolean }) => findDocument(db, filename, options),
- getDocumentBody: (doc: DocumentResult | { filepath: string }, fromLine?: number, maxLines?: number) => getDocumentBody(db, doc, fromLine, maxLines),
- findDocuments: (pattern: string, options?: { includeBody?: boolean; maxBytes?: number }) => findDocuments(db, pattern, options),
- // Fuzzy matching and docid lookup
- findSimilarFiles: (query: string, maxDistance?: number, limit?: number) => findSimilarFiles(db, query, maxDistance, limit),
- matchFilesByGlob: (pattern: string) => matchFilesByGlob(db, pattern),
- findDocumentByDocid: (docid: string) => findDocumentByDocid(db, docid),
- // Document indexing operations
- insertContent: (hash: string, content: string, createdAt: string) => insertContent(db, hash, content, createdAt),
- insertDocument: (collectionName: string, path: string, title: string, hash: string, createdAt: string, modifiedAt: string) => insertDocument(db, collectionName, path, title, hash, createdAt, modifiedAt),
- findActiveDocument: (collectionName: string, path: string) => findActiveDocument(db, collectionName, path),
- updateDocumentTitle: (documentId: number, title: string, modifiedAt: string) => updateDocumentTitle(db, documentId, title, modifiedAt),
- updateDocument: (documentId: number, title: string, hash: string, modifiedAt: string) => updateDocument(db, documentId, title, hash, modifiedAt),
- deactivateDocument: (collectionName: string, path: string) => deactivateDocument(db, collectionName, path),
- getActiveDocumentPaths: (collectionName: string) => getActiveDocumentPaths(db, collectionName),
- // Vector/embedding operations
- getHashesForEmbedding: () => getHashesForEmbedding(db),
- clearAllEmbeddings: () => clearAllEmbeddings(db),
- insertEmbedding: (hash: string, seq: number, pos: number, embedding: Float32Array, model: string, embeddedAt: string) => insertEmbedding(db, hash, seq, pos, embedding, model, embeddedAt),
- };
- return store;
- }
- // =============================================================================
- // Core Document Type
- // =============================================================================
- /**
- * Unified document result type with all metadata.
- * Body is optional - use getDocumentBody() to load it separately if needed.
- */
- export type DocumentResult = {
- filepath: string; // Full filesystem path
- displayPath: string; // Short display path (e.g., "docs/readme.md")
- title: string; // Document title (from first heading or filename)
- context: string | null; // Folder context description if configured
- hash: string; // Content hash for caching/change detection
- docid: string; // Short docid (first 6 chars of hash) for quick reference
- collectionName: string; // Parent collection name
- modifiedAt: string; // Last modification timestamp
- bodyLength: number; // Body length in bytes (useful before loading)
- body?: string; // Document body (optional, load with getDocumentBody)
- };
- /**
- * Extract short docid from a full hash (first 6 characters).
- */
- export function getDocid(hash: string): string {
- return hash.slice(0, 6);
- }
- /**
- * Handelize a filename to be more token-friendly.
- * - Convert triple underscore `___` to `/` (folder separator)
- * - Convert to lowercase
- * - Replace sequences of non-word chars (except /) with single dash
- * - Remove leading/trailing dashes from path segments
- * - Preserve folder structure (a/b/c/d.md stays structured)
- * - Preserve file extension
- */
- /** Replace emoji/symbol codepoints with their hex representation (e.g. 🐘 → 1f418) */
- function emojiToHex(str: string): string {
- return str.replace(/(?:\p{So}\p{Mn}?|\p{Sk})+/gu, (run) => {
- // Split the run into individual emoji and convert each to hex, dash-separated
- return [...run].filter(c => /\p{So}|\p{Sk}/u.test(c))
- .map(c => c.codePointAt(0)!.toString(16)).join('-');
- });
- }
- export function handelize(path: string): string {
- if (!path || path.trim() === '') {
- throw new Error('handelize: path cannot be empty');
- }
- // Allow route-style "$" filenames while still rejecting paths with no usable content.
- // Emoji (\p{So}) counts as valid content — they get converted to hex codepoints below.
- const segments = path.split('/').filter(Boolean);
- const lastSegment = segments[segments.length - 1] || '';
- const filenameWithoutExt = lastSegment.replace(/\.[^.]+$/, '');
- const hasValidContent = /[\p{L}\p{N}\p{So}\p{Sk}$]/u.test(filenameWithoutExt);
- if (!hasValidContent) {
- throw new Error(`handelize: path "${path}" has no valid filename content`);
- }
- const result = path
- .replace(/___/g, '/') // Triple underscore becomes folder separator
- .toLowerCase()
- .split('/')
- .map((segment, idx, arr) => {
- const isLastSegment = idx === arr.length - 1;
- // Convert emoji to hex codepoints before cleaning
- segment = emojiToHex(segment);
- if (isLastSegment) {
- // For the filename (last segment), preserve the extension
- const extMatch = segment.match(/(\.[a-z0-9]+)$/i);
- const ext = extMatch ? extMatch[1] : '';
- const nameWithoutExt = ext ? segment.slice(0, -ext.length) : segment;
- const cleanedName = nameWithoutExt
- .replace(/[^\p{L}\p{N}$]+/gu, '-') // Keep letters, numbers, "$"; dash-separate rest (including dots)
- .replace(/^-+|-+$/g, ''); // Remove leading/trailing dashes
- return cleanedName + ext;
- } else {
- // For directories, just clean normally
- return segment
- .replace(/[^\p{L}\p{N}$]+/gu, '-')
- .replace(/^-+|-+$/g, '');
- }
- })
- .filter(Boolean)
- .join('/');
- if (!result) {
- throw new Error(`handelize: path "${path}" resulted in empty string after processing`);
- }
- return result;
- }
- /**
- * Search result extends DocumentResult with score and source info
- */
- export type SearchResult = DocumentResult & {
- score: number; // Relevance score (0-1)
- source: "fts" | "vec"; // Search source (full-text or vector)
- chunkPos?: number; // Character position of matching chunk (for vector search)
- };
- /**
- * Ranked result for RRF fusion (simplified, used internally)
- */
- export type RankedResult = {
- file: string;
- displayPath: string;
- title: string;
- body: string;
- score: number;
- };
- export type RRFContributionTrace = {
- listIndex: number;
- source: "fts" | "vec";
- queryType: "original" | "lex" | "vec" | "hyde";
- query: string;
- rank: number; // 1-indexed rank within list
- weight: number;
- backendScore: number; // Backend-normalized score before fusion
- rrfContribution: number; // weight / (k + rank)
- };
- export type RRFScoreTrace = {
- contributions: RRFContributionTrace[];
- baseScore: number; // Sum of reciprocal-rank contributions
- topRank: number; // Best (lowest) rank seen across lists
- topRankBonus: number; // +0.05 for rank 1, +0.02 for rank 2-3
- totalScore: number; // baseScore + topRankBonus
- };
- export type HybridQueryExplain = {
- ftsScores: number[];
- vectorScores: number[];
- rrf: {
- rank: number; // Rank after RRF fusion (1-indexed)
- positionScore: number; // 1 / rank used in position-aware blending
- weight: number; // Position-aware RRF weight (0.75 / 0.60 / 0.40)
- baseScore: number;
- topRankBonus: number;
- totalScore: number;
- contributions: RRFContributionTrace[];
- };
- rerankScore: number;
- blendedScore: number;
- };
- /**
- * Error result when document is not found
- */
- export type DocumentNotFound = {
- error: "not_found";
- query: string;
- similarFiles: string[];
- };
- /**
- * Result from multi-get operations
- */
- export type MultiGetResult = {
- doc: DocumentResult;
- skipped: false;
- } | {
- doc: Pick<DocumentResult, "filepath" | "displayPath">;
- skipped: true;
- skipReason: string;
- };
- export type CollectionInfo = {
- name: string;
- path: string | null;
- pattern: string | null;
- documents: number;
- lastUpdated: string;
- };
- export type IndexStatus = {
- totalDocuments: number;
- needsEmbedding: number;
- hasVectorIndex: boolean;
- collections: CollectionInfo[];
- };
- // =============================================================================
- // Index health
- // =============================================================================
- export function getHashesNeedingEmbedding(db: Database): number {
- const result = db.prepare(`
- SELECT COUNT(DISTINCT d.hash) as count
- FROM documents d
- LEFT JOIN content_vectors v ON d.hash = v.hash AND v.seq = 0
- WHERE d.active = 1 AND v.hash IS NULL
- `).get() as { count: number };
- return result.count;
- }
- export type IndexHealthInfo = {
- needsEmbedding: number;
- totalDocs: number;
- daysStale: number | null;
- };
- export function getIndexHealth(db: Database): IndexHealthInfo {
- const needsEmbedding = getHashesNeedingEmbedding(db);
- const totalDocs = (db.prepare(`SELECT COUNT(*) as count FROM documents WHERE active = 1`).get() as { count: number }).count;
- const mostRecent = db.prepare(`SELECT MAX(modified_at) as latest FROM documents WHERE active = 1`).get() as { latest: string | null };
- let daysStale: number | null = null;
- if (mostRecent?.latest) {
- const lastUpdate = new Date(mostRecent.latest);
- daysStale = Math.floor((Date.now() - lastUpdate.getTime()) / (24 * 60 * 60 * 1000));
- }
- return { needsEmbedding, totalDocs, daysStale };
- }
- // =============================================================================
- // Caching
- // =============================================================================
- export function getCacheKey(url: string, body: object): string {
- const hash = createHash("sha256");
- hash.update(url);
- hash.update(JSON.stringify(body));
- return hash.digest("hex");
- }
- export function getCachedResult(db: Database, cacheKey: string): string | null {
- const row = db.prepare(`SELECT result FROM llm_cache WHERE hash = ?`).get(cacheKey) as { result: string } | null;
- return row?.result || null;
- }
- export function setCachedResult(db: Database, cacheKey: string, result: string): void {
- const now = new Date().toISOString();
- db.prepare(`INSERT OR REPLACE INTO llm_cache (hash, result, created_at) VALUES (?, ?, ?)`).run(cacheKey, result, now);
- if (Math.random() < 0.01) {
- db.exec(`DELETE FROM llm_cache WHERE hash NOT IN (SELECT hash FROM llm_cache ORDER BY created_at DESC LIMIT 1000)`);
- }
- }
- export function clearCache(db: Database): void {
- db.exec(`DELETE FROM llm_cache`);
- }
- // =============================================================================
- // Cleanup and maintenance operations
- // =============================================================================
- /**
- * Delete cached LLM API responses.
- * Returns the number of cached responses deleted.
- */
- export function deleteLLMCache(db: Database): number {
- const result = db.prepare(`DELETE FROM llm_cache`).run();
- return result.changes;
- }
- /**
- * Remove inactive document records (active = 0).
- * Returns the number of inactive documents deleted.
- */
- export function deleteInactiveDocuments(db: Database): number {
- const result = db.prepare(`DELETE FROM documents WHERE active = 0`).run();
- return result.changes;
- }
- /**
- * Remove orphaned content hashes that are not referenced by any active document.
- * Returns the number of orphaned content hashes deleted.
- */
- export function cleanupOrphanedContent(db: Database): number {
- const result = db.prepare(`
- DELETE FROM content
- WHERE hash NOT IN (SELECT DISTINCT hash FROM documents WHERE active = 1)
- `).run();
- return result.changes;
- }
- /**
- * Remove orphaned vector embeddings that are not referenced by any active document.
- * Returns the number of orphaned embedding chunks deleted.
- */
- export function cleanupOrphanedVectors(db: Database): number {
- // sqlite-vec may not be loaded (e.g. Bun's bun:sqlite lacks loadExtension).
- // The vectors_vec virtual table can appear in sqlite_master from a prior
- // session, but querying it without the vec0 module loaded will crash (#380).
- if (!isSqliteVecAvailable()) {
- return 0;
- }
- // The schema entry can exist even when sqlite-vec itself is unavailable
- // (for example when reopening a DB without vec0 loaded). In that case,
- // touching the virtual table throws "no such module: vec0" and cleanup
- // should degrade gracefully like the rest of the vector features.
- try {
- db.prepare(`SELECT 1 FROM vectors_vec LIMIT 0`).get();
- } catch {
- return 0;
- }
- // Count orphaned vectors first
- const countResult = db.prepare(`
- SELECT COUNT(*) as c FROM content_vectors cv
- WHERE NOT EXISTS (
- SELECT 1 FROM documents d WHERE d.hash = cv.hash AND d.active = 1
- )
- `).get() as { c: number };
- if (countResult.c === 0) {
- return 0;
- }
- // Delete from vectors_vec first
- db.exec(`
- DELETE FROM vectors_vec WHERE hash_seq IN (
- SELECT cv.hash || '_' || cv.seq FROM content_vectors cv
- WHERE NOT EXISTS (
- SELECT 1 FROM documents d WHERE d.hash = cv.hash AND d.active = 1
- )
- )
- `);
- // Delete from content_vectors
- db.exec(`
- DELETE FROM content_vectors WHERE hash NOT IN (
- SELECT hash FROM documents WHERE active = 1
- )
- `);
- return countResult.c;
- }
- /**
- * Run VACUUM to reclaim unused space in the database.
- * This operation rebuilds the database file to eliminate fragmentation.
- */
- export function vacuumDatabase(db: Database): void {
- db.exec(`VACUUM`);
- }
- // =============================================================================
- // Document helpers
- // =============================================================================
- export async function hashContent(content: string): Promise<string> {
- const hash = createHash("sha256");
- hash.update(content);
- return hash.digest("hex");
- }
- const titleExtractors: Record<string, (content: string) => string | null> = {
- '.md': (content) => {
- const match = content.match(/^##?\s+(.+)$/m);
- if (match) {
- const title = (match[1] ?? "").trim();
- if (title === "📝 Notes" || title === "Notes") {
- const nextMatch = content.match(/^##\s+(.+)$/m);
- if (nextMatch?.[1]) return nextMatch[1].trim();
- }
- return title;
- }
- return null;
- },
- '.org': (content) => {
- const titleProp = content.match(/^#\+TITLE:\s*(.+)$/im);
- if (titleProp?.[1]) return titleProp[1].trim();
- const heading = content.match(/^\*+\s+(.+)$/m);
- if (heading?.[1]) return heading[1].trim();
- return null;
- },
- };
- export function extractTitle(content: string, filename: string): string {
- const ext = filename.slice(filename.lastIndexOf('.')).toLowerCase();
- const extractor = titleExtractors[ext];
- if (extractor) {
- const title = extractor(content);
- if (title) return title;
- }
- return filename.replace(/\.[^.]+$/, "").split("/").pop() || filename;
- }
- // =============================================================================
- // Document indexing operations
- // =============================================================================
- /**
- * Insert content into the content table (content-addressable storage).
- * Uses INSERT OR IGNORE so duplicate hashes are skipped.
- */
- export function insertContent(db: Database, hash: string, content: string, createdAt: string): void {
- db.prepare(`INSERT OR IGNORE INTO content (hash, doc, created_at) VALUES (?, ?, ?)`)
- .run(hash, content, createdAt);
- }
- /**
- * Insert a new document into the documents table.
- */
- export function insertDocument(
- db: Database,
- collectionName: string,
- path: string,
- title: string,
- hash: string,
- createdAt: string,
- modifiedAt: string
- ): void {
- db.prepare(`
- INSERT INTO documents (collection, path, title, hash, created_at, modified_at, active)
- VALUES (?, ?, ?, ?, ?, ?, 1)
- ON CONFLICT(collection, path) DO UPDATE SET
- title = excluded.title,
- hash = excluded.hash,
- modified_at = excluded.modified_at,
- active = 1
- `).run(collectionName, path, title, hash, createdAt, modifiedAt);
- }
- /**
- * Find an active document by collection name and path.
- */
- export function findActiveDocument(
- db: Database,
- collectionName: string,
- path: string
- ): { id: number; hash: string; title: string } | null {
- const row = db.prepare(`
- SELECT id, hash, title FROM documents
- WHERE collection = ? AND path = ? AND active = 1
- `).get(collectionName, path) as { id: number; hash: string; title: string } | undefined;
- return row ?? null;
- }
- /**
- * Update the title and modified_at timestamp for a document.
- */
- export function updateDocumentTitle(
- db: Database,
- documentId: number,
- title: string,
- modifiedAt: string
- ): void {
- db.prepare(`UPDATE documents SET title = ?, modified_at = ? WHERE id = ?`)
- .run(title, modifiedAt, documentId);
- }
- /**
- * Update an existing document's hash, title, and modified_at timestamp.
- * Used when content changes but the file path stays the same.
- */
- export function updateDocument(
- db: Database,
- documentId: number,
- title: string,
- hash: string,
- modifiedAt: string
- ): void {
- db.prepare(`UPDATE documents SET title = ?, hash = ?, modified_at = ? WHERE id = ?`)
- .run(title, hash, modifiedAt, documentId);
- }
- /**
- * Deactivate a document (mark as inactive but don't delete).
- */
- export function deactivateDocument(db: Database, collectionName: string, path: string): void {
- db.prepare(`UPDATE documents SET active = 0 WHERE collection = ? AND path = ? AND active = 1`)
- .run(collectionName, path);
- }
- /**
- * Get all active document paths for a collection.
- */
- export function getActiveDocumentPaths(db: Database, collectionName: string): string[] {
- const rows = db.prepare(`
- SELECT path FROM documents WHERE collection = ? AND active = 1
- `).all(collectionName) as { path: string }[];
- return rows.map(r => r.path);
- }
- export { formatQueryForEmbedding, formatDocForEmbedding };
- /**
- * Chunk a document using regex-only break point detection.
- * This is the sync, backward-compatible API used by tests and legacy callers.
- */
- export function chunkDocument(
- content: string,
- maxChars: number = CHUNK_SIZE_CHARS,
- overlapChars: number = CHUNK_OVERLAP_CHARS,
- windowChars: number = CHUNK_WINDOW_CHARS
- ): { text: string; pos: number }[] {
- const breakPoints = scanBreakPoints(content);
- const codeFences = findCodeFences(content);
- return chunkDocumentWithBreakPoints(content, breakPoints, codeFences, maxChars, overlapChars, windowChars);
- }
- /**
- * Async AST-aware chunking. Detects language from filepath, computes AST
- * break points for supported code files, merges with regex break points,
- * and delegates to the shared chunk algorithm.
- *
- * Falls back to regex-only when strategy is "regex", filepath is absent,
- * or language is unsupported.
- */
- export async function chunkDocumentAsync(
- content: string,
- maxChars: number = CHUNK_SIZE_CHARS,
- overlapChars: number = CHUNK_OVERLAP_CHARS,
- windowChars: number = CHUNK_WINDOW_CHARS,
- filepath?: string,
- chunkStrategy: ChunkStrategy = "regex",
- ): Promise<{ text: string; pos: number }[]> {
- const regexPoints = scanBreakPoints(content);
- const codeFences = findCodeFences(content);
- let breakPoints = regexPoints;
- if (chunkStrategy === "auto" && filepath) {
- const { getASTBreakPoints } = await import("./ast.js");
- const astPoints = await getASTBreakPoints(content, filepath);
- if (astPoints.length > 0) {
- breakPoints = mergeBreakPoints(regexPoints, astPoints);
- }
- }
- return chunkDocumentWithBreakPoints(content, breakPoints, codeFences, maxChars, overlapChars, windowChars);
- }
- /**
- * Chunk a document by actual token count using the LLM tokenizer.
- * More accurate than character-based chunking but requires async.
- *
- * When filepath and chunkStrategy are provided, uses AST-aware break points
- * for supported code files.
- */
- export async function chunkDocumentByTokens(
- content: string,
- maxTokens: number = CHUNK_SIZE_TOKENS,
- overlapTokens: number = CHUNK_OVERLAP_TOKENS,
- windowTokens: number = CHUNK_WINDOW_TOKENS,
- filepath?: string,
- chunkStrategy: ChunkStrategy = "regex",
- signal?: AbortSignal
- ): Promise<{ text: string; pos: number; tokens: number }[]> {
- const llm = getDefaultLlamaCpp();
- // Use moderate chars/token estimate (prose ~4, code ~2, mixed ~3)
- // If chunks exceed limit, they'll be re-split with actual ratio
- const avgCharsPerToken = 3;
- const maxChars = maxTokens * avgCharsPerToken;
- const overlapChars = overlapTokens * avgCharsPerToken;
- const windowChars = windowTokens * avgCharsPerToken;
- // Chunk in character space with conservative estimate
- // Use AST-aware chunking for the first pass when filepath/strategy provided
- let charChunks = await chunkDocumentAsync(content, maxChars, overlapChars, windowChars, filepath, chunkStrategy);
- // Tokenize and split any chunks that still exceed limit
- const results: { text: string; pos: number; tokens: number }[] = [];
- const clampOverlapChars = (value: number, maxChars: number): number => {
- if (maxChars <= 1) return 0;
- return Math.max(0, Math.min(maxChars - 1, Math.floor(value)));
- };
- const pushChunkWithinTokenLimit = async (text: string, pos: number): Promise<void> => {
- if (signal?.aborted) return;
- const tokens = await llm.tokenize(text);
- if (tokens.length <= maxTokens || text.length <= 1) {
- results.push({ text, pos, tokens: tokens.length });
- return;
- }
- const actualCharsPerToken = text.length / tokens.length;
- let safeMaxChars = Math.floor(maxTokens * actualCharsPerToken * 0.95);
- if (!Number.isFinite(safeMaxChars) || safeMaxChars < 1) {
- safeMaxChars = Math.floor(text.length / 2);
- }
- safeMaxChars = Math.max(1, Math.min(text.length - 1, safeMaxChars));
- let nextOverlapChars = clampOverlapChars(
- overlapChars * actualCharsPerToken / 2,
- safeMaxChars,
- );
- let nextWindowChars = Math.max(0, Math.floor(windowChars * actualCharsPerToken / 2));
- let subChunks = chunkDocument(text, safeMaxChars, nextOverlapChars, nextWindowChars);
- // Pathological single-line blobs can produce no meaningful breakpoint progress.
- // Fall back to a simple half split so every recursion step strictly shrinks.
- if (
- subChunks.length <= 1
- || subChunks[0]?.text.length === text.length
- ) {
- safeMaxChars = Math.max(1, Math.floor(text.length / 2));
- nextOverlapChars = 0;
- nextWindowChars = 0;
- subChunks = chunkDocument(text, safeMaxChars, nextOverlapChars, nextWindowChars);
- }
- if (
- subChunks.length <= 1
- || subChunks[0]?.text.length === text.length
- ) {
- const fallbackTokens = tokens.slice(0, Math.max(1, maxTokens));
- const truncatedText = await llm.detokenize(fallbackTokens);
- results.push({
- text: truncatedText,
- pos,
- tokens: fallbackTokens.length,
- });
- return;
- }
- for (const subChunk of subChunks) {
- await pushChunkWithinTokenLimit(text.slice(subChunk.pos, subChunk.pos + subChunk.text.length), pos + subChunk.pos);
- }
- };
- for (const chunk of charChunks) {
- await pushChunkWithinTokenLimit(chunk.text, chunk.pos);
- }
- return results;
- }
- // =============================================================================
- // Fuzzy matching
- // =============================================================================
- function levenshtein(a: string, b: string): number {
- const m = a.length, n = b.length;
- if (m === 0) return n;
- if (n === 0) return m;
- const dp: number[][] = Array.from({ length: m + 1 }, () => Array(n + 1).fill(0));
- for (let i = 0; i <= m; i++) dp[i]![0] = i;
- for (let j = 0; j <= n; j++) dp[0]![j] = j;
- for (let i = 1; i <= m; i++) {
- for (let j = 1; j <= n; j++) {
- const cost = a[i - 1] === b[j - 1] ? 0 : 1;
- dp[i]![j] = Math.min(
- dp[i - 1]![j]! + 1,
- dp[i]![j - 1]! + 1,
- dp[i - 1]![j - 1]! + cost
- );
- }
- }
- return dp[m]![n]!;
- }
- /**
- * Normalize a docid input by stripping surrounding quotes and leading #.
- * Handles: "#abc123", 'abc123', "abc123", #abc123, abc123
- * Returns the bare hex string.
- */
- export function normalizeDocid(docid: string): string {
- let normalized = docid.trim();
- // Strip surrounding quotes (single or double)
- if ((normalized.startsWith('"') && normalized.endsWith('"')) ||
- (normalized.startsWith("'") && normalized.endsWith("'"))) {
- normalized = normalized.slice(1, -1);
- }
- // Strip leading # if present
- if (normalized.startsWith('#')) {
- normalized = normalized.slice(1);
- }
- return normalized;
- }
- /**
- * Check if a string looks like a docid reference.
- * Accepts: #abc123, abc123, "#abc123", "abc123", '#abc123', 'abc123'
- * Returns true if the normalized form is a valid hex string of 6+ chars.
- */
- export function isDocid(input: string): boolean {
- const normalized = normalizeDocid(input);
- // Must be at least 6 hex characters
- return normalized.length >= 6 && /^[a-f0-9]+$/i.test(normalized);
- }
- /**
- * Find a document by its short docid (first 6 characters of hash).
- * Returns the document's virtual path if found, null otherwise.
- * If multiple documents match the same short hash (collision), returns the first one.
- *
- * Accepts lenient input: #abc123, abc123, "#abc123", "abc123"
- */
- export function findDocumentByDocid(db: Database, docid: string): { filepath: string; hash: string } | null {
- const shortHash = normalizeDocid(docid);
- if (shortHash.length < 1) return null;
- // Look up documents where hash starts with the short hash
- const doc = db.prepare(`
- SELECT 'qmd://' || d.collection || '/' || d.path as filepath, d.hash
- FROM documents d
- WHERE d.hash LIKE ? AND d.active = 1
- LIMIT 1
- `).get(`${shortHash}%`) as { filepath: string; hash: string } | null;
- return doc;
- }
- export function findSimilarFiles(db: Database, query: string, maxDistance: number = 3, limit: number = 5): string[] {
- const allFiles = db.prepare(`
- SELECT d.path
- FROM documents d
- WHERE d.active = 1
- `).all() as { path: string }[];
- const queryLower = query.toLowerCase();
- const scored = allFiles
- .map(f => ({ path: f.path, dist: levenshtein(f.path.toLowerCase(), queryLower) }))
- .filter(f => f.dist <= maxDistance)
- .sort((a, b) => a.dist - b.dist)
- .slice(0, limit);
- return scored.map(f => f.path);
- }
- export function matchFilesByGlob(db: Database, pattern: string): { filepath: string; displayPath: string; bodyLength: number }[] {
- const allFiles = db.prepare(`
- SELECT
- 'qmd://' || d.collection || '/' || d.path as virtual_path,
- LENGTH(content.doc) as body_length,
- d.path,
- d.collection
- FROM documents d
- JOIN content ON content.hash = d.hash
- WHERE d.active = 1
- `).all() as { virtual_path: string; body_length: number; path: string; collection: string }[];
- const isMatch = picomatch(pattern);
- return allFiles
- .filter(f => isMatch(f.virtual_path) || isMatch(f.path) || isMatch(f.collection + '/' + f.path))
- .map(f => ({
- filepath: f.virtual_path, // Virtual path for precise lookup
- displayPath: f.path, // Relative path for display
- bodyLength: f.body_length
- }));
- }
- // =============================================================================
- // Context
- // =============================================================================
- /**
- * Get context for a file path using hierarchical inheritance.
- * Contexts are collection-scoped and inherit from parent directories.
- * For example, context at "/talks" applies to "/talks/2024/keynote.md".
- *
- * @param db Database instance (unused - kept for compatibility)
- * @param collectionName Collection name
- * @param path Relative path within the collection
- * @returns Context string or null if no context is defined
- */
- export function getContextForPath(db: Database, collectionName: string, path: string): string | null {
- const coll = getStoreCollection(db, collectionName);
- if (!coll) return null;
- // Collect ALL matching contexts (global + all path prefixes)
- const contexts: string[] = [];
- // Add global context if present
- const globalCtx = getStoreGlobalContext(db);
- if (globalCtx) {
- contexts.push(globalCtx);
- }
- // Add all matching path contexts (from most general to most specific)
- if (coll.context) {
- const normalizedPath = path.startsWith("/") ? path : `/${path}`;
- // Collect all matching prefixes
- const matchingContexts: { prefix: string; context: string }[] = [];
- for (const [prefix, context] of Object.entries(coll.context)) {
- const normalizedPrefix = prefix.startsWith("/") ? prefix : `/${prefix}`;
- if (normalizedPath.startsWith(normalizedPrefix)) {
- matchingContexts.push({ prefix: normalizedPrefix, context });
- }
- }
- // Sort by prefix length (shortest/most general first)
- matchingContexts.sort((a, b) => a.prefix.length - b.prefix.length);
- // Add all matching contexts
- for (const match of matchingContexts) {
- contexts.push(match.context);
- }
- }
- // Join all contexts with double newline
- return contexts.length > 0 ? contexts.join('\n\n') : null;
- }
- /**
- * Get context for a file path (virtual or filesystem).
- * Resolves the collection and relative path from the DB store_collections table.
- */
- export function getContextForFile(db: Database, filepath: string): string | null {
- // Handle undefined or null filepath
- if (!filepath) return null;
- // Get all collections from DB
- const collections = getStoreCollections(db);
- // Parse virtual path format: qmd://collection/path
- let collectionName: string | null = null;
- let relativePath: string | null = null;
- const parsedVirtual = filepath.startsWith('qmd://') ? parseVirtualPath(filepath) : null;
- if (parsedVirtual) {
- collectionName = parsedVirtual.collectionName;
- relativePath = parsedVirtual.path;
- } else {
- // Filesystem path: find which collection this absolute path belongs to
- for (const coll of collections) {
- // Skip collections with missing paths
- if (!coll || !coll.path) continue;
- if (filepath.startsWith(coll.path + '/') || filepath === coll.path) {
- collectionName = coll.name;
- // Extract relative path
- relativePath = filepath.startsWith(coll.path + '/')
- ? filepath.slice(coll.path.length + 1)
- : '';
- break;
- }
- }
- if (!collectionName || relativePath === null) return null;
- }
- // Get the collection from DB
- const coll = getStoreCollection(db, collectionName);
- if (!coll) return null;
- // Verify this document exists in the database
- const doc = db.prepare(`
- SELECT d.path
- FROM documents d
- WHERE d.collection = ? AND d.path = ? AND d.active = 1
- LIMIT 1
- `).get(collectionName, relativePath) as { path: string } | null;
- if (!doc) return null;
- // Collect ALL matching contexts (global + all path prefixes)
- const contexts: string[] = [];
- // Add global context if present
- const globalCtx = getStoreGlobalContext(db);
- if (globalCtx) {
- contexts.push(globalCtx);
- }
- // Add all matching path contexts (from most general to most specific)
- if (coll.context) {
- const normalizedPath = relativePath.startsWith("/") ? relativePath : `/${relativePath}`;
- // Collect all matching prefixes
- const matchingContexts: { prefix: string; context: string }[] = [];
- for (const [prefix, context] of Object.entries(coll.context)) {
- const normalizedPrefix = prefix.startsWith("/") ? prefix : `/${prefix}`;
- if (normalizedPath.startsWith(normalizedPrefix)) {
- matchingContexts.push({ prefix: normalizedPrefix, context });
- }
- }
- // Sort by prefix length (shortest/most general first)
- matchingContexts.sort((a, b) => a.prefix.length - b.prefix.length);
- // Add all matching contexts
- for (const match of matchingContexts) {
- contexts.push(match.context);
- }
- }
- // Join all contexts with double newline
- return contexts.length > 0 ? contexts.join('\n\n') : null;
- }
- /**
- * Get collection by name from DB store_collections table.
- */
- export function getCollectionByName(db: Database, name: string): { name: string; pwd: string; glob_pattern: string } | null {
- const collection = getStoreCollection(db, name);
- if (!collection) return null;
- return {
- name: collection.name,
- pwd: collection.path,
- glob_pattern: collection.pattern,
- };
- }
- /**
- * List all collections with document counts from database.
- * Merges store_collections config with database statistics.
- */
- export function listCollections(db: Database): { name: string; pwd: string; glob_pattern: string; doc_count: number; active_count: number; last_modified: string | null; includeByDefault: boolean }[] {
- const collections = getStoreCollections(db);
- // Get document counts from database for each collection
- const result = collections.map(coll => {
- const stats = db.prepare(`
- SELECT
- COUNT(d.id) as doc_count,
- SUM(CASE WHEN d.active = 1 THEN 1 ELSE 0 END) as active_count,
- MAX(d.modified_at) as last_modified
- FROM documents d
- WHERE d.collection = ?
- `).get(coll.name) as { doc_count: number; active_count: number; last_modified: string | null } | null;
- return {
- name: coll.name,
- pwd: coll.path,
- glob_pattern: coll.pattern,
- doc_count: stats?.doc_count || 0,
- active_count: stats?.active_count || 0,
- last_modified: stats?.last_modified || null,
- includeByDefault: coll.includeByDefault !== false,
- };
- });
- return result;
- }
- /**
- * Remove a collection and clean up its documents.
- * Uses collections.ts to remove from YAML config and cleans up database.
- */
- export function removeCollection(db: Database, collectionName: string): { deletedDocs: number; cleanedHashes: number } {
- // Delete documents from database
- const docResult = db.prepare(`DELETE FROM documents WHERE collection = ?`).run(collectionName);
- // Clean up orphaned content hashes
- const cleanupResult = db.prepare(`
- DELETE FROM content
- WHERE hash NOT IN (SELECT DISTINCT hash FROM documents WHERE active = 1)
- `).run();
- // Remove from store_collections
- deleteStoreCollection(db, collectionName);
- return {
- deletedDocs: docResult.changes,
- cleanedHashes: cleanupResult.changes
- };
- }
- /**
- * Rename a collection.
- * Updates both YAML config and database documents table.
- */
- export function renameCollection(db: Database, oldName: string, newName: string): void {
- // Update all documents with the new collection name in database
- db.prepare(`UPDATE documents SET collection = ? WHERE collection = ?`)
- .run(newName, oldName);
- // Rename in store_collections
- renameStoreCollection(db, oldName, newName);
- }
- // =============================================================================
- // Context Management Operations
- // =============================================================================
- /**
- * Insert or update a context for a specific collection and path prefix.
- */
- export function insertContext(db: Database, collectionId: number, pathPrefix: string, context: string): void {
- // Get collection name from ID
- const coll = db.prepare(`SELECT name FROM collections WHERE id = ?`).get(collectionId) as { name: string } | null;
- if (!coll) {
- throw new Error(`Collection with id ${collectionId} not found`);
- }
- // Add context to store_collections
- updateStoreContext(db, coll.name, pathPrefix, context);
- }
- /**
- * Delete a context for a specific collection and path prefix.
- * Returns the number of contexts deleted.
- */
- export function deleteContext(db: Database, collectionName: string, pathPrefix: string): number {
- // Remove context from store_collections
- const success = removeStoreContext(db, collectionName, pathPrefix);
- return success ? 1 : 0;
- }
- /**
- * Delete all global contexts (contexts with empty path_prefix).
- * Returns the number of contexts deleted.
- */
- export function deleteGlobalContexts(db: Database): number {
- let deletedCount = 0;
- // Remove global context
- setStoreGlobalContext(db, undefined);
- deletedCount++;
- // Remove root context (empty string) from all collections
- const collections = getStoreCollections(db);
- for (const coll of collections) {
- const success = removeStoreContext(db, coll.name, '');
- if (success) {
- deletedCount++;
- }
- }
- return deletedCount;
- }
- /**
- * List all contexts, grouped by collection.
- * Returns contexts ordered by collection name, then by path prefix length (longest first).
- */
- export function listPathContexts(db: Database): { collection_name: string; path_prefix: string; context: string }[] {
- const allContexts = getStoreContexts(db);
- // Convert to expected format and sort
- return allContexts.map(ctx => ({
- collection_name: ctx.collection,
- path_prefix: ctx.path,
- context: ctx.context,
- })).sort((a, b) => {
- // Sort by collection name first
- if (a.collection_name !== b.collection_name) {
- return a.collection_name.localeCompare(b.collection_name);
- }
- // Then by path prefix length (longest first)
- if (a.path_prefix.length !== b.path_prefix.length) {
- return b.path_prefix.length - a.path_prefix.length;
- }
- // Then alphabetically
- return a.path_prefix.localeCompare(b.path_prefix);
- });
- }
- /**
- * Get all collections (name only - from YAML config).
- */
- export function getAllCollections(db: Database): { name: string }[] {
- const collections = getStoreCollections(db);
- return collections.map(c => ({ name: c.name }));
- }
- /**
- * Check which collections don't have any context defined.
- * Returns collections that have no context entries at all (not even root context).
- */
- export function getCollectionsWithoutContext(db: Database): { name: string; pwd: string; doc_count: number }[] {
- // Get all collections from DB
- const allCollections = getStoreCollections(db);
- // Filter to those without context
- const collectionsWithoutContext: { name: string; pwd: string; doc_count: number }[] = [];
- for (const coll of allCollections) {
- // Check if collection has any context
- if (!coll.context || Object.keys(coll.context).length === 0) {
- // Get doc count from database
- const stats = db.prepare(`
- SELECT COUNT(d.id) as doc_count
- FROM documents d
- WHERE d.collection = ? AND d.active = 1
- `).get(coll.name) as { doc_count: number } | null;
- collectionsWithoutContext.push({
- name: coll.name,
- pwd: coll.path,
- doc_count: stats?.doc_count || 0,
- });
- }
- }
- return collectionsWithoutContext.sort((a, b) => a.name.localeCompare(b.name));
- }
- /**
- * Get top-level directories in a collection that don't have context.
- * Useful for suggesting where context might be needed.
- */
- export function getTopLevelPathsWithoutContext(db: Database, collectionName: string): string[] {
- // Get all paths in the collection from database
- const paths = db.prepare(`
- SELECT DISTINCT path FROM documents
- WHERE collection = ? AND active = 1
- `).all(collectionName) as { path: string }[];
- // Get existing contexts for this collection from DB
- const dbColl = getStoreCollection(db, collectionName);
- if (!dbColl) return [];
- const contextPrefixes = new Set<string>();
- if (dbColl.context) {
- for (const prefix of Object.keys(dbColl.context)) {
- contextPrefixes.add(prefix);
- }
- }
- // Extract top-level directories (first path component)
- const topLevelDirs = new Set<string>();
- for (const { path } of paths) {
- const parts = path.split('/').filter(Boolean);
- if (parts.length > 1) {
- const dir = parts[0];
- if (dir) topLevelDirs.add(dir);
- }
- }
- // Filter out directories that already have context (exact or parent)
- const missing: string[] = [];
- for (const dir of topLevelDirs) {
- let hasContext = false;
- // Check if this dir or any parent has context
- for (const prefix of contextPrefixes) {
- if (prefix === '' || prefix === dir || dir.startsWith(prefix + '/')) {
- hasContext = true;
- break;
- }
- }
- if (!hasContext) {
- missing.push(dir);
- }
- }
- return missing.sort();
- }
- // =============================================================================
- // FTS Search
- // =============================================================================
- export function sanitizeFTS5Term(term: string): string {
- return term.replace(/[^\p{L}\p{N}'_]/gu, '').toLowerCase();
- }
- /**
- * Check if a token is a hyphenated compound word (e.g., multi-agent, DEC-0054, gpt-4).
- * Returns true if the token contains internal hyphens between word/digit characters.
- */
- function isHyphenatedToken(token: string): boolean {
- return /^[\p{L}\p{N}][\p{L}\p{N}'-]*-[\p{L}\p{N}][\p{L}\p{N}'-]*$/u.test(token);
- }
- /**
- * Sanitize a hyphenated term into an FTS5 phrase by splitting on hyphens
- * and sanitizing each part. Returns the parts joined by spaces for use
- * inside FTS5 quotes: "multi agent" matches "multi-agent" in porter tokenizer.
- */
- function sanitizeHyphenatedTerm(term: string): string {
- return term.split('-').map(t => sanitizeFTS5Term(t)).filter(t => t).join(' ');
- }
- /**
- * Parse lex query syntax into FTS5 query.
- *
- * Supports:
- * - Quoted phrases: "exact phrase" → "exact phrase" (exact match)
- * - Negation: -term or -"phrase" → uses FTS5 NOT operator
- * - Hyphenated tokens: multi-agent, DEC-0054, gpt-4 → treated as phrases
- * - Plain terms: term → "term"* (prefix match)
- *
- * FTS5 NOT is a binary operator: `term1 NOT term2` means "match term1 but not term2".
- * So `-term` only works when there are also positive terms.
- *
- * Hyphen disambiguation: `-sports` at a word boundary is negation, but `multi-agent`
- * (where `-` is between word characters) is treated as a hyphenated phrase.
- * When a leading `-` is followed by what looks like a hyphenated compound word
- * (e.g., `-multi-agent`), the entire token is treated as a negated phrase.
- *
- * Examples:
- * performance -sports → "performance"* NOT "sports"*
- * "machine learning" → "machine learning"
- * multi-agent memory → "multi agent" AND "memory"*
- * DEC-0054 → "dec 0054"
- * -multi-agent → NOT "multi agent"
- */
- function buildFTS5Query(query: string): string | null {
- const positive: string[] = [];
- const negative: string[] = [];
- let i = 0;
- const s = query.trim();
- while (i < s.length) {
- // Skip whitespace
- while (i < s.length && /\s/.test(s[i]!)) i++;
- if (i >= s.length) break;
- // Check for negation prefix
- const negated = s[i] === '-';
- if (negated) i++;
- // Check for quoted phrase
- if (s[i] === '"') {
- const start = i + 1;
- i++;
- while (i < s.length && s[i] !== '"') i++;
- const phrase = s.slice(start, i).trim();
- i++; // skip closing quote
- if (phrase.length > 0) {
- const sanitized = phrase.split(/\s+/).map(t => sanitizeFTS5Term(t)).filter(t => t).join(' ');
- if (sanitized) {
- const ftsPhrase = `"${sanitized}"`; // Exact phrase, no prefix match
- if (negated) {
- negative.push(ftsPhrase);
- } else {
- positive.push(ftsPhrase);
- }
- }
- }
- } else {
- // Plain term (until whitespace or quote)
- const start = i;
- while (i < s.length && !/[\s"]/.test(s[i]!)) i++;
- const term = s.slice(start, i);
- // Handle hyphenated tokens: multi-agent, DEC-0054, gpt-4
- // These get split into phrase queries so FTS5 porter tokenizer matches them.
- if (isHyphenatedToken(term)) {
- const sanitized = sanitizeHyphenatedTerm(term);
- if (sanitized) {
- const ftsPhrase = `"${sanitized}"`; // Phrase match (no prefix)
- if (negated) {
- negative.push(ftsPhrase);
- } else {
- positive.push(ftsPhrase);
- }
- }
- } else {
- const sanitized = sanitizeFTS5Term(term);
- if (sanitized) {
- const ftsTerm = `"${sanitized}"*`; // Prefix match
- if (negated) {
- negative.push(ftsTerm);
- } else {
- positive.push(ftsTerm);
- }
- }
- }
- }
- }
- if (positive.length === 0 && negative.length === 0) return null;
- // If only negative terms, we can't search (FTS5 NOT is binary)
- if (positive.length === 0) return null;
- // Join positive terms with AND
- let result = positive.join(' AND ');
- // Add NOT clause for negative terms
- for (const neg of negative) {
- result = `${result} NOT ${neg}`;
- }
- return result;
- }
- /**
- * Validate that a vec/hyde query doesn't use lex-only syntax.
- * Returns error message if invalid, null if valid.
- */
- export function validateSemanticQuery(query: string): string | null {
- // Check for negation syntax
- if (/-\w/.test(query) || /-"/.test(query)) {
- return 'Negation (-term) is not supported in vec/hyde queries. Use lex for exclusions.';
- }
- return null;
- }
- export function validateLexQuery(query: string): string | null {
- if (/[\r\n]/.test(query)) {
- return 'Lex queries must be a single line. Remove newline characters or split into separate lex: lines.';
- }
- const quoteCount = (query.match(/"/g) ?? []).length;
- if (quoteCount % 2 === 1) {
- return 'Lex query has an unmatched double quote ("). Add the closing quote or remove it.';
- }
- return null;
- }
- export function searchFTS(db: Database, query: string, limit: number = 20, collectionName?: string): SearchResult[] {
- const ftsQuery = buildFTS5Query(query);
- if (!ftsQuery) return [];
- // Use a CTE to force FTS5 to run first, then filter by collection.
- // Without the CTE, SQLite's query planner combines FTS5 MATCH with the
- // collection filter in a single WHERE clause, which can cause it to
- // abandon the FTS5 index and fall back to a full scan — turning an 8ms
- // query into a 17-second query on large collections.
- const params: (string | number)[] = [ftsQuery];
- // When filtering by collection, fetch extra candidates from the FTS index
- // since some will be filtered out. Without a collection filter we can
- // fetch exactly the requested limit.
- const ftsLimit = collectionName ? limit * 10 : limit;
- let sql = `
- WITH fts_matches AS (
- SELECT rowid, bm25(documents_fts, 1.5, 4.0, 1.0) as bm25_score
- FROM documents_fts
- WHERE documents_fts MATCH ?
- ORDER BY bm25_score ASC
- LIMIT ${ftsLimit}
- )
- SELECT
- 'qmd://' || d.collection || '/' || d.path as filepath,
- d.collection || '/' || d.path as display_path,
- d.title,
- content.doc as body,
- d.hash,
- fm.bm25_score
- FROM fts_matches fm
- JOIN documents d ON d.id = fm.rowid
- JOIN content ON content.hash = d.hash
- WHERE d.active = 1
- `;
- if (collectionName) {
- sql += ` AND d.collection = ?`;
- params.push(String(collectionName));
- }
- // bm25 lower is better; sort ascending.
- sql += ` ORDER BY fm.bm25_score ASC LIMIT ?`;
- params.push(limit);
- const rows = db.prepare(sql).all(...params) as { filepath: string; display_path: string; title: string; body: string; hash: string; bm25_score: number }[];
- return rows.map(row => {
- const collectionName = row.filepath.split('//')[1]?.split('/')[0] || "";
- // Convert bm25 (negative, lower is better) into a stable [0..1) score where higher is better.
- // FTS5 BM25 scores are negative (e.g., -10 is strong, -2 is weak).
- // |x| / (1 + |x|) maps: strong(-10)→0.91, medium(-2)→0.67, weak(-0.5)→0.33, none(0)→0.
- // Monotonic and query-independent — no per-query normalization needed.
- const score = Math.abs(row.bm25_score) / (1 + Math.abs(row.bm25_score));
- return {
- filepath: row.filepath,
- displayPath: row.display_path,
- title: row.title,
- hash: row.hash,
- docid: getDocid(row.hash),
- collectionName,
- modifiedAt: "", // Not available in FTS query
- bodyLength: row.body.length,
- body: row.body,
- context: getContextForFile(db, row.filepath),
- score,
- source: "fts" as const,
- };
- });
- }
- // =============================================================================
- // Vector Search
- // =============================================================================
- export async function searchVec(db: Database, query: string, model: string, limit: number = 20, collectionName?: string, session?: ILLMSession, precomputedEmbedding?: number[]): Promise<SearchResult[]> {
- const tableExists = db.prepare(`SELECT name FROM sqlite_master WHERE type='table' AND name='vectors_vec'`).get();
- if (!tableExists) return [];
- const embedding = precomputedEmbedding ?? await getEmbedding(query, model, true, session);
- if (!embedding) return [];
- // IMPORTANT: We use a two-step query approach here because sqlite-vec virtual tables
- // hang indefinitely when combined with JOINs in the same query. Do NOT try to
- // "optimize" this by combining into a single query with JOINs - it will break.
- // See: https://github.com/tobi/qmd/pull/23
- // Step 1: Get vector matches from sqlite-vec (no JOINs allowed)
- const vecResults = db.prepare(`
- SELECT hash_seq, distance
- FROM vectors_vec
- WHERE embedding MATCH ? AND k = ?
- `).all(new Float32Array(embedding), limit * 3) as { hash_seq: string; distance: number }[];
- if (vecResults.length === 0) return [];
- // Step 2: Get chunk info and document data
- const hashSeqs = vecResults.map(r => r.hash_seq);
- const distanceMap = new Map(vecResults.map(r => [r.hash_seq, r.distance]));
- // Build query for document lookup
- const placeholders = hashSeqs.map(() => '?').join(',');
- let docSql = `
- SELECT
- cv.hash || '_' || cv.seq as hash_seq,
- cv.hash,
- cv.pos,
- 'qmd://' || d.collection || '/' || d.path as filepath,
- d.collection || '/' || d.path as display_path,
- d.title,
- content.doc as body
- FROM content_vectors cv
- JOIN documents d ON d.hash = cv.hash AND d.active = 1
- JOIN content ON content.hash = d.hash
- WHERE cv.hash || '_' || cv.seq IN (${placeholders})
- `;
- const params: string[] = [...hashSeqs];
- if (collectionName) {
- docSql += ` AND d.collection = ?`;
- params.push(collectionName);
- }
- const docRows = db.prepare(docSql).all(...params) as {
- hash_seq: string; hash: string; pos: number; filepath: string;
- display_path: string; title: string; body: string;
- }[];
- // Combine with distances and dedupe by filepath
- const seen = new Map<string, { row: typeof docRows[0]; bestDist: number }>();
- for (const row of docRows) {
- const distance = distanceMap.get(row.hash_seq) ?? 1;
- const existing = seen.get(row.filepath);
- if (!existing || distance < existing.bestDist) {
- seen.set(row.filepath, { row, bestDist: distance });
- }
- }
- return Array.from(seen.values())
- .sort((a, b) => a.bestDist - b.bestDist)
- .slice(0, limit)
- .map(({ row, bestDist }) => {
- const collectionName = row.filepath.split('//')[1]?.split('/')[0] || "";
- return {
- filepath: row.filepath,
- displayPath: row.display_path,
- title: row.title,
- hash: row.hash,
- docid: getDocid(row.hash),
- collectionName,
- modifiedAt: "", // Not available in vec query
- bodyLength: row.body.length,
- body: row.body,
- context: getContextForFile(db, row.filepath),
- score: 1 - bestDist, // Cosine similarity = 1 - cosine distance
- source: "vec" as const,
- chunkPos: row.pos,
- };
- });
- }
- // =============================================================================
- // Embeddings
- // =============================================================================
- async function getEmbedding(text: string, model: string, isQuery: boolean, session?: ILLMSession, llmOverride?: LlamaCpp): Promise<number[] | null> {
- // Format text using the appropriate prompt template
- const formattedText = isQuery ? formatQueryForEmbedding(text, model) : formatDocForEmbedding(text, undefined, model);
- const result = session
- ? await session.embed(formattedText, { model, isQuery })
- : await (llmOverride ?? getDefaultLlamaCpp()).embed(formattedText, { model, isQuery });
- return result?.embedding || null;
- }
- /**
- * Get all unique content hashes that need embeddings (from active documents).
- * Returns hash, document body, and a sample path for display purposes.
- */
- export function getHashesForEmbedding(db: Database): { hash: string; body: string; path: string }[] {
- return db.prepare(`
- SELECT d.hash, c.doc as body, MIN(d.path) as path
- FROM documents d
- JOIN content c ON d.hash = c.hash
- LEFT JOIN content_vectors v ON d.hash = v.hash AND v.seq = 0
- WHERE d.active = 1 AND v.hash IS NULL
- GROUP BY d.hash
- `).all() as { hash: string; body: string; path: string }[];
- }
- /**
- * Clear all embeddings from the database (force re-index).
- * Deletes all rows from content_vectors and drops the vectors_vec table.
- */
- export function clearAllEmbeddings(db: Database): void {
- db.exec(`DELETE FROM content_vectors`);
- db.exec(`DROP TABLE IF EXISTS vectors_vec`);
- }
- /**
- * Insert a single embedding into both content_vectors and vectors_vec tables.
- * The hash_seq key is formatted as "hash_seq" for the vectors_vec table.
- *
- * content_vectors is inserted first so that getHashesForEmbedding (which checks
- * only content_vectors) won't re-select the hash on a crash between the two inserts.
- *
- * vectors_vec uses DELETE + INSERT instead of INSERT OR REPLACE because sqlite-vec's
- * vec0 virtual tables silently ignore the OR REPLACE conflict clause.
- */
- export function insertEmbedding(
- db: Database,
- hash: string,
- seq: number,
- pos: number,
- embedding: Float32Array,
- model: string,
- embeddedAt: string
- ): void {
- const hashSeq = `${hash}_${seq}`;
- // Insert content_vectors first — crash-safe ordering (see getHashesForEmbedding)
- const insertContentVectorStmt = db.prepare(`INSERT OR REPLACE INTO content_vectors (hash, seq, pos, model, embedded_at) VALUES (?, ?, ?, ?, ?)`);
- insertContentVectorStmt.run(hash, seq, pos, model, embeddedAt);
- // vec0 virtual tables don't support OR REPLACE — use DELETE + INSERT
- const deleteVecStmt = db.prepare(`DELETE FROM vectors_vec WHERE hash_seq = ?`);
- const insertVecStmt = db.prepare(`INSERT INTO vectors_vec (hash_seq, embedding) VALUES (?, ?)`);
- deleteVecStmt.run(hashSeq);
- insertVecStmt.run(hashSeq, embedding);
- }
- // =============================================================================
- // Query expansion
- // =============================================================================
- export async function expandQuery(query: string, model: string = DEFAULT_QUERY_MODEL, db: Database, intent?: string, llmOverride?: LlamaCpp): Promise<ExpandedQuery[]> {
- // Check cache first — stored as JSON preserving types
- const cacheKey = getCacheKey("expandQuery", { query, model, ...(intent && { intent }) });
- const cached = getCachedResult(db, cacheKey);
- if (cached) {
- try {
- const parsed = JSON.parse(cached) as any[];
- // Migrate old cache format: { type, text } → { type, query }
- if (parsed.length > 0 && parsed[0].query) {
- return parsed as ExpandedQuery[];
- } else if (parsed.length > 0 && parsed[0].text) {
- return parsed.map((r: any) => ({ type: r.type, query: r.text }));
- }
- } catch {
- // Old cache format (pre-typed, newline-separated text) — re-expand
- }
- }
- const llm = llmOverride ?? getDefaultLlamaCpp();
- // Note: LlamaCpp uses hardcoded model, model parameter is ignored
- const results = await llm.expandQuery(query, { intent });
- // Map Queryable[] → ExpandedQuery[] (same shape, decoupled from llm.ts internals).
- // Filter out entries that duplicate the original query text.
- const expanded: ExpandedQuery[] = results
- .filter(r => r.text !== query)
- .map(r => ({ type: r.type, query: r.text }));
- if (expanded.length > 0) {
- setCachedResult(db, cacheKey, JSON.stringify(expanded));
- }
- return expanded;
- }
- // =============================================================================
- // Reranking
- // =============================================================================
- export async function rerank(query: string, documents: { file: string; text: string }[], model: string = DEFAULT_RERANK_MODEL, db: Database, intent?: string, llmOverride?: LlamaCpp): Promise<{ file: string; score: number }[]> {
- // Prepend intent to rerank query so the reranker scores with domain context
- const rerankQuery = intent ? `${intent}\n\n${query}` : query;
- const cachedResults: Map<string, number> = new Map();
- const uncachedDocsByChunk: Map<string, RerankDocument> = new Map();
- // Check cache for each document
- // Cache key includes chunk text — different queries can select different chunks
- // from the same file, and the reranker score depends on which chunk was sent.
- // File path is excluded from the new cache key because the reranker score
- // depends on the chunk content, not where it came from.
- for (const doc of documents) {
- const cacheKey = getCacheKey("rerank", { query: rerankQuery, model, chunk: doc.text });
- const legacyCacheKey = getCacheKey("rerank", { query, file: doc.file, model, chunk: doc.text });
- const cached = getCachedResult(db, cacheKey) ?? getCachedResult(db, legacyCacheKey);
- if (cached !== null) {
- cachedResults.set(doc.text, parseFloat(cached));
- } else {
- uncachedDocsByChunk.set(doc.text, { file: doc.file, text: doc.text });
- }
- }
- // Rerank uncached documents using LlamaCpp
- if (uncachedDocsByChunk.size > 0) {
- const llm = llmOverride ?? getDefaultLlamaCpp();
- const uncachedDocs = [...uncachedDocsByChunk.values()];
- const rerankResult = await llm.rerank(rerankQuery, uncachedDocs, { model });
- // Cache results by chunk text so identical chunks across files are scored once.
- const textByFile = new Map(uncachedDocs.map(d => [d.file, d.text]));
- for (const result of rerankResult.results) {
- const chunk = textByFile.get(result.file) || "";
- const cacheKey = getCacheKey("rerank", { query: rerankQuery, model, chunk });
- setCachedResult(db, cacheKey, result.score.toString());
- cachedResults.set(chunk, result.score);
- }
- }
- // Return all results sorted by score
- return documents
- .map(doc => ({ file: doc.file, score: cachedResults.get(doc.text) || 0 }))
- .sort((a, b) => b.score - a.score);
- }
- // =============================================================================
- // Reciprocal Rank Fusion
- // =============================================================================
- export function reciprocalRankFusion(
- resultLists: RankedResult[][],
- weights: number[] = [],
- k: number = 60
- ): RankedResult[] {
- const scores = new Map<string, { result: RankedResult; rrfScore: number; topRank: number }>();
- for (let listIdx = 0; listIdx < resultLists.length; listIdx++) {
- const list = resultLists[listIdx];
- if (!list) continue;
- const weight = weights[listIdx] ?? 1.0;
- for (let rank = 0; rank < list.length; rank++) {
- const result = list[rank];
- if (!result) continue;
- const rrfContribution = weight / (k + rank + 1);
- const existing = scores.get(result.file);
- if (existing) {
- existing.rrfScore += rrfContribution;
- existing.topRank = Math.min(existing.topRank, rank);
- } else {
- scores.set(result.file, {
- result,
- rrfScore: rrfContribution,
- topRank: rank,
- });
- }
- }
- }
- // Top-rank bonus
- for (const entry of scores.values()) {
- if (entry.topRank === 0) {
- entry.rrfScore += 0.05;
- } else if (entry.topRank <= 2) {
- entry.rrfScore += 0.02;
- }
- }
- return Array.from(scores.values())
- .sort((a, b) => b.rrfScore - a.rrfScore)
- .map(e => ({ ...e.result, score: e.rrfScore }));
- }
- /**
- * Build per-document RRF contribution traces for explain/debug output.
- */
- export function buildRrfTrace(
- resultLists: RankedResult[][],
- weights: number[] = [],
- listMeta: RankedListMeta[] = [],
- k: number = 60
- ): Map<string, RRFScoreTrace> {
- const traces = new Map<string, RRFScoreTrace>();
- for (let listIdx = 0; listIdx < resultLists.length; listIdx++) {
- const list = resultLists[listIdx];
- if (!list) continue;
- const weight = weights[listIdx] ?? 1.0;
- const meta = listMeta[listIdx] ?? {
- source: "fts",
- queryType: "original",
- query: "",
- } as const;
- for (let rank0 = 0; rank0 < list.length; rank0++) {
- const result = list[rank0];
- if (!result) continue;
- const rank = rank0 + 1; // 1-indexed rank for explain output
- const contribution = weight / (k + rank);
- const existing = traces.get(result.file);
- const detail: RRFContributionTrace = {
- listIndex: listIdx,
- source: meta.source,
- queryType: meta.queryType,
- query: meta.query,
- rank,
- weight,
- backendScore: result.score,
- rrfContribution: contribution,
- };
- if (existing) {
- existing.baseScore += contribution;
- existing.topRank = Math.min(existing.topRank, rank);
- existing.contributions.push(detail);
- } else {
- traces.set(result.file, {
- contributions: [detail],
- baseScore: contribution,
- topRank: rank,
- topRankBonus: 0,
- totalScore: 0,
- });
- }
- }
- }
- for (const trace of traces.values()) {
- let bonus = 0;
- if (trace.topRank === 1) bonus = 0.05;
- else if (trace.topRank <= 3) bonus = 0.02;
- trace.topRankBonus = bonus;
- trace.totalScore = trace.baseScore + bonus;
- }
- return traces;
- }
- // =============================================================================
- // Document retrieval
- // =============================================================================
- type DbDocRow = {
- virtual_path: string;
- display_path: string;
- title: string;
- hash: string;
- collection: string;
- path: string;
- modified_at: string;
- body_length: number;
- body?: string;
- };
- /**
- * Find a document by filename/path, docid (#hash), or with fuzzy matching.
- * Returns document metadata without body by default.
- *
- * Supports:
- * - Virtual paths: qmd://collection/path/to/file.md
- * - Absolute paths: /path/to/file.md
- * - Relative paths: path/to/file.md
- * - Short docid: #abc123 (first 6 chars of hash)
- */
- export function findDocument(db: Database, filename: string, options: { includeBody?: boolean } = {}): DocumentResult | DocumentNotFound {
- let filepath = filename;
- const colonMatch = filepath.match(/:(\d+)$/);
- if (colonMatch) {
- filepath = filepath.slice(0, -colonMatch[0].length);
- }
- // Check if this is a docid lookup (#abc123, abc123, "#abc123", "abc123", etc.)
- if (isDocid(filepath)) {
- const docidMatch = findDocumentByDocid(db, filepath);
- if (docidMatch) {
- filepath = docidMatch.filepath;
- } else {
- return { error: "not_found", query: filename, similarFiles: [] };
- }
- }
- if (filepath.startsWith('~/')) {
- filepath = homedir() + filepath.slice(1);
- }
- const bodyCol = options.includeBody ? `, content.doc as body` : ``;
- // Build computed columns
- // Note: absoluteFilepath is computed from YAML collections after query
- const selectCols = `
- 'qmd://' || d.collection || '/' || d.path as virtual_path,
- d.collection || '/' || d.path as display_path,
- d.title,
- d.hash,
- d.collection,
- d.modified_at,
- LENGTH(content.doc) as body_length
- ${bodyCol}
- `;
- // Try to match by virtual path first
- let doc = db.prepare(`
- SELECT ${selectCols}
- FROM documents d
- JOIN content ON content.hash = d.hash
- WHERE 'qmd://' || d.collection || '/' || d.path = ? AND d.active = 1
- `).get(filepath) as DbDocRow | null;
- // Try fuzzy match by virtual path
- if (!doc) {
- doc = db.prepare(`
- SELECT ${selectCols}
- FROM documents d
- JOIN content ON content.hash = d.hash
- WHERE 'qmd://' || d.collection || '/' || d.path LIKE ? AND d.active = 1
- LIMIT 1
- `).get(`%${filepath}`) as DbDocRow | null;
- }
- // Try to match by absolute path (requires looking up collection paths from DB)
- if (!doc && !filepath.startsWith('qmd://')) {
- const collections = getStoreCollections(db);
- for (const coll of collections) {
- let relativePath: string | null = null;
- // If filepath is absolute and starts with collection path, extract relative part
- if (filepath.startsWith(coll.path + '/')) {
- relativePath = filepath.slice(coll.path.length + 1);
- }
- // Otherwise treat filepath as relative to collection
- else if (!filepath.startsWith('/')) {
- relativePath = filepath;
- }
- if (relativePath) {
- doc = db.prepare(`
- SELECT ${selectCols}
- FROM documents d
- JOIN content ON content.hash = d.hash
- WHERE d.collection = ? AND d.path = ? AND d.active = 1
- `).get(coll.name, relativePath) as DbDocRow | null;
- if (doc) break;
- }
- }
- }
- if (!doc) {
- const similar = findSimilarFiles(db, filepath, 5, 5);
- return { error: "not_found", query: filename, similarFiles: similar };
- }
- // Get context using virtual path
- const virtualPath = doc.virtual_path || `qmd://${doc.collection}/${doc.display_path}`;
- const context = getContextForFile(db, virtualPath);
- return {
- filepath: virtualPath,
- displayPath: doc.display_path,
- title: doc.title,
- context,
- hash: doc.hash,
- docid: getDocid(doc.hash),
- collectionName: doc.collection,
- modifiedAt: doc.modified_at,
- bodyLength: doc.body_length,
- ...(options.includeBody && doc.body !== undefined && { body: doc.body }),
- };
- }
- /**
- * Get the body content for a document
- * Optionally slice by line range
- */
- export function getDocumentBody(db: Database, doc: DocumentResult | { filepath: string }, fromLine?: number, maxLines?: number): string | null {
- const filepath = doc.filepath;
- // Try to resolve document by filepath (absolute or virtual)
- let row: { body: string } | null = null;
- // Try virtual path first
- if (filepath.startsWith('qmd://')) {
- row = db.prepare(`
- SELECT content.doc as body
- FROM documents d
- JOIN content ON content.hash = d.hash
- WHERE 'qmd://' || d.collection || '/' || d.path = ? AND d.active = 1
- `).get(filepath) as { body: string } | null;
- }
- // Try absolute path by looking up in DB store_collections
- if (!row) {
- const collections = getStoreCollections(db);
- for (const coll of collections) {
- if (filepath.startsWith(coll.path + '/')) {
- const relativePath = filepath.slice(coll.path.length + 1);
- row = db.prepare(`
- SELECT content.doc as body
- FROM documents d
- JOIN content ON content.hash = d.hash
- WHERE d.collection = ? AND d.path = ? AND d.active = 1
- `).get(coll.name, relativePath) as { body: string } | null;
- if (row) break;
- }
- }
- }
- if (!row) return null;
- let body = row.body;
- if (fromLine !== undefined || maxLines !== undefined) {
- const lines = body.split('\n');
- const start = (fromLine || 1) - 1;
- const end = maxLines !== undefined ? start + maxLines : lines.length;
- body = lines.slice(start, end).join('\n');
- }
- return body;
- }
- /**
- * Find multiple documents by glob pattern or comma-separated list
- * Returns documents without body by default (use getDocumentBody to load)
- */
- export function findDocuments(
- db: Database,
- pattern: string,
- options: { includeBody?: boolean; maxBytes?: number } = {}
- ): { docs: MultiGetResult[]; errors: string[] } {
- const isCommaSeparated = pattern.includes(',') && !pattern.includes('*') && !pattern.includes('?') && !pattern.includes('{');
- const errors: string[] = [];
- const maxBytes = options.maxBytes ?? DEFAULT_MULTI_GET_MAX_BYTES;
- const bodyCol = options.includeBody ? `, content.doc as body` : ``;
- const selectCols = `
- 'qmd://' || d.collection || '/' || d.path as virtual_path,
- d.collection || '/' || d.path as display_path,
- d.title,
- d.hash,
- d.collection,
- d.modified_at,
- LENGTH(content.doc) as body_length
- ${bodyCol}
- `;
- let fileRows: DbDocRow[];
- if (isCommaSeparated) {
- const names = pattern.split(',').map(s => s.trim()).filter(Boolean);
- fileRows = [];
- for (const name of names) {
- let doc = db.prepare(`
- SELECT ${selectCols}
- FROM documents d
- JOIN content ON content.hash = d.hash
- WHERE 'qmd://' || d.collection || '/' || d.path = ? AND d.active = 1
- `).get(name) as DbDocRow | null;
- if (!doc) {
- doc = db.prepare(`
- SELECT ${selectCols}
- FROM documents d
- JOIN content ON content.hash = d.hash
- WHERE 'qmd://' || d.collection || '/' || d.path LIKE ? AND d.active = 1
- LIMIT 1
- `).get(`%${name}`) as DbDocRow | null;
- }
- if (doc) {
- fileRows.push(doc);
- } else {
- const similar = findSimilarFiles(db, name, 5, 3);
- let msg = `File not found: ${name}`;
- if (similar.length > 0) {
- msg += ` (did you mean: ${similar.join(', ')}?)`;
- }
- errors.push(msg);
- }
- }
- } else {
- // Glob pattern match
- const matched = matchFilesByGlob(db, pattern);
- if (matched.length === 0) {
- errors.push(`No files matched pattern: ${pattern}`);
- return { docs: [], errors };
- }
- const virtualPaths = matched.map(m => m.filepath);
- const placeholders = virtualPaths.map(() => '?').join(',');
- fileRows = db.prepare(`
- SELECT ${selectCols}
- FROM documents d
- JOIN content ON content.hash = d.hash
- WHERE 'qmd://' || d.collection || '/' || d.path IN (${placeholders}) AND d.active = 1
- `).all(...virtualPaths) as DbDocRow[];
- }
- const results: MultiGetResult[] = [];
- for (const row of fileRows) {
- // Get context using virtual path
- const virtualPath = row.virtual_path || `qmd://${row.collection}/${row.display_path}`;
- const context = getContextForFile(db, virtualPath);
- if (row.body_length > maxBytes) {
- results.push({
- doc: { filepath: virtualPath, displayPath: row.display_path },
- skipped: true,
- skipReason: `File too large (${Math.round(row.body_length / 1024)}KB > ${Math.round(maxBytes / 1024)}KB)`,
- });
- continue;
- }
- results.push({
- doc: {
- filepath: virtualPath,
- displayPath: row.display_path,
- title: row.title || row.display_path.split('/').pop() || row.display_path,
- context,
- hash: row.hash,
- docid: getDocid(row.hash),
- collectionName: row.collection,
- modifiedAt: row.modified_at,
- bodyLength: row.body_length,
- ...(options.includeBody && row.body !== undefined && { body: row.body }),
- },
- skipped: false,
- });
- }
- return { docs: results, errors };
- }
- // =============================================================================
- // Status
- // =============================================================================
- export function getStatus(db: Database): IndexStatus {
- // DB is source of truth for collections — config provides supplementary metadata
- const dbCollections = db.prepare(`
- SELECT
- collection as name,
- COUNT(*) as active_count,
- MAX(modified_at) as last_doc_update
- FROM documents
- WHERE active = 1
- GROUP BY collection
- `).all() as { name: string; active_count: number; last_doc_update: string | null }[];
- // Build a lookup from store_collections for path/pattern metadata
- const storeCollections = getStoreCollections(db);
- const configLookup = new Map(storeCollections.map(c => [c.name, { path: c.path, pattern: c.pattern }]));
- const collections: CollectionInfo[] = dbCollections.map(row => {
- const config = configLookup.get(row.name);
- return {
- name: row.name,
- path: config?.path ?? null,
- pattern: config?.pattern ?? null,
- documents: row.active_count,
- lastUpdated: row.last_doc_update || new Date().toISOString(),
- };
- });
- // Sort by last update time (most recent first)
- collections.sort((a, b) => {
- if (!a.lastUpdated) return 1;
- if (!b.lastUpdated) return -1;
- return new Date(b.lastUpdated).getTime() - new Date(a.lastUpdated).getTime();
- });
- const totalDocs = (db.prepare(`SELECT COUNT(*) as c FROM documents WHERE active = 1`).get() as { c: number }).c;
- const needsEmbedding = getHashesNeedingEmbedding(db);
- const hasVectors = !!db.prepare(`SELECT name FROM sqlite_master WHERE type='table' AND name='vectors_vec'`).get();
- return {
- totalDocuments: totalDocs,
- needsEmbedding,
- hasVectorIndex: hasVectors,
- collections,
- };
- }
- // =============================================================================
- // Snippet extraction
- // =============================================================================
- export type SnippetResult = {
- line: number; // 1-indexed line number of best match
- snippet: string; // The snippet text with diff-style header
- linesBefore: number; // Lines in document before snippet
- linesAfter: number; // Lines in document after snippet
- snippetLines: number; // Number of lines in snippet
- };
- /** Weight for intent terms relative to query terms (1.0) in snippet scoring */
- export const INTENT_WEIGHT_SNIPPET = 0.3;
- /** Weight for intent terms relative to query terms (1.0) in chunk selection */
- export const INTENT_WEIGHT_CHUNK = 0.5;
- // Common stop words filtered from intent strings before tokenization.
- // Seeded from finetune/reward.py KEY_TERM_STOPWORDS, extended with common
- // 2-3 char function words so the length threshold can drop to >1 and let
- // short domain terms (API, SQL, LLM, CPU, CDN, …) survive.
- const INTENT_STOP_WORDS = new Set([
- // 2-char function words
- "am", "an", "as", "at", "be", "by", "do", "he", "if",
- "in", "is", "it", "me", "my", "no", "of", "on", "or", "so",
- "to", "up", "us", "we",
- // 3-char function words
- "all", "and", "any", "are", "but", "can", "did", "for", "get",
- "has", "her", "him", "his", "how", "its", "let", "may", "not",
- "our", "out", "the", "too", "was", "who", "why", "you",
- // 4+ char common words
- "also", "does", "find", "from", "have", "into", "more", "need",
- "show", "some", "tell", "that", "them", "this", "want", "what",
- "when", "will", "with", "your",
- // Search-context noise
- "about", "looking", "notes", "search", "where", "which",
- ]);
- /**
- * Extract meaningful terms from an intent string, filtering stop words and punctuation.
- * Uses Unicode-aware punctuation stripping so domain terms like "API" survive.
- * Returns lowercase terms suitable for text matching.
- */
- export function extractIntentTerms(intent: string): string[] {
- return intent.toLowerCase().split(/\s+/)
- .map(t => t.replace(/^[^\p{L}\p{N}]+|[^\p{L}\p{N}]+$/gu, ""))
- .filter(t => t.length > 1 && !INTENT_STOP_WORDS.has(t));
- }
- export function extractSnippet(body: string, query: string, maxLen = 500, chunkPos?: number, chunkLen?: number, intent?: string): SnippetResult {
- const totalLines = body.split('\n').length;
- let searchBody = body;
- let lineOffset = 0;
- if (chunkPos && chunkPos > 0) {
- // Search within the chunk region, with some padding for context
- // Use provided chunkLen or fall back to max chunk size (covers variable-length chunks)
- const searchLen = chunkLen || CHUNK_SIZE_CHARS;
- const contextStart = Math.max(0, chunkPos - 100);
- const contextEnd = Math.min(body.length, chunkPos + searchLen + 100);
- searchBody = body.slice(contextStart, contextEnd);
- if (contextStart > 0) {
- lineOffset = body.slice(0, contextStart).split('\n').length - 1;
- }
- }
- const lines = searchBody.split('\n');
- const queryTerms = query.toLowerCase().split(/\s+/).filter(t => t.length > 0);
- const intentTerms = intent ? extractIntentTerms(intent) : [];
- let bestLine = 0, bestScore = -1;
- for (let i = 0; i < lines.length; i++) {
- const lineLower = (lines[i] ?? "").toLowerCase();
- let score = 0;
- for (const term of queryTerms) {
- if (lineLower.includes(term)) score += 1.0;
- }
- for (const term of intentTerms) {
- if (lineLower.includes(term)) score += INTENT_WEIGHT_SNIPPET;
- }
- if (score > bestScore) {
- bestScore = score;
- bestLine = i;
- }
- }
- const start = Math.max(0, bestLine - 1);
- const end = Math.min(lines.length, bestLine + 3);
- const snippetLines = lines.slice(start, end);
- let snippetText = snippetLines.join('\n');
- // If we focused on a chunk window and it produced an empty/whitespace-only snippet,
- // fall back to a full-document snippet so we always show something useful.
- if (chunkPos && chunkPos > 0 && snippetText.trim().length === 0) {
- return extractSnippet(body, query, maxLen, undefined, undefined, intent);
- }
- if (snippetText.length > maxLen) snippetText = snippetText.substring(0, maxLen - 3) + "...";
- const absoluteStart = lineOffset + start + 1; // 1-indexed
- const snippetLineCount = snippetLines.length;
- const linesBefore = absoluteStart - 1;
- const linesAfter = totalLines - (absoluteStart + snippetLineCount - 1);
- // Format with diff-style header: @@ -start,count @@ (linesBefore before, linesAfter after)
- const header = `@@ -${absoluteStart},${snippetLineCount} @@ (${linesBefore} before, ${linesAfter} after)`;
- const snippet = `${header}\n${snippetText}`;
- return {
- line: lineOffset + bestLine + 1,
- snippet,
- linesBefore,
- linesAfter,
- snippetLines: snippetLineCount,
- };
- }
- // =============================================================================
- // Shared helpers (used by both CLI and MCP)
- // =============================================================================
- /**
- * Add line numbers to text content.
- * Each line becomes: "{lineNum}: {content}"
- */
- export function addLineNumbers(text: string, startLine: number = 1): string {
- const lines = text.split('\n');
- return lines.map((line, i) => `${startLine + i}: ${line}`).join('\n');
- }
- // =============================================================================
- // Shared search orchestration
- //
- // hybridQuery() and vectorSearchQuery() are standalone functions (not Store
- // methods) because they are orchestration over primitives — same rationale as
- // reciprocalRankFusion(). They take a Store as first argument so both CLI
- // and MCP can share the identical pipeline.
- // =============================================================================
- /**
- * Optional progress hooks for search orchestration.
- * CLI wires these to stderr for user feedback; MCP leaves them unset.
- */
- export interface SearchHooks {
- /** BM25 probe found strong signal — expansion will be skipped */
- onStrongSignal?: (topScore: number) => void;
- /** Query expansion starting */
- onExpandStart?: () => void;
- /** Query expansion complete. Empty array = strong signal skip. elapsedMs = time taken. */
- onExpand?: (original: string, expanded: ExpandedQuery[], elapsedMs: number) => void;
- /** Embedding starting (vec/hyde queries) */
- onEmbedStart?: (count: number) => void;
- /** Embedding complete */
- onEmbedDone?: (elapsedMs: number) => void;
- /** Reranking is about to start */
- onRerankStart?: (chunkCount: number) => void;
- /** Reranking finished */
- onRerankDone?: (elapsedMs: number) => void;
- }
- export interface HybridQueryOptions {
- collection?: string;
- limit?: number; // default 10
- minScore?: number; // default 0
- candidateLimit?: number; // default RERANK_CANDIDATE_LIMIT
- explain?: boolean; // include backend/RRF/rerank score traces
- intent?: string; // domain intent hint for disambiguation
- skipRerank?: boolean; // skip LLM reranking, use only RRF scores
- chunkStrategy?: ChunkStrategy;
- hooks?: SearchHooks;
- }
- export interface HybridQueryResult {
- file: string; // internal filepath (qmd://collection/path)
- displayPath: string;
- title: string;
- body: string; // full document body (for snippet extraction)
- bestChunk: string; // best chunk text
- bestChunkPos: number; // char offset of best chunk in body
- score: number; // blended score (full precision)
- context: string | null; // user-set context
- docid: string; // content hash prefix (6 chars)
- explain?: HybridQueryExplain;
- }
- export type RankedListMeta = {
- source: "fts" | "vec";
- queryType: "original" | "lex" | "vec" | "hyde";
- query: string;
- };
- /**
- * Hybrid search: BM25 + vector + query expansion + RRF + chunked reranking.
- *
- * Pipeline:
- * 1. BM25 probe → skip expansion if strong signal
- * 2. expandQuery() → typed query variants (lex/vec/hyde)
- * 3. Type-routed search: original→vector, lex→FTS, vec/hyde→vector
- * 4. RRF fusion → slice to candidateLimit
- * 5. chunkDocument() + keyword-best-chunk selection
- * 6. rerank on chunks (NOT full bodies — O(tokens) trap)
- * 7. Position-aware score blending (RRF rank × reranker score)
- * 8. Dedup by file, filter by minScore, slice to limit
- */
- export async function hybridQuery(
- store: Store,
- query: string,
- options?: HybridQueryOptions
- ): Promise<HybridQueryResult[]> {
- const limit = options?.limit ?? 10;
- const minScore = options?.minScore ?? 0;
- const candidateLimit = options?.candidateLimit ?? RERANK_CANDIDATE_LIMIT;
- const collection = options?.collection;
- const explain = options?.explain ?? false;
- const intent = options?.intent;
- const skipRerank = options?.skipRerank ?? false;
- const hooks = options?.hooks;
- const rankedLists: RankedResult[][] = [];
- const rankedListMeta: RankedListMeta[] = [];
- const docidMap = new Map<string, string>(); // filepath -> docid
- const hasVectors = !!store.db.prepare(
- `SELECT name FROM sqlite_master WHERE type='table' AND name='vectors_vec'`
- ).get();
- // Step 1: BM25 probe — strong signal skips expensive LLM expansion
- // When intent is provided, disable strong-signal bypass — the obvious BM25
- // match may not be what the caller wants (e.g. "performance" with intent
- // "web page load times" should NOT shortcut to a sports-performance doc).
- // Pass collection directly into FTS query (filter at SQL level, not post-hoc)
- const initialFts = store.searchFTS(query, 20, collection);
- const topScore = initialFts[0]?.score ?? 0;
- const secondScore = initialFts[1]?.score ?? 0;
- const hasStrongSignal = !intent && initialFts.length > 0
- && topScore >= STRONG_SIGNAL_MIN_SCORE
- && (topScore - secondScore) >= STRONG_SIGNAL_MIN_GAP;
- if (hasStrongSignal) hooks?.onStrongSignal?.(topScore);
- // Step 2: Expand query (or skip if strong signal)
- hooks?.onExpandStart?.();
- const expandStart = Date.now();
- const expanded = hasStrongSignal
- ? []
- : await store.expandQuery(query, undefined, intent);
- hooks?.onExpand?.(query, expanded, Date.now() - expandStart);
- // Seed with initial FTS results (avoid re-running original query FTS)
- if (initialFts.length > 0) {
- for (const r of initialFts) docidMap.set(r.filepath, r.docid);
- rankedLists.push(initialFts.map(r => ({
- file: r.filepath, displayPath: r.displayPath,
- title: r.title, body: r.body || "", score: r.score,
- })));
- rankedListMeta.push({ source: "fts", queryType: "original", query });
- }
- // Step 3: Route searches by query type
- //
- // Strategy: run all FTS queries immediately (they're sync/instant), then
- // batch-embed all vector queries in one embedBatch() call, then run
- // sqlite-vec lookups with pre-computed embeddings.
- // 3a: Run FTS for all lex expansions right away (no LLM needed)
- for (const q of expanded) {
- if (q.type === 'lex') {
- const ftsResults = store.searchFTS(q.query, 20, collection);
- if (ftsResults.length > 0) {
- for (const r of ftsResults) docidMap.set(r.filepath, r.docid);
- rankedLists.push(ftsResults.map(r => ({
- file: r.filepath, displayPath: r.displayPath,
- title: r.title, body: r.body || "", score: r.score,
- })));
- rankedListMeta.push({ source: "fts", queryType: "lex", query: q.query });
- }
- }
- }
- // 3b: Collect all texts that need vector search (original query + vec/hyde expansions)
- if (hasVectors) {
- const vecQueries: { text: string; queryType: "original" | "vec" | "hyde" }[] = [
- { text: query, queryType: "original" },
- ];
- for (const q of expanded) {
- if (q.type === 'vec' || q.type === 'hyde') {
- vecQueries.push({ text: q.query, queryType: q.type });
- }
- }
- // Batch embed all vector queries in a single call
- const llm = getLlm(store);
- const textsToEmbed = vecQueries.map(q => formatQueryForEmbedding(q.text, llm.embedModelName));
- hooks?.onEmbedStart?.(textsToEmbed.length);
- const embedStart = Date.now();
- const embeddings = await llm.embedBatch(textsToEmbed);
- hooks?.onEmbedDone?.(Date.now() - embedStart);
- // Run sqlite-vec lookups with pre-computed embeddings
- for (let i = 0; i < vecQueries.length; i++) {
- const embedding = embeddings[i]?.embedding;
- if (!embedding) continue;
- const vecResults = await store.searchVec(
- vecQueries[i]!.text, DEFAULT_EMBED_MODEL, 20, collection,
- undefined, embedding
- );
- if (vecResults.length > 0) {
- for (const r of vecResults) docidMap.set(r.filepath, r.docid);
- rankedLists.push(vecResults.map(r => ({
- file: r.filepath, displayPath: r.displayPath,
- title: r.title, body: r.body || "", score: r.score,
- })));
- rankedListMeta.push({
- source: "vec",
- queryType: vecQueries[i]!.queryType,
- query: vecQueries[i]!.text,
- });
- }
- }
- }
- // Step 4: RRF fusion — first 2 lists (original FTS + first vec) get 2x weight
- const weights = rankedLists.map((_, i) => i < 2 ? 2.0 : 1.0);
- const fused = reciprocalRankFusion(rankedLists, weights);
- const rrfTraceByFile = explain ? buildRrfTrace(rankedLists, weights, rankedListMeta) : null;
- const candidates = fused.slice(0, candidateLimit);
- if (candidates.length === 0) return [];
- // Step 5: Chunk documents, pick best chunk per doc for reranking.
- // Reranking full bodies is O(tokens) — the critical perf lesson that motivated this refactor.
- const queryTerms = query.toLowerCase().split(/\s+/).filter(t => t.length > 2);
- const intentTerms = intent ? extractIntentTerms(intent) : [];
- const docChunkMap = new Map<string, { chunks: { text: string; pos: number }[]; bestIdx: number }>();
- const chunkStrategy = options?.chunkStrategy;
- for (const cand of candidates) {
- const chunks = await chunkDocumentAsync(cand.body, undefined, undefined, undefined, cand.file, chunkStrategy);
- if (chunks.length === 0) continue;
- // Pick chunk with most keyword overlap (fallback: first chunk)
- // Intent terms contribute at INTENT_WEIGHT_CHUNK (0.5) relative to query terms (1.0)
- let bestIdx = 0;
- let bestScore = -1;
- for (let i = 0; i < chunks.length; i++) {
- const chunkLower = chunks[i]!.text.toLowerCase();
- let score = queryTerms.reduce((acc, term) => acc + (chunkLower.includes(term) ? 1 : 0), 0);
- for (const term of intentTerms) {
- if (chunkLower.includes(term)) score += INTENT_WEIGHT_CHUNK;
- }
- if (score > bestScore) { bestScore = score; bestIdx = i; }
- }
- docChunkMap.set(cand.file, { chunks, bestIdx });
- }
- if (skipRerank) {
- // Skip LLM reranking — return candidates scored by RRF only
- const seenFiles = new Set<string>();
- return candidates
- .map((cand, i) => {
- const chunkInfo = docChunkMap.get(cand.file);
- const bestIdx = chunkInfo?.bestIdx ?? 0;
- const bestChunk = chunkInfo?.chunks[bestIdx]?.text || cand.body || "";
- const bestChunkPos = chunkInfo?.chunks[bestIdx]?.pos || 0;
- const rrfRank = i + 1;
- const rrfScore = 1 / rrfRank;
- const trace = rrfTraceByFile?.get(cand.file);
- const explainData: HybridQueryExplain | undefined = explain ? {
- ftsScores: trace?.contributions.filter(c => c.source === "fts").map(c => c.backendScore) ?? [],
- vectorScores: trace?.contributions.filter(c => c.source === "vec").map(c => c.backendScore) ?? [],
- rrf: {
- rank: rrfRank,
- positionScore: rrfScore,
- weight: 1.0,
- baseScore: trace?.baseScore ?? 0,
- topRankBonus: trace?.topRankBonus ?? 0,
- totalScore: trace?.totalScore ?? 0,
- contributions: trace?.contributions ?? [],
- },
- rerankScore: 0,
- blendedScore: rrfScore,
- } : undefined;
- return {
- file: cand.file,
- displayPath: cand.displayPath,
- title: cand.title,
- body: cand.body,
- bestChunk,
- bestChunkPos,
- score: rrfScore,
- context: store.getContextForFile(cand.file),
- docid: docidMap.get(cand.file) || "",
- ...(explainData ? { explain: explainData } : {}),
- };
- })
- .filter(r => {
- if (seenFiles.has(r.file)) return false;
- seenFiles.add(r.file);
- return true;
- })
- .filter(r => r.score >= minScore)
- .slice(0, limit);
- }
- // Step 6: Rerank chunks (NOT full bodies)
- const chunksToRerank: { file: string; text: string }[] = [];
- for (const cand of candidates) {
- const chunkInfo = docChunkMap.get(cand.file);
- if (chunkInfo) {
- chunksToRerank.push({ file: cand.file, text: chunkInfo.chunks[chunkInfo.bestIdx]!.text });
- }
- }
- hooks?.onRerankStart?.(chunksToRerank.length);
- const rerankStart = Date.now();
- const reranked = await store.rerank(query, chunksToRerank, undefined, intent);
- hooks?.onRerankDone?.(Date.now() - rerankStart);
- // Step 7: Blend RRF position score with reranker score
- // Position-aware weights: top retrieval results get more protection from reranker disagreement
- const candidateMap = new Map(candidates.map(c => [c.file, {
- displayPath: c.displayPath, title: c.title, body: c.body,
- }]));
- const rrfRankMap = new Map(candidates.map((c, i) => [c.file, i + 1]));
- const blended = reranked.map(r => {
- const rrfRank = rrfRankMap.get(r.file) || candidateLimit;
- let rrfWeight: number;
- if (rrfRank <= 3) rrfWeight = 0.75;
- else if (rrfRank <= 10) rrfWeight = 0.60;
- else rrfWeight = 0.40;
- const rrfScore = 1 / rrfRank;
- const blendedScore = rrfWeight * rrfScore + (1 - rrfWeight) * r.score;
- const candidate = candidateMap.get(r.file);
- const chunkInfo = docChunkMap.get(r.file);
- const bestIdx = chunkInfo?.bestIdx ?? 0;
- const bestChunk = chunkInfo?.chunks[bestIdx]?.text || candidate?.body || "";
- const bestChunkPos = chunkInfo?.chunks[bestIdx]?.pos || 0;
- const trace = rrfTraceByFile?.get(r.file);
- const explainData: HybridQueryExplain | undefined = explain ? {
- ftsScores: trace?.contributions.filter(c => c.source === "fts").map(c => c.backendScore) ?? [],
- vectorScores: trace?.contributions.filter(c => c.source === "vec").map(c => c.backendScore) ?? [],
- rrf: {
- rank: rrfRank,
- positionScore: rrfScore,
- weight: rrfWeight,
- baseScore: trace?.baseScore ?? 0,
- topRankBonus: trace?.topRankBonus ?? 0,
- totalScore: trace?.totalScore ?? 0,
- contributions: trace?.contributions ?? [],
- },
- rerankScore: r.score,
- blendedScore,
- } : undefined;
- return {
- file: r.file,
- displayPath: candidate?.displayPath || "",
- title: candidate?.title || "",
- body: candidate?.body || "",
- bestChunk,
- bestChunkPos,
- score: blendedScore,
- context: store.getContextForFile(r.file),
- docid: docidMap.get(r.file) || "",
- ...(explainData ? { explain: explainData } : {}),
- };
- }).sort((a, b) => b.score - a.score);
- // Step 8: Dedup by file (safety net — prevents duplicate output)
- const seenFiles = new Set<string>();
- return blended
- .filter(r => {
- if (seenFiles.has(r.file)) return false;
- seenFiles.add(r.file);
- return true;
- })
- .filter(r => r.score >= minScore)
- .slice(0, limit);
- }
- export interface VectorSearchOptions {
- collection?: string;
- limit?: number; // default 10
- minScore?: number; // default 0.3
- intent?: string; // domain intent hint for disambiguation
- hooks?: Pick<SearchHooks, 'onExpand'>;
- }
- export interface VectorSearchResult {
- file: string;
- displayPath: string;
- title: string;
- body: string;
- score: number;
- context: string | null;
- docid: string;
- }
- /**
- * Vector-only semantic search with query expansion.
- *
- * Pipeline:
- * 1. expandQuery() → typed variants, filter to vec/hyde only (lex irrelevant here)
- * 2. searchVec() for original + vec/hyde variants (sequential — node-llama-cpp embed limitation)
- * 3. Dedup by filepath (keep max score)
- * 4. Sort by score descending, filter by minScore, slice to limit
- */
- export async function vectorSearchQuery(
- store: Store,
- query: string,
- options?: VectorSearchOptions
- ): Promise<VectorSearchResult[]> {
- const limit = options?.limit ?? 10;
- const minScore = options?.minScore ?? 0.3;
- const collection = options?.collection;
- const intent = options?.intent;
- const hasVectors = !!store.db.prepare(
- `SELECT name FROM sqlite_master WHERE type='table' AND name='vectors_vec'`
- ).get();
- if (!hasVectors) return [];
- // Expand query — filter to vec/hyde only (lex queries target FTS, not vector)
- const expandStart = Date.now();
- const allExpanded = await store.expandQuery(query, undefined, intent);
- const vecExpanded = allExpanded.filter(q => q.type !== 'lex');
- options?.hooks?.onExpand?.(query, vecExpanded, Date.now() - expandStart);
- // Run original + vec/hyde expanded through vector, sequentially — concurrent embed() hangs
- const queryTexts = [query, ...vecExpanded.map(q => q.query)];
- const allResults = new Map<string, VectorSearchResult>();
- for (const q of queryTexts) {
- const vecResults = await store.searchVec(q, DEFAULT_EMBED_MODEL, limit, collection);
- for (const r of vecResults) {
- const existing = allResults.get(r.filepath);
- if (!existing || r.score > existing.score) {
- allResults.set(r.filepath, {
- file: r.filepath,
- displayPath: r.displayPath,
- title: r.title,
- body: r.body || "",
- score: r.score,
- context: store.getContextForFile(r.filepath),
- docid: r.docid,
- });
- }
- }
- }
- return Array.from(allResults.values())
- .sort((a, b) => b.score - a.score)
- .filter(r => r.score >= minScore)
- .slice(0, limit);
- }
- // =============================================================================
- // Structured search — pre-expanded queries from LLM
- // =============================================================================
- /**
- * A single sub-search in a structured search request.
- * Matches the format used in QMD training data.
- */
- export interface StructuredSearchOptions {
- collections?: string[]; // Filter to specific collections (OR match)
- limit?: number; // default 10
- minScore?: number; // default 0
- candidateLimit?: number; // default RERANK_CANDIDATE_LIMIT
- explain?: boolean; // include backend/RRF/rerank score traces
- /** Domain intent hint for disambiguation — steers reranking and chunk selection */
- intent?: string;
- /** Skip LLM reranking, use only RRF scores */
- skipRerank?: boolean;
- chunkStrategy?: ChunkStrategy;
- hooks?: SearchHooks;
- }
- /**
- * Structured search: execute pre-expanded queries without LLM query expansion.
- *
- * Designed for LLM callers (MCP/HTTP) that generate their own query expansions.
- * Skips the internal expandQuery() step — goes directly to:
- *
- * Pipeline:
- * 1. Route searches: lex→FTS, vec/hyde→vector (batch embed)
- * 2. RRF fusion across all result lists
- * 3. Chunk documents + keyword-best-chunk selection
- * 4. Rerank on chunks
- * 5. Position-aware score blending
- * 6. Dedup, filter, slice
- *
- * This is the recommended endpoint for capable LLMs — they can generate
- * better query variations than our small local model, especially for
- * domain-specific or nuanced queries.
- */
- export async function structuredSearch(
- store: Store,
- searches: ExpandedQuery[],
- options?: StructuredSearchOptions
- ): Promise<HybridQueryResult[]> {
- const limit = options?.limit ?? 10;
- const minScore = options?.minScore ?? 0;
- const candidateLimit = options?.candidateLimit ?? RERANK_CANDIDATE_LIMIT;
- const explain = options?.explain ?? false;
- const intent = options?.intent;
- const skipRerank = options?.skipRerank ?? false;
- const hooks = options?.hooks;
- const collections = options?.collections;
- if (searches.length === 0) return [];
- // Validate queries before executing
- for (const search of searches) {
- const location = search.line ? `Line ${search.line}` : 'Structured search';
- if (/[\r\n]/.test(search.query)) {
- throw new Error(`${location} (${search.type}): queries must be single-line. Remove newline characters.`);
- }
- if (search.type === 'lex') {
- const error = validateLexQuery(search.query);
- if (error) {
- throw new Error(`${location} (lex): ${error}`);
- }
- } else if (search.type === 'vec' || search.type === 'hyde') {
- const error = validateSemanticQuery(search.query);
- if (error) {
- throw new Error(`${location} (${search.type}): ${error}`);
- }
- }
- }
- const rankedLists: RankedResult[][] = [];
- const rankedListMeta: RankedListMeta[] = [];
- const docidMap = new Map<string, string>(); // filepath -> docid
- const hasVectors = !!store.db.prepare(
- `SELECT name FROM sqlite_master WHERE type='table' AND name='vectors_vec'`
- ).get();
- // Helper to run search across collections (or all if undefined)
- const collectionList = collections ?? [undefined]; // undefined = all collections
- // Step 1: Run FTS for all lex searches (sync, instant)
- for (const search of searches) {
- if (search.type === 'lex') {
- for (const coll of collectionList) {
- const ftsResults = store.searchFTS(search.query, 20, coll);
- if (ftsResults.length > 0) {
- for (const r of ftsResults) docidMap.set(r.filepath, r.docid);
- rankedLists.push(ftsResults.map(r => ({
- file: r.filepath, displayPath: r.displayPath,
- title: r.title, body: r.body || "", score: r.score,
- })));
- rankedListMeta.push({
- source: "fts",
- queryType: "lex",
- query: search.query,
- });
- }
- }
- }
- }
- // Step 2: Batch embed and run vector searches for vec/hyde
- if (hasVectors) {
- const vecSearches = searches.filter(
- (s): s is ExpandedQuery & { type: 'vec' | 'hyde' } =>
- s.type === 'vec' || s.type === 'hyde'
- );
- if (vecSearches.length > 0) {
- const llm = getLlm(store);
- const textsToEmbed = vecSearches.map(s => formatQueryForEmbedding(s.query, llm.embedModelName));
- hooks?.onEmbedStart?.(textsToEmbed.length);
- const embedStart = Date.now();
- const embeddings = await llm.embedBatch(textsToEmbed);
- hooks?.onEmbedDone?.(Date.now() - embedStart);
- for (let i = 0; i < vecSearches.length; i++) {
- const embedding = embeddings[i]?.embedding;
- if (!embedding) continue;
- for (const coll of collectionList) {
- const vecResults = await store.searchVec(
- vecSearches[i]!.query, DEFAULT_EMBED_MODEL, 20, coll,
- undefined, embedding
- );
- if (vecResults.length > 0) {
- for (const r of vecResults) docidMap.set(r.filepath, r.docid);
- rankedLists.push(vecResults.map(r => ({
- file: r.filepath, displayPath: r.displayPath,
- title: r.title, body: r.body || "", score: r.score,
- })));
- rankedListMeta.push({
- source: "vec",
- queryType: vecSearches[i]!.type,
- query: vecSearches[i]!.query,
- });
- }
- }
- }
- }
- }
- if (rankedLists.length === 0) return [];
- // Step 3: RRF fusion — first list gets 2x weight (assume caller ordered by importance)
- const weights = rankedLists.map((_, i) => i === 0 ? 2.0 : 1.0);
- const fused = reciprocalRankFusion(rankedLists, weights);
- const rrfTraceByFile = explain ? buildRrfTrace(rankedLists, weights, rankedListMeta) : null;
- const candidates = fused.slice(0, candidateLimit);
- if (candidates.length === 0) return [];
- hooks?.onExpand?.("", [], 0); // Signal no expansion (pre-expanded)
- // Step 4: Chunk documents, pick best chunk per doc for reranking
- // Use first lex query as the "query" for keyword matching, or first vec if no lex
- const primaryQuery = searches.find(s => s.type === 'lex')?.query
- || searches.find(s => s.type === 'vec')?.query
- || searches[0]?.query || "";
- const queryTerms = primaryQuery.toLowerCase().split(/\s+/).filter(t => t.length > 2);
- const intentTerms = intent ? extractIntentTerms(intent) : [];
- const docChunkMap = new Map<string, { chunks: { text: string; pos: number }[]; bestIdx: number }>();
- const ssChunkStrategy = options?.chunkStrategy;
- for (const cand of candidates) {
- const chunks = await chunkDocumentAsync(cand.body, undefined, undefined, undefined, cand.file, ssChunkStrategy);
- if (chunks.length === 0) continue;
- // Pick chunk with most keyword overlap
- // Intent terms contribute at INTENT_WEIGHT_CHUNK (0.5) relative to query terms (1.0)
- let bestIdx = 0;
- let bestScore = -1;
- for (let i = 0; i < chunks.length; i++) {
- const chunkLower = chunks[i]!.text.toLowerCase();
- let score = queryTerms.reduce((acc, term) => acc + (chunkLower.includes(term) ? 1 : 0), 0);
- for (const term of intentTerms) {
- if (chunkLower.includes(term)) score += INTENT_WEIGHT_CHUNK;
- }
- if (score > bestScore) { bestScore = score; bestIdx = i; }
- }
- docChunkMap.set(cand.file, { chunks, bestIdx });
- }
- if (skipRerank) {
- // Skip LLM reranking — return candidates scored by RRF only
- const seenFiles = new Set<string>();
- return candidates
- .map((cand, i) => {
- const chunkInfo = docChunkMap.get(cand.file);
- const bestIdx = chunkInfo?.bestIdx ?? 0;
- const bestChunk = chunkInfo?.chunks[bestIdx]?.text || cand.body || "";
- const bestChunkPos = chunkInfo?.chunks[bestIdx]?.pos || 0;
- const rrfRank = i + 1;
- const rrfScore = 1 / rrfRank;
- const trace = rrfTraceByFile?.get(cand.file);
- const explainData: HybridQueryExplain | undefined = explain ? {
- ftsScores: trace?.contributions.filter(c => c.source === "fts").map(c => c.backendScore) ?? [],
- vectorScores: trace?.contributions.filter(c => c.source === "vec").map(c => c.backendScore) ?? [],
- rrf: {
- rank: rrfRank,
- positionScore: rrfScore,
- weight: 1.0,
- baseScore: trace?.baseScore ?? 0,
- topRankBonus: trace?.topRankBonus ?? 0,
- totalScore: trace?.totalScore ?? 0,
- contributions: trace?.contributions ?? [],
- },
- rerankScore: 0,
- blendedScore: rrfScore,
- } : undefined;
- return {
- file: cand.file,
- displayPath: cand.displayPath,
- title: cand.title,
- body: cand.body,
- bestChunk,
- bestChunkPos,
- score: rrfScore,
- context: store.getContextForFile(cand.file),
- docid: docidMap.get(cand.file) || "",
- ...(explainData ? { explain: explainData } : {}),
- };
- })
- .filter(r => {
- if (seenFiles.has(r.file)) return false;
- seenFiles.add(r.file);
- return true;
- })
- .filter(r => r.score >= minScore)
- .slice(0, limit);
- }
- // Step 5: Rerank chunks
- const chunksToRerank: { file: string; text: string }[] = [];
- for (const cand of candidates) {
- const chunkInfo = docChunkMap.get(cand.file);
- if (chunkInfo) {
- chunksToRerank.push({ file: cand.file, text: chunkInfo.chunks[chunkInfo.bestIdx]!.text });
- }
- }
- hooks?.onRerankStart?.(chunksToRerank.length);
- const rerankStart2 = Date.now();
- const reranked = await store.rerank(primaryQuery, chunksToRerank, undefined, intent);
- hooks?.onRerankDone?.(Date.now() - rerankStart2);
- // Step 6: Blend RRF position score with reranker score
- const candidateMap = new Map(candidates.map(c => [c.file, {
- displayPath: c.displayPath, title: c.title, body: c.body,
- }]));
- const rrfRankMap = new Map(candidates.map((c, i) => [c.file, i + 1]));
- const blended = reranked.map(r => {
- const rrfRank = rrfRankMap.get(r.file) || candidateLimit;
- let rrfWeight: number;
- if (rrfRank <= 3) rrfWeight = 0.75;
- else if (rrfRank <= 10) rrfWeight = 0.60;
- else rrfWeight = 0.40;
- const rrfScore = 1 / rrfRank;
- const blendedScore = rrfWeight * rrfScore + (1 - rrfWeight) * r.score;
- const candidate = candidateMap.get(r.file);
- const chunkInfo = docChunkMap.get(r.file);
- const bestIdx = chunkInfo?.bestIdx ?? 0;
- const bestChunk = chunkInfo?.chunks[bestIdx]?.text || candidate?.body || "";
- const bestChunkPos = chunkInfo?.chunks[bestIdx]?.pos || 0;
- const trace = rrfTraceByFile?.get(r.file);
- const explainData: HybridQueryExplain | undefined = explain ? {
- ftsScores: trace?.contributions.filter(c => c.source === "fts").map(c => c.backendScore) ?? [],
- vectorScores: trace?.contributions.filter(c => c.source === "vec").map(c => c.backendScore) ?? [],
- rrf: {
- rank: rrfRank,
- positionScore: rrfScore,
- weight: rrfWeight,
- baseScore: trace?.baseScore ?? 0,
- topRankBonus: trace?.topRankBonus ?? 0,
- totalScore: trace?.totalScore ?? 0,
- contributions: trace?.contributions ?? [],
- },
- rerankScore: r.score,
- blendedScore,
- } : undefined;
- return {
- file: r.file,
- displayPath: candidate?.displayPath || "",
- title: candidate?.title || "",
- body: candidate?.body || "",
- bestChunk,
- bestChunkPos,
- score: blendedScore,
- context: store.getContextForFile(r.file),
- docid: docidMap.get(r.file) || "",
- ...(explainData ? { explain: explainData } : {}),
- };
- }).sort((a, b) => b.score - a.score);
- // Step 7: Dedup by file
- const seenFiles = new Set<string>();
- return blended
- .filter(r => {
- if (seenFiles.has(r.file)) return false;
- seenFiles.add(r.file);
- return true;
- })
- .filter(r => r.score >= minScore)
- .slice(0, limit);
- }
|