Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid cache tokenization during insertion #821

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/orama/src/components/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ function insertScalarBuilder(
break
}
case 'Radix': {
const tokens = tokenizer.tokenize(value as string, language, prop)
const tokens = tokenizer.tokenize(value as string, language, prop, false)
implementation.insertDocumentScoreParameters(index, prop, internalId, tokens, docsCount)

for (const token of tokens) {
Expand Down
21 changes: 13 additions & 8 deletions packages/orama/src/components/tokenizer/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,21 @@ export interface DefaultTokenizer extends Tokenizer {
stopWords?: string[]
allowDuplicates: boolean
normalizationCache: Map<string, string>
normalizeToken(this: DefaultTokenizer, token: string, prop: Optional<string>): string
normalizeToken(this: DefaultTokenizer, prop: Optional<string>, token: string, withCache:Optional<boolean>): string
}

export function normalizeToken(this: DefaultTokenizer, prop: string, token: string): string {
export function normalizeToken(this: DefaultTokenizer, prop: string, token: string, withCache: boolean = true): string {
const key = `${this.language}:${prop}:${token}`

if (this.normalizationCache.has(key)) {
if (withCache && this.normalizationCache.has(key)) {
return this.normalizationCache.get(key)!
}

// Remove stopwords if enabled
if (this.stopWords?.includes(token)) {
this.normalizationCache.set(key, '')
if (withCache) {
this.normalizationCache.set(key, '')
}
return ''
}

Expand All @@ -35,7 +37,9 @@ export function normalizeToken(this: DefaultTokenizer, prop: string, token: stri
}

token = replaceDiacritics(token)
this.normalizationCache.set(key, token)
if (withCache) {
this.normalizationCache.set(key, token)
}
return token
}

Expand All @@ -50,7 +54,7 @@ function trim(text: string[]): string[] {
return text
}

function tokenize(this: DefaultTokenizer, input: string, language?: string, prop?: string): string[] {
function tokenize(this: DefaultTokenizer, input: string, language?: string, prop?: string, withCache: boolean = true): string[] {
if (language && language !== this.language) {
throw createError('LANGUAGE_NOT_SUPPORTED', language)
}
Expand All @@ -60,15 +64,16 @@ function tokenize(this: DefaultTokenizer, input: string, language?: string, prop
return [input]
}

const normalizeToken = this.normalizeToken.bind(this, prop ?? '')
let tokens: string[]
if (prop && this.tokenizeSkipProperties.has(prop)) {
tokens = [this.normalizeToken.bind(this, prop ?? '')(input)]
tokens = [normalizeToken(input, withCache)]
} else {
const splitRule = SPLITTERS[this.language]
tokens = input
.toLowerCase()
.split(splitRule)
.map(this.normalizeToken.bind(this, prop ?? ''))
.map(t => normalizeToken(t, withCache))
.filter(Boolean)
}

Expand Down
2 changes: 1 addition & 1 deletion packages/orama/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1063,7 +1063,7 @@ export type DefaultTokenizerConfig = {
export interface Tokenizer {
language: string
normalizationCache: Map<string, string>
tokenize: (raw: string, language?: string, prop?: string) => string[]
tokenize: (raw: string, language?: string, prop?: string, withCache?: boolean) => string[]
}

export interface ObjectComponents<I, D, So> {
Expand Down
15 changes: 15 additions & 0 deletions packages/orama/tests/insert.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -549,6 +549,21 @@ t.test('insertMultiple method', async (t) => {
})
})

t.test('insert shouldn\'t use tokenizer cache', async (t) => {
const db = await create({
schema: {
name: 'string'
} as const
})

await insert(db, {
name: 'The quick brown fox jumps over the lazy dog'
})

// Empty map
t.strictSame(db.tokenizer.normalizationCache, new Map())
});

interface BaseDataEvent extends AnyDocument {
description: string
lang: string
Expand Down
Loading