fix: correct typo in README major updates section

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
David Snelling 2025-08-06 12:29:32 -07:00
parent d2ddb9199e
commit 1a4f035ffc
22 changed files with 4423 additions and 142 deletions

321
src/utils/metadataFilter.ts Normal file
View file

@ -0,0 +1,321 @@
/**
* Smart metadata filtering for vector search
* Filters DURING search to ensure relevant results
* Simple API that just works without configuration
*/
import { SearchResult, HNSWNoun } from '../coreTypes.js'
/**
* MongoDB-style query operators
*/
export interface QueryOperators {
$eq?: any
$ne?: any
$gt?: any
$gte?: any
$lt?: any
$lte?: any
$in?: any[]
$nin?: any[]
$exists?: boolean
$regex?: string | RegExp
$includes?: any
$all?: any[]
$size?: number
$and?: MetadataFilter[]
$or?: MetadataFilter[]
$not?: MetadataFilter
}
/**
* Metadata filter definition
*/
export interface MetadataFilter {
[key: string]: any | QueryOperators
}
/**
* Options for metadata filtering
*/
export interface MetadataFilterOptions {
metadata?: MetadataFilter
scoring?: {
vectorWeight?: number
metadataWeight?: number
metadataBoosts?: Record<string, number | ((value: any, query: any) => number)>
}
}
/**
* Check if a value matches a query with operators
*/
function matchesQuery(value: any, query: any): boolean {
// Direct equality check
if (typeof query !== 'object' || query === null || Array.isArray(query)) {
return value === query
}
// Check for MongoDB-style operators
for (const [op, operand] of Object.entries(query)) {
switch (op) {
case '$eq':
if (value !== operand) return false
break
case '$ne':
if (value === operand) return false
break
case '$gt':
if (typeof value !== 'number' || typeof operand !== 'number' || !(value > operand)) return false
break
case '$gte':
if (typeof value !== 'number' || typeof operand !== 'number' || !(value >= operand)) return false
break
case '$lt':
if (typeof value !== 'number' || typeof operand !== 'number' || !(value < operand)) return false
break
case '$lte':
if (typeof value !== 'number' || typeof operand !== 'number' || !(value <= operand)) return false
break
case '$in':
if (!Array.isArray(operand) || !operand.includes(value)) return false
break
case '$nin':
if (!Array.isArray(operand) || operand.includes(value)) return false
break
case '$exists':
if ((value !== undefined) !== operand) return false
break
case '$regex':
const regex = typeof operand === 'string' ? new RegExp(operand) : operand as RegExp
if (!(regex instanceof RegExp) || !regex.test(String(value))) return false
break
case '$includes':
if (!Array.isArray(value) || !value.includes(operand)) return false
break
case '$all':
if (!Array.isArray(value) || !Array.isArray(operand)) return false
for (const item of operand) {
if (!value.includes(item)) return false
}
break
case '$size':
if (!Array.isArray(value) || value.length !== operand) return false
break
default:
// Unknown operator, treat as field name
if (!matchesFieldQuery(value, op, operand)) return false
}
}
return true
}
/**
* Check if a field matches a query
*/
function matchesFieldQuery(obj: any, field: string, query: any): boolean {
const value = getNestedValue(obj, field)
return matchesQuery(value, query)
}
/**
* Get nested value from object using dot notation
*/
function getNestedValue(obj: any, path: string): any {
const parts = path.split('.')
let current = obj
for (const part of parts) {
if (current === null || current === undefined) {
return undefined
}
current = current[part]
}
return current
}
/**
* Check if metadata matches the filter
*/
export function matchesMetadataFilter(metadata: any, filter: MetadataFilter): boolean {
if (!filter || Object.keys(filter).length === 0) {
return true
}
for (const [key, query] of Object.entries(filter)) {
// Handle logical operators
if (key === '$and') {
if (!Array.isArray(query)) return false
for (const subFilter of query) {
if (!matchesMetadataFilter(metadata, subFilter)) return false
}
continue
}
if (key === '$or') {
if (!Array.isArray(query)) return false
let matched = false
for (const subFilter of query) {
if (matchesMetadataFilter(metadata, subFilter)) {
matched = true
break
}
}
if (!matched) return false
continue
}
if (key === '$not') {
if (matchesMetadataFilter(metadata, query)) return false
continue
}
// Handle field queries
const value = getNestedValue(metadata, key)
if (!matchesQuery(value, query)) {
return false
}
}
return true
}
/**
* Calculate metadata boost score
*/
export function calculateMetadataScore(
metadata: any,
filter: MetadataFilter,
scoring?: MetadataFilterOptions['scoring']
): number {
if (!scoring || !scoring.metadataBoosts) {
return 0
}
let score = 0
for (const [field, boost] of Object.entries(scoring.metadataBoosts)) {
const value = getNestedValue(metadata, field)
if (typeof boost === 'function') {
score += boost(value, filter)
} else if (value !== undefined) {
// Check if the field matches the filter
const fieldFilter = filter[field]
if (fieldFilter && matchesQuery(value, fieldFilter)) {
score += boost
}
}
}
return score
}
/**
* Apply compound scoring to search results
*/
export function applyCompoundScoring<T>(
results: SearchResult<T>[],
filter: MetadataFilter,
scoring?: MetadataFilterOptions['scoring']
): SearchResult<T>[] {
if (!scoring || (!scoring.vectorWeight && !scoring.metadataWeight)) {
return results
}
const vectorWeight = scoring.vectorWeight ?? 1.0
const metadataWeight = scoring.metadataWeight ?? 0.0
return results.map(result => {
const metadataScore = calculateMetadataScore(result.metadata, filter, scoring)
const combinedScore = (result.score * vectorWeight) + (metadataScore * metadataWeight)
return {
...result,
score: combinedScore
}
}).sort((a, b) => b.score - a.score) // Re-sort by combined score
}
/**
* Filter search results by metadata
*/
export function filterSearchResultsByMetadata<T>(
results: SearchResult<T>[],
filter: MetadataFilter
): SearchResult<T>[] {
if (!filter || Object.keys(filter).length === 0) {
return results
}
return results.filter(result =>
matchesMetadataFilter(result.metadata, filter)
)
}
/**
* Filter nouns by metadata before search
*/
export function filterNounsByMetadata(
nouns: HNSWNoun[],
filter: MetadataFilter
): HNSWNoun[] {
if (!filter || Object.keys(filter).length === 0) {
return nouns
}
return nouns.filter(noun =>
matchesMetadataFilter(noun.metadata, filter)
)
}
/**
* Aggregate search results for faceted search
*/
export interface FacetConfig {
field: string
limit?: number
}
export interface FacetResult {
[value: string]: number
}
export interface AggregationResult<T> {
results: SearchResult<T>[]
facets: Record<string, FacetResult>
}
export function aggregateSearchResults<T>(
results: SearchResult<T>[],
facets: Record<string, FacetConfig>
): AggregationResult<T> {
const facetResults: Record<string, FacetResult> = {}
for (const [facetName, config] of Object.entries(facets)) {
const counts: Record<string, number> = {}
for (const result of results) {
const value = getNestedValue(result.metadata, config.field)
if (value !== undefined) {
const key = String(value)
counts[key] = (counts[key] || 0) + 1
}
}
// Sort by count and apply limit
const sorted = Object.entries(counts)
.sort((a, b) => b[1] - a[1])
.slice(0, config.limit || 10)
facetResults[facetName] = Object.fromEntries(sorted)
}
return {
results,
facets: facetResults
}
}

451
src/utils/metadataIndex.ts Normal file
View file

@ -0,0 +1,451 @@
/**
* Metadata Index System
* Maintains inverted indexes for fast metadata filtering
* Automatically updates indexes when data changes
*/
import { StorageAdapter } from '../coreTypes.js'
export interface MetadataIndexEntry {
field: string
value: string | number | boolean
ids: Set<string>
lastUpdated: number
}
export interface MetadataIndexStats {
totalEntries: number
totalIds: number
fieldsIndexed: string[]
lastRebuild: number
indexSize: number // in bytes
}
export interface MetadataIndexConfig {
maxIndexSize?: number // Max number of entries per field value (default: 10000)
rebuildThreshold?: number // Rebuild if index is this % stale (default: 0.1)
autoOptimize?: boolean // Auto-cleanup unused entries (default: true)
indexedFields?: string[] // Only index these fields (default: all)
excludeFields?: string[] // Never index these fields
}
/**
* Manages metadata indexes for fast filtering
* Maintains inverted indexes: field+value -> list of IDs
*/
export class MetadataIndexManager {
private storage: StorageAdapter
private config: Required<MetadataIndexConfig>
private indexCache = new Map<string, MetadataIndexEntry>()
private dirtyEntries = new Set<string>()
private isRebuilding = false
constructor(storage: StorageAdapter, config: MetadataIndexConfig = {}) {
this.storage = storage
this.config = {
maxIndexSize: config.maxIndexSize ?? 10000,
rebuildThreshold: config.rebuildThreshold ?? 0.1,
autoOptimize: config.autoOptimize ?? true,
indexedFields: config.indexedFields ?? [],
excludeFields: config.excludeFields ?? ['id', 'createdAt', 'updatedAt']
}
}
/**
* Get index key for field and value
*/
private getIndexKey(field: string, value: any): string {
const normalizedValue = this.normalizeValue(value)
return `${field}:${normalizedValue}`
}
/**
* Normalize value for consistent indexing
*/
private normalizeValue(value: any): string {
if (value === null || value === undefined) return '__NULL__'
if (typeof value === 'boolean') return value ? '__TRUE__' : '__FALSE__'
if (typeof value === 'number') return value.toString()
if (Array.isArray(value)) return value.map(v => this.normalizeValue(v)).join(',')
return String(value).toLowerCase().trim()
}
/**
* Check if field should be indexed
*/
private shouldIndexField(field: string): boolean {
if (this.config.excludeFields.includes(field)) return false
if (this.config.indexedFields.length > 0) {
return this.config.indexedFields.includes(field)
}
return true
}
/**
* Extract indexable field-value pairs from metadata
*/
private extractIndexableFields(metadata: any): Array<{ field: string, value: any }> {
const fields: Array<{ field: string, value: any }> = []
const extract = (obj: any, prefix = ''): void => {
for (const [key, value] of Object.entries(obj)) {
const fullKey = prefix ? `${prefix}.${key}` : key
if (!this.shouldIndexField(fullKey)) continue
if (value && typeof value === 'object' && !Array.isArray(value)) {
// Recurse into nested objects
extract(value, fullKey)
} else {
// Index this field
fields.push({ field: fullKey, value })
// If it's an array, also index each element
if (Array.isArray(value)) {
for (const item of value) {
fields.push({ field: fullKey, value: item })
}
}
}
}
}
if (metadata && typeof metadata === 'object') {
extract(metadata)
}
return fields
}
/**
* Add item to metadata indexes
*/
async addToIndex(id: string, metadata: any): Promise<void> {
const fields = this.extractIndexableFields(metadata)
for (const { field, value } of fields) {
const key = this.getIndexKey(field, value)
// Get or create index entry
let entry = this.indexCache.get(key)
if (!entry) {
const loadedEntry = await this.loadIndexEntry(key)
entry = loadedEntry ?? {
field,
value: this.normalizeValue(value),
ids: new Set<string>(),
lastUpdated: Date.now()
}
this.indexCache.set(key, entry)
}
// Add ID to entry
entry.ids.add(id)
entry.lastUpdated = Date.now()
this.dirtyEntries.add(key)
}
}
/**
* Remove item from metadata indexes
*/
async removeFromIndex(id: string, metadata?: any): Promise<void> {
if (metadata) {
// Remove from specific field indexes
const fields = this.extractIndexableFields(metadata)
for (const { field, value } of fields) {
const key = this.getIndexKey(field, value)
let entry = this.indexCache.get(key)
if (!entry) {
const loadedEntry = await this.loadIndexEntry(key)
entry = loadedEntry ?? undefined
}
if (entry) {
entry.ids.delete(id)
entry.lastUpdated = Date.now()
this.dirtyEntries.add(key)
// If no IDs left, mark for cleanup
if (entry.ids.size === 0) {
this.indexCache.delete(key)
await this.deleteIndexEntry(key)
}
}
}
} else {
// Remove from all indexes (slower, requires scanning)
for (const [key, entry] of this.indexCache.entries()) {
if (entry.ids.has(id)) {
entry.ids.delete(id)
entry.lastUpdated = Date.now()
this.dirtyEntries.add(key)
if (entry.ids.size === 0) {
this.indexCache.delete(key)
await this.deleteIndexEntry(key)
}
}
}
}
}
/**
* Get IDs for a specific field-value combination
*/
async getIds(field: string, value: any): Promise<string[]> {
const key = this.getIndexKey(field, value)
// Try cache first
let entry = this.indexCache.get(key)
// Load from storage if not cached
if (!entry) {
const loadedEntry = await this.loadIndexEntry(key)
if (loadedEntry) {
entry = loadedEntry
this.indexCache.set(key, entry)
}
}
return entry ? Array.from(entry.ids) : []
}
/**
* Convert MongoDB-style filter to simple field-value criteria for indexing
*/
private convertFilterToCriteria(filter: any): Array<{ field: string, values: any[] }> {
const criteria: Array<{ field: string, values: any[] }> = []
if (!filter || typeof filter !== 'object') {
return criteria
}
for (const [key, value] of Object.entries(filter)) {
// Skip logical operators for now - handle them separately
if (key.startsWith('$')) continue
if (value && typeof value === 'object' && !Array.isArray(value)) {
// Handle MongoDB operators
for (const [op, operand] of Object.entries(value)) {
switch (op) {
case '$in':
if (Array.isArray(operand)) {
criteria.push({ field: key, values: operand })
}
break
case '$eq':
criteria.push({ field: key, values: [operand] })
break
// For other operators, we can't use index efficiently, skip for now
default:
break
}
}
} else {
// Direct value or array
const values = Array.isArray(value) ? value : [value]
criteria.push({ field: key, values })
}
}
return criteria
}
/**
* Get IDs matching MongoDB-style metadata filter using indexes where possible
*/
async getIdsForFilter(filter: any): Promise<string[]> {
if (!filter || Object.keys(filter).length === 0) {
return []
}
// Handle logical operators
if (filter.$and && Array.isArray(filter.$and)) {
// For $and, we need intersection of all sub-filters
const allIds: string[][] = []
for (const subFilter of filter.$and) {
const subIds = await this.getIdsForFilter(subFilter)
allIds.push(subIds)
}
if (allIds.length === 0) return []
if (allIds.length === 1) return allIds[0]
// Intersection of all sets
return allIds.reduce((intersection, currentSet) =>
intersection.filter(id => currentSet.includes(id))
)
}
if (filter.$or && Array.isArray(filter.$or)) {
// For $or, we need union of all sub-filters
const unionIds = new Set<string>()
for (const subFilter of filter.$or) {
const subIds = await this.getIdsForFilter(subFilter)
subIds.forEach(id => unionIds.add(id))
}
return Array.from(unionIds)
}
// Handle regular field filters
const criteria = this.convertFilterToCriteria(filter)
const idSets: string[][] = []
for (const { field, values } of criteria) {
const unionIds = new Set<string>()
for (const value of values) {
const ids = await this.getIds(field, value)
ids.forEach(id => unionIds.add(id))
}
idSets.push(Array.from(unionIds))
}
if (idSets.length === 0) return []
if (idSets.length === 1) return idSets[0]
// Intersection of all field criteria (implicit $and)
return idSets.reduce((intersection, currentSet) =>
intersection.filter(id => currentSet.includes(id))
)
}
/**
* Get IDs matching multiple criteria (intersection) - LEGACY METHOD
* @deprecated Use getIdsForFilter instead
*/
async getIdsForCriteria(criteria: Record<string, any>): Promise<string[]> {
return this.getIdsForFilter(criteria)
}
/**
* Flush dirty entries to storage
*/
async flush(): Promise<void> {
const promises: Promise<void>[] = []
for (const key of this.dirtyEntries) {
const entry = this.indexCache.get(key)
if (entry) {
promises.push(this.saveIndexEntry(key, entry))
}
}
await Promise.all(promises)
this.dirtyEntries.clear()
}
/**
* Get index statistics
*/
async getStats(): Promise<MetadataIndexStats> {
const fields = new Set<string>()
let totalEntries = 0
let totalIds = 0
for (const entry of this.indexCache.values()) {
fields.add(entry.field)
totalEntries++
totalIds += entry.ids.size
}
return {
totalEntries,
totalIds,
fieldsIndexed: Array.from(fields),
lastRebuild: 0, // TODO: track rebuild timestamp
indexSize: totalEntries * 100 // rough estimate
}
}
/**
* Rebuild entire index from scratch
*/
async rebuild(): Promise<void> {
if (this.isRebuilding) return
this.isRebuilding = true
try {
// Clear existing indexes
this.indexCache.clear()
this.dirtyEntries.clear()
// Get all nouns and rebuild their metadata indexes
const nouns = await this.storage.getAllNouns()
for (const noun of nouns) {
const metadata = await this.storage.getMetadata(noun.id)
if (metadata) {
await this.addToIndex(noun.id, metadata)
}
}
// Get all verbs and rebuild their metadata indexes
const verbs = await this.storage.getAllVerbs()
for (const verb of verbs) {
const metadata = await this.storage.getVerbMetadata(verb.id)
if (metadata) {
await this.addToIndex(verb.id, metadata)
}
}
// Flush to storage
await this.flush()
} finally {
this.isRebuilding = false
}
}
/**
* Load index entry from storage
*/
private async loadIndexEntry(key: string): Promise<MetadataIndexEntry | null> {
try {
// Load metadata indexes from the _system directory with a special prefix
const indexId = `__metadata_index__${key}`
const data = await this.storage.getMetadata(indexId)
if (data) {
return {
field: data.field,
value: data.value,
ids: new Set(data.ids || []),
lastUpdated: data.lastUpdated || Date.now()
}
}
} catch (error) {
// Index entry doesn't exist yet
}
return null
}
/**
* Save index entry to storage
*/
private async saveIndexEntry(key: string, entry: MetadataIndexEntry): Promise<void> {
const data = {
field: entry.field,
value: entry.value,
ids: Array.from(entry.ids),
lastUpdated: entry.lastUpdated
}
// Store metadata indexes in the _system directory with a special prefix
const indexId = `__metadata_index__${key}`
await this.storage.saveMetadata(indexId, data)
}
/**
* Delete index entry from storage
*/
private async deleteIndexEntry(key: string): Promise<void> {
try {
const indexId = `__metadata_index__${key}`
await this.storage.saveMetadata(indexId, null)
} catch (error) {
// Entry might not exist
}
}
}