Files
WeHub Mirror 6bf8bebf51
CI / Test and Build (push) Failing after 1s
CI / Migrate Dev DB (push) Has been skipped
CI / Migrate DB (push) Has been skipped
CodeQL / Analyze actions (push) Has been cancelled
CodeQL / Analyze javascript-typescript (push) Has been cancelled
CI / Detect Version (push) Has been cancelled
CI / Detect Desktop Changes (push) Has been cancelled
CI / Build AMD64 (blacksmith-2vcpu-ubuntu-2404, ./docker/cron.Dockerfile, ubuntu-latest, ghcr.io/simstudioai/cron) (push) Has been cancelled
CI / Build AMD64 (blacksmith-2vcpu-ubuntu-2404, ./docker/db.Dockerfile, ECR_MIGRATIONS, ubuntu-latest, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (blacksmith-4vcpu-ubuntu-2404, ./docker/pii.Dockerfile, ECR_PII, ubuntu-latest, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (blacksmith-4vcpu-ubuntu-2404, ./docker/realtime.Dockerfile, ECR_REALTIME, ubuntu-latest, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build AMD64 (blacksmith-8vcpu-ubuntu-2404, ./docker/app.Dockerfile, ECR_APP, linux-x64-8-core, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/cron.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/cron) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/db.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/pii.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/realtime.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-8vcpu-ubuntu-2404-arm, ./docker/app.Dockerfile, linux-arm64-8-core, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
Helm Chart / Lint, test, and validate chart (push) Has been cancelled
Helm Chart / Chart version bumped (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
CI / Build Dev ECR (blacksmith-8vcpu-ubuntu-2404, ./docker/app.Dockerfile, ECR_APP, linux-x64-8-core) (push) Has been cancelled
CI / Promote Images (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/cron) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build Dev ECR (blacksmith-2vcpu-ubuntu-2404, ./docker/db.Dockerfile, ECR_MIGRATIONS, ubuntu-latest) (push) Has been cancelled
CI / Build Dev ECR (blacksmith-4vcpu-ubuntu-2404, ./docker/pii.Dockerfile, ECR_PII, ubuntu-latest) (push) Has been cancelled
CI / Build Dev ECR (blacksmith-4vcpu-ubuntu-2404, ./docker/realtime.Dockerfile, ECR_REALTIME, ubuntu-latest) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Check Desktop Signing Secrets (push) Has been cancelled
CI / Desktop Release (push) Has been cancelled
CI / Create Desktop Prerelease (push) Has been cancelled
CI / Desktop Prerelease Build (push) Has been cancelled
CI / Publish Desktop Prerelease (push) Has been cancelled
CI / Prune Desktop Prereleases (push) Has been cancelled
Helm Chart / Install on kind and run helm test (push) Has been cancelled
WeHub snapshot of cb28d14c6f2c081de7a0d8729a8c816c9adef67a
2026-08-10 11:17:50 +08:00

838 lines
27 KiB
TypeScript

import { db } from '@sim/db'
import { document, embedding } from '@sim/db/schema'
import { createLogger } from '@sim/logger'
import { getErrorMessage } from '@sim/utils/errors'
import { and, eq, inArray, isNull, type SQL, sql } from 'drizzle-orm'
import type { StructuredFilter } from '@/lib/knowledge/types'
const logger = createLogger('KnowledgeSearch')
export interface DocumentMetadata {
filename: string
sourceUrl: string | null
}
/**
* Batch-fetch display metadata for documents referenced by search results.
* Excludes documents that are user-excluded, archived, or soft-deleted —
* mirrors the visibility filters applied inside the search SQL itself, so
* the lookup will never surface metadata for a row a caller could not have
* legitimately matched. Returns a map keyed by document id; missing ids
* indicate the document is no longer visible and should be skipped.
*/
export async function getDocumentMetadataByIds(
documentIds: string[]
): Promise<Record<string, DocumentMetadata>> {
if (documentIds.length === 0) {
return {}
}
const uniqueIds = [...new Set(documentIds)]
const documents = await db
.select({
id: document.id,
filename: document.filename,
sourceUrl: document.sourceUrl,
})
.from(document)
.where(
and(
inArray(document.id, uniqueIds),
eq(document.userExcluded, false),
isNull(document.archivedAt),
isNull(document.deletedAt)
)
)
const map: Record<string, DocumentMetadata> = {}
documents.forEach((doc) => {
map[doc.id] = { filename: doc.filename, sourceUrl: doc.sourceUrl ?? null }
})
return map
}
export interface SearchResult {
id: string
content: string
documentId: string
chunkIndex: number
// Text tags
tag1: string | null
tag2: string | null
tag3: string | null
tag4: string | null
tag5: string | null
tag6: string | null
tag7: string | null
// Number tags (5 slots)
number1: number | null
number2: number | null
number3: number | null
number4: number | null
number5: number | null
// Date tags (2 slots)
date1: Date | null
date2: Date | null
// Boolean tags (3 slots)
boolean1: boolean | null
boolean2: boolean | null
boolean3: boolean | null
distance: number
knowledgeBaseId: string
}
export interface SearchParams {
knowledgeBaseIds: string[]
topK: number
structuredFilters?: StructuredFilter[]
queryVector?: string
distanceThreshold?: number
}
// Use shared embedding utility
export { generateSearchEmbedding } from '@/lib/knowledge/embeddings'
/** All valid tag slot keys */
const TAG_SLOT_KEYS = [
// Text tags (7 slots)
'tag1',
'tag2',
'tag3',
'tag4',
'tag5',
'tag6',
'tag7',
// Number tags (5 slots)
'number1',
'number2',
'number3',
'number4',
'number5',
// Date tags (2 slots)
'date1',
'date2',
// Boolean tags (3 slots)
'boolean1',
'boolean2',
'boolean3',
] as const
type TagSlotKey = (typeof TAG_SLOT_KEYS)[number]
function isTagSlotKey(key: string): key is TagSlotKey {
return TAG_SLOT_KEYS.includes(key as TagSlotKey)
}
/** Common fields selected for search results */
const getSearchResultFields = (distanceExpr: any) => ({
id: embedding.id,
content: embedding.content,
documentId: embedding.documentId,
chunkIndex: embedding.chunkIndex,
// Text tags
tag1: embedding.tag1,
tag2: embedding.tag2,
tag3: embedding.tag3,
tag4: embedding.tag4,
tag5: embedding.tag5,
tag6: embedding.tag6,
tag7: embedding.tag7,
// Number tags (5 slots)
number1: embedding.number1,
number2: embedding.number2,
number3: embedding.number3,
number4: embedding.number4,
number5: embedding.number5,
// Date tags (2 slots)
date1: embedding.date1,
date2: embedding.date2,
// Boolean tags (3 slots)
boolean1: embedding.boolean1,
boolean2: embedding.boolean2,
boolean3: embedding.boolean3,
distance: distanceExpr,
knowledgeBaseId: embedding.knowledgeBaseId,
})
/**
* Build a single SQL condition for a filter
*/
function buildFilterCondition(filter: StructuredFilter, embeddingTable: any) {
const { tagSlot, fieldType, operator, value, valueTo } = filter
if (!isTagSlotKey(tagSlot)) {
return null
}
const column = embeddingTable[tagSlot]
if (!column) return null
// Handle text operators
if (fieldType === 'text') {
const stringValue = String(value)
switch (operator) {
case 'eq':
return sql`LOWER(${column}) = LOWER(${stringValue})`
case 'neq':
return sql`LOWER(${column}) != LOWER(${stringValue})`
case 'contains':
return sql`LOWER(${column}) LIKE LOWER(${`%${stringValue}%`})`
case 'not_contains':
return sql`LOWER(${column}) NOT LIKE LOWER(${`%${stringValue}%`})`
case 'starts_with':
return sql`LOWER(${column}) LIKE LOWER(${`${stringValue}%`})`
case 'ends_with':
return sql`LOWER(${column}) LIKE LOWER(${`%${stringValue}`})`
default:
return sql`LOWER(${column}) = LOWER(${stringValue})`
}
}
// Handle number operators
if (fieldType === 'number') {
const numValue = typeof value === 'number' ? value : Number.parseFloat(String(value))
if (Number.isNaN(numValue)) return null
switch (operator) {
case 'eq':
return sql`${column} = ${numValue}`
case 'neq':
return sql`${column} != ${numValue}`
case 'gt':
return sql`${column} > ${numValue}`
case 'gte':
return sql`${column} >= ${numValue}`
case 'lt':
return sql`${column} < ${numValue}`
case 'lte':
return sql`${column} <= ${numValue}`
case 'between':
if (valueTo !== undefined) {
const numValueTo =
typeof valueTo === 'number' ? valueTo : Number.parseFloat(String(valueTo))
if (Number.isNaN(numValueTo)) return sql`${column} = ${numValue}`
return sql`${column} >= ${numValue} AND ${column} <= ${numValueTo}`
}
return sql`${column} = ${numValue}`
default:
return sql`${column} = ${numValue}`
}
}
// Handle date operators - expects YYYY-MM-DD format from frontend
if (fieldType === 'date') {
const dateStr = String(value)
// Validate YYYY-MM-DD format
if (!/^\d{4}-\d{2}-\d{2}$/.test(dateStr)) {
return null
}
switch (operator) {
case 'eq':
return sql`${column}::date = ${dateStr}::date`
case 'neq':
return sql`${column}::date != ${dateStr}::date`
case 'gt':
return sql`${column}::date > ${dateStr}::date`
case 'gte':
return sql`${column}::date >= ${dateStr}::date`
case 'lt':
return sql`${column}::date < ${dateStr}::date`
case 'lte':
return sql`${column}::date <= ${dateStr}::date`
case 'between':
if (valueTo !== undefined) {
const dateStrTo = String(valueTo)
if (!/^\d{4}-\d{2}-\d{2}$/.test(dateStrTo)) {
return sql`${column}::date = ${dateStr}::date`
}
return sql`${column}::date >= ${dateStr}::date AND ${column}::date <= ${dateStrTo}::date`
}
return sql`${column}::date = ${dateStr}::date`
default:
return sql`${column}::date = ${dateStr}::date`
}
}
// Handle boolean operators
if (fieldType === 'boolean') {
const boolValue = value === true || value === 'true'
switch (operator) {
case 'eq':
return sql`${column} = ${boolValue}`
case 'neq':
return sql`${column} != ${boolValue}`
default:
return sql`${column} = ${boolValue}`
}
}
// Fallback to equality
return sql`${column} = ${value}`
}
/**
* Build SQL conditions from structured filters with operator support
* - Same tag multiple times: OR logic
* - Different tags: AND logic
*/
function getStructuredTagFilters(filters: StructuredFilter[], embeddingTable: any) {
// Group filters by tagSlot
const filtersBySlot = new Map<string, StructuredFilter[]>()
for (const filter of filters) {
const slot = filter.tagSlot
if (!filtersBySlot.has(slot)) {
filtersBySlot.set(slot, [])
}
filtersBySlot.get(slot)!.push(filter)
}
// Build conditions: OR within same slot, AND across different slots
const conditions: ReturnType<typeof sql>[] = []
for (const [slot, slotFilters] of filtersBySlot) {
const slotConditions = slotFilters
.map((f) => buildFilterCondition(f, embeddingTable))
.filter((c): c is ReturnType<typeof sql> => c !== null)
if (slotConditions.length === 0) continue
if (slotConditions.length === 1) {
// Single condition for this slot
conditions.push(slotConditions[0])
} else {
// Multiple conditions for same slot - OR them together
conditions.push(sql`(${sql.join(slotConditions, sql` OR `)})`)
}
}
return conditions
}
/**
* Text-search configuration used to build the query. Must match the config the
* generated `embedding.content_tsv` column was built with
* (`to_tsvector('english', content)`) — a mismatch silently stops Postgres from
* using the `emb_content_fts_idx` GIN index and degrades to a sequential scan.
*/
const FTS_CONFIG = 'english'
/**
* Reciprocal-rank-fusion damping constant. 60 is the value from the original RRF
* paper and matches the docs Ask-AI retriever (`apps/docs/app/api/chat/route.ts`).
*/
export const RRF_K = 60
/**
* Row visibility predicates shared by every search leg: a chunk is only
* retrievable when both it and its document are enabled, the document finished
* processing, and it has not been excluded, archived, or soft-deleted.
*/
function getVisibilityConditions() {
return [
eq(embedding.enabled, true),
eq(document.enabled, true),
eq(document.processingStatus, 'completed'),
eq(document.userExcluded, false),
isNull(document.archivedAt),
isNull(document.deletedAt),
]
}
export function getQueryStrategy(kbCount: number, topK: number) {
const useParallel = kbCount > 4 || (kbCount > 2 && topK > 50)
const distanceThreshold = kbCount > 3 ? 0.8 : 1.0
const parallelLimit = Math.ceil(topK / kbCount) + 5
return {
useParallel,
distanceThreshold,
parallelLimit,
singleQueryOptimized: kbCount <= 2,
}
}
async function executeTagFilterQuery(
knowledgeBaseIds: string[],
structuredFilters: StructuredFilter[]
): Promise<{ id: string }[]> {
const tagFilterConditions = getStructuredTagFilters(structuredFilters, embedding)
if (knowledgeBaseIds.length === 1) {
return await db
.select({ id: embedding.id })
.from(embedding)
.innerJoin(document, eq(embedding.documentId, document.id))
.where(
and(
eq(embedding.knowledgeBaseId, knowledgeBaseIds[0]),
eq(embedding.enabled, true),
eq(document.enabled, true),
eq(document.processingStatus, 'completed'),
eq(document.userExcluded, false),
isNull(document.archivedAt),
isNull(document.deletedAt),
...tagFilterConditions
)
)
}
return await db
.select({ id: embedding.id })
.from(embedding)
.innerJoin(document, eq(embedding.documentId, document.id))
.where(
and(
inArray(embedding.knowledgeBaseId, knowledgeBaseIds),
eq(embedding.enabled, true),
eq(document.enabled, true),
eq(document.processingStatus, 'completed'),
eq(document.userExcluded, false),
isNull(document.archivedAt),
isNull(document.deletedAt),
...tagFilterConditions
)
)
}
async function executeVectorSearchOnIds(
embeddingIds: string[],
queryVector: string,
topK: number,
distanceThreshold: number
): Promise<SearchResult[]> {
if (embeddingIds.length === 0) {
return []
}
return await db
.select(
getSearchResultFields(
sql<number>`${embedding.embedding} <=> ${queryVector}::vector`.as('distance')
)
)
.from(embedding)
.innerJoin(document, eq(embedding.documentId, document.id))
.where(
and(
inArray(embedding.id, embeddingIds),
eq(document.enabled, true),
eq(document.processingStatus, 'completed'),
eq(document.userExcluded, false),
isNull(document.archivedAt),
isNull(document.deletedAt),
sql`${embedding.embedding} <=> ${queryVector}::vector < ${distanceThreshold}`
)
)
.orderBy(sql`${embedding.embedding} <=> ${queryVector}::vector`)
.limit(topK)
}
export async function handleTagOnlySearch(params: SearchParams): Promise<SearchResult[]> {
const { knowledgeBaseIds, topK, structuredFilters } = params
if (!structuredFilters || structuredFilters.length === 0) {
throw new Error('Tag filters are required for tag-only search')
}
const strategy = getQueryStrategy(knowledgeBaseIds.length, topK)
const tagFilterConditions = getStructuredTagFilters(structuredFilters, embedding)
if (strategy.useParallel) {
// Parallel approach for many KBs
const parallelLimit = Math.ceil(topK / knowledgeBaseIds.length) + 5
const queryPromises = knowledgeBaseIds.map(async (kbId) => {
return await db
.select(getSearchResultFields(sql<number>`0`.as('distance')))
.from(embedding)
.innerJoin(document, eq(embedding.documentId, document.id))
.where(
and(
eq(embedding.knowledgeBaseId, kbId),
eq(embedding.enabled, true),
eq(document.enabled, true),
eq(document.processingStatus, 'completed'),
eq(document.userExcluded, false),
isNull(document.archivedAt),
isNull(document.deletedAt),
...tagFilterConditions
)
)
.limit(parallelLimit)
})
const parallelResults = await Promise.all(queryPromises)
return parallelResults.flat().slice(0, topK)
}
// Single query for fewer KBs
return await db
.select(getSearchResultFields(sql<number>`0`.as('distance')))
.from(embedding)
.innerJoin(document, eq(embedding.documentId, document.id))
.where(
and(
inArray(embedding.knowledgeBaseId, knowledgeBaseIds),
eq(embedding.enabled, true),
eq(document.enabled, true),
eq(document.processingStatus, 'completed'),
eq(document.userExcluded, false),
isNull(document.archivedAt),
isNull(document.deletedAt),
...tagFilterConditions
)
)
.limit(topK)
}
export async function handleVectorOnlySearch(params: SearchParams): Promise<SearchResult[]> {
const { knowledgeBaseIds, topK, queryVector, distanceThreshold } = params
if (!queryVector || !distanceThreshold) {
throw new Error('Query vector and distance threshold are required for vector-only search')
}
const strategy = getQueryStrategy(knowledgeBaseIds.length, topK)
const distanceExpr = sql<number>`${embedding.embedding} <=> ${queryVector}::vector`.as('distance')
if (strategy.useParallel) {
// Parallel approach for many KBs
const parallelLimit = Math.ceil(topK / knowledgeBaseIds.length) + 5
const queryPromises = knowledgeBaseIds.map(async (kbId) => {
return await db
.select(getSearchResultFields(distanceExpr))
.from(embedding)
.innerJoin(document, eq(embedding.documentId, document.id))
.where(
and(
eq(embedding.knowledgeBaseId, kbId),
eq(embedding.enabled, true),
eq(document.enabled, true),
eq(document.processingStatus, 'completed'),
eq(document.userExcluded, false),
isNull(document.archivedAt),
isNull(document.deletedAt),
sql`${embedding.embedding} <=> ${queryVector}::vector < ${distanceThreshold}`
)
)
.orderBy(sql`${embedding.embedding} <=> ${queryVector}::vector`)
.limit(parallelLimit)
})
const parallelResults = await Promise.all(queryPromises)
const allResults = parallelResults.flat()
return allResults.sort((a, b) => a.distance - b.distance).slice(0, topK)
}
// Single query for fewer KBs
return await db
.select(getSearchResultFields(distanceExpr))
.from(embedding)
.innerJoin(document, eq(embedding.documentId, document.id))
.where(
and(
inArray(embedding.knowledgeBaseId, knowledgeBaseIds),
eq(embedding.enabled, true),
eq(document.enabled, true),
eq(document.processingStatus, 'completed'),
eq(document.userExcluded, false),
isNull(document.archivedAt),
isNull(document.deletedAt),
sql`${embedding.embedding} <=> ${queryVector}::vector < ${distanceThreshold}`
)
)
.orderBy(sql`${embedding.embedding} <=> ${queryVector}::vector`)
.limit(topK)
}
export interface KeywordSearchParams {
knowledgeBaseIds: string[]
topK: number
query: string
/** Query embedding, so keyword-only hits still carry a real cosine distance. */
queryVector: string
structuredFilters?: StructuredFilter[]
}
/**
* Lexical (full-text) retrieval leg. Matches chunks against the generated
* `content_tsv` column via `websearch_to_tsquery`, which tolerates arbitrary
* user input and supports quoted phrases and `-negation`.
*
* Results carry the true cosine distance rather than a placeholder, so callers
* can report `similarity` for rows only the lexical leg found. Unlike the vector
* leg there is no distance threshold — surfacing exact-token matches that are
* semantically distant is the entire point of this leg.
*
* Candidate gathering mirrors the vector leg's `getQueryStrategy`: across many
* knowledge bases a single global `LIMIT` lets whichever base ranks strongest
* lexically consume every slot, so an exact-token hit in a smaller base would
* never reach fusion. Both legs must draw candidates the same way, or rank
* fusion is combining rankings taken over differently-shaped pools.
*
* Ranking and hydration are two steps on purpose. Projecting the cosine
* distance in the ranking query makes Postgres detoast the 1536-dimension
* vector and compute a distance for *every* full-text match before the `LIMIT`
* applies — work that scales with how common the query term is rather than
* with `topK` (measured at ~59x the buffer reads on a 20k-chunk base for a term
* matching every row). Ranking therefore touches no vectors, and only the rows
* that survive the limit are hydrated.
*/
export async function executeKeywordSearch(params: KeywordSearchParams): Promise<SearchResult[]> {
const { knowledgeBaseIds, topK, query, queryVector, structuredFilters } = params
if (!query.trim()) {
return []
}
const tsQuery = sql`websearch_to_tsquery(${FTS_CONFIG}, ${query})`
const rankExpr = sql<number>`ts_rank_cd(${embedding.contentTsv}, ${tsQuery})`
const tagFilterConditions = structuredFilters?.length
? getStructuredTagFilters(structuredFilters, embedding)
: []
const rankConditions = (kbScope: SQL | undefined) =>
and(
kbScope,
...getVisibilityConditions(),
sql`${embedding.contentTsv} @@ ${tsQuery}`,
...tagFilterConditions
)
/** Ranking pass: ids and relevance only, so no vector is read. */
const rankRows = (kbScope: SQL | undefined, limit: number) =>
db
.select({ id: embedding.id, keywordRank: rankExpr.as('keyword_rank') })
.from(embedding)
.innerJoin(document, eq(embedding.documentId, document.id))
.where(rankConditions(kbScope))
.orderBy(sql`${rankExpr} DESC`)
.limit(limit)
const strategy = getQueryStrategy(knowledgeBaseIds.length, topK)
let ranked: { id: string; keywordRank: number }[]
if (strategy.useParallel) {
const parallelLimit = Math.ceil(topK / knowledgeBaseIds.length) + 5
const perBase = await Promise.all(
knowledgeBaseIds.map((kbId) => rankRows(eq(embedding.knowledgeBaseId, kbId), parallelLimit))
)
ranked = perBase.flat().sort((a, b) => b.keywordRank - a.keywordRank)
} else {
ranked = await rankRows(inArray(embedding.knowledgeBaseId, knowledgeBaseIds), topK)
}
const topIds = ranked.slice(0, topK).map((row) => row.id)
if (topIds.length === 0) {
return []
}
/** Hydration pass: full rows plus the cosine distance, bounded to the survivors. */
const hydrated = await db
.select(
getSearchResultFields(
sql<number>`${embedding.embedding} <=> ${queryVector}::vector`.as('distance')
)
)
.from(embedding)
.innerJoin(document, eq(embedding.documentId, document.id))
.where(and(inArray(embedding.id, topIds), ...getVisibilityConditions()))
const rowById = new Map(hydrated.map((row) => [row.id, row]))
return topIds.map((id) => rowById.get(id)).filter((row): row is SearchResult => row !== undefined)
}
/**
* Fuse independently-ranked result lists by reciprocal rank:
* `score(row) = Σ 1 / (RRF_K + rank)` across the lists it appears in.
*
* Rank fusion is used rather than score normalization because cosine distance
* and `ts_rank_cd` are on incomparable scales with no corpus-independent
* mapping between them. Rows are deduped by chunk id, first occurrence wins.
*
* Equal scores are common and must not be broken by list order: rank *n* in one
* leg always ties rank *n* in every other leg, so sorting alone would let the
* first list monopolize the head of the output and starve the others entirely
* at small `topK`. Selection therefore drains each tie group round-robin,
* preferring the candidate whose least-served leg has been served least.
*
* A row is credited to *every* leg that returned it, not to one chosen leg: it
* satisfied all of them, and charging a shared hit to a single leg would leave
* the round-robin owing the other one a slot it has already been served —
* which at small `topK` evicts a row only the shared hit's leg could produce.
* A total tie goes to the earliest list, so callers put the leg whose hits the
* other leg cannot produce first.
*/
export function fuseByReciprocalRank(rankedLists: SearchResult[][], topK: number): SearchResult[] {
const scores = new Map<string, number>()
const rowById = new Map<string, SearchResult>()
const legsOfRow = new Map<string, number[]>()
rankedLists.forEach((list, leg) => {
list.forEach((row, index) => {
scores.set(row.id, (scores.get(row.id) ?? 0) + 1 / (RRF_K + index + 1))
if (!rowById.has(row.id)) {
rowById.set(row.id, row)
}
const legs = legsOfRow.get(row.id)
if (legs) {
if (!legs.includes(leg)) legs.push(leg)
} else {
legsOfRow.set(row.id, [leg])
}
})
})
// Stable sort keeps rowById insertion order (earliest leg first) inside each tie group.
const ordered = [...rowById.values()].sort(
(a, b) => (scores.get(b.id) ?? 0) - (scores.get(a.id) ?? 0)
)
const contributed = rankedLists.map(() => 0)
/** How starved a candidate's most-neglected leg is; lower wins the tie. */
const starvation = (id: string) =>
Math.min(...(legsOfRow.get(id) ?? [0]).map((leg) => contributed[leg]))
const fused: SearchResult[] = []
let groupStart = 0
while (groupStart < ordered.length && fused.length < topK) {
const groupScore = scores.get(ordered[groupStart].id) ?? 0
let groupEnd = groupStart
while (groupEnd < ordered.length && (scores.get(ordered[groupEnd].id) ?? 0) === groupScore) {
groupEnd++
}
const group = ordered.slice(groupStart, groupEnd)
while (group.length > 0 && fused.length < topK) {
let pick = 0
for (let i = 1; i < group.length; i++) {
if (starvation(group[i].id) < starvation(group[pick].id)) {
pick = i
}
}
const [row] = group.splice(pick, 1)
fused.push(row)
for (const leg of legsOfRow.get(row.id) ?? []) {
contributed[leg]++
}
}
groupStart = groupEnd
}
return fused
}
export async function handleTagAndVectorSearch(params: SearchParams): Promise<SearchResult[]> {
const { knowledgeBaseIds, topK, structuredFilters, queryVector, distanceThreshold } = params
if (!structuredFilters || structuredFilters.length === 0) {
throw new Error('Tag filters are required for tag and vector search')
}
if (!queryVector || !distanceThreshold) {
throw new Error('Query vector and distance threshold are required for tag and vector search')
}
// Step 1: Filter by tags first
const tagFilteredIds = await executeTagFilterQuery(knowledgeBaseIds, structuredFilters)
if (tagFilteredIds.length === 0) {
return []
}
// Step 2: Perform vector search only on tag-filtered results
return await executeVectorSearchOnIds(
tagFilteredIds.map((r) => r.id),
queryVector,
topK,
distanceThreshold
)
}
/**
* `hybrid` fuses lexical and vector retrieval; `vector` is the legacy
* semantic-only path, kept as an opt-out.
*/
export type KnowledgeSearchMode = 'hybrid' | 'vector'
export interface ExecuteKnowledgeSearchParams {
knowledgeBaseIds: string[]
/** Candidate count each leg retrieves and the fused list is trimmed to. */
topK: number
searchMode: KnowledgeSearchMode
query?: string
/** Required whenever `query` is present. */
queryVector?: string
structuredFilters?: StructuredFilter[]
}
/**
* Single retrieval entry point shared by the internal and v1 search routes.
* Callers remain responsible for auth, embedding generation, billing, and for
* rejecting requests that carry neither a query nor tag filters.
*/
export async function executeKnowledgeSearch(
params: ExecuteKnowledgeSearchParams
): Promise<SearchResult[]> {
const { knowledgeBaseIds, topK, searchMode, query, queryVector, structuredFilters } = params
const hasQuery = Boolean(query?.trim())
const hasFilters = Boolean(structuredFilters && structuredFilters.length > 0)
if (!hasQuery) {
if (!hasFilters) {
throw new Error('A search query or tag filters are required')
}
return await handleTagOnlySearch({ knowledgeBaseIds, topK, structuredFilters })
}
if (!queryVector) {
throw new Error('Query vector is required when searching with a query')
}
const { distanceThreshold } = getQueryStrategy(knowledgeBaseIds.length, topK)
const vectorSearch = hasFilters
? handleTagAndVectorSearch({
knowledgeBaseIds,
topK,
structuredFilters,
queryVector,
distanceThreshold,
})
: handleVectorOnlySearch({ knowledgeBaseIds, topK, queryVector, distanceThreshold })
if (searchMode === 'vector') {
return await vectorSearch
}
/**
* The lexical leg is best-effort: a failure there falls back to vector-only
* results rather than failing the whole search.
*/
const keywordSearch = executeKeywordSearch({
knowledgeBaseIds,
topK,
query: query!,
queryVector,
structuredFilters,
}).catch((error) => {
logger.warn('Keyword search leg failed; falling back to vector-only results', {
error: getErrorMessage(error, 'Unknown error'),
})
return [] as SearchResult[]
})
const [vectorResults, keywordResults] = await Promise.all([vectorSearch, keywordSearch])
/**
* Lexical leg first: on a total tie it wins, which is the behavior this mode
* exists for — an exact-token chunk the vector leg ranked below its distance
* threshold is precisely what a caller opted into hybrid to recover, and at
* `topK: 1` something has to win.
*/
return fuseByReciprocalRank([keywordResults, vectorResults], topK)
}