Skip to content

Improve short-query precision in Algolia search #741

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.

Sign up for GitHub

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

Open
Flamki wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve short-query precision in Algolia search #741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e982c1a
Tighten typo matching for short single-word search queries
Flamki Feb 22, 2026
388595a
Handle short-token typo strictness in multi-word search queries
Flamki Feb 23, 2026
6629092
Apply short-token typo tuning with Algolia-compatible query params
Flamki Feb 23, 2026
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
37 changes: 35 additions & 2 deletions _includes/algolia.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,47 @@
<script>
function hasStrictShortToken(query) {
var trimmed = query.trim();
if (!trimmed) {
return false;
}

// Keep the fix narrow: only short alphanumeric tokens (3-5 chars),
// such as acronyms like "gsoc", including in multi-word queries.
var tokens = trimmed.split(/\s+/).filter(Boolean);
for (var i = 0; i < tokens.length; i++) {
var token = tokens[i].toLowerCase();
if (!/^[a-z0-9]+$/.test(token)) {
continue;
}
if (token.length >= 3 && token.length <= 5) {
return true;
}
}

return false;
}

const algoliaSearch = instantsearch({
appId: '{{ site.algolia.application_id }}',
apiKey: '{{ site.algolia.search_only_api_key }}',
indexName: '{{ site.algolia.index_name }}',
searchFunction: function(helper) { // hide search result in init query
var query = helper.state.query.trim();
var searchResults = $('#search-results');
if (helper.state.query === '') {
if (query === '') {
searchResults.hide();
return;
}

var strictShortToken = hasStrictShortToken(query);
if (strictShortToken) {
helper.setQueryParameter('minWordSizefor1Typo', 5);
helper.setQueryParameter('minWordSizefor2Typos', 9);
} else {
helper.setQueryParameter('minWordSizefor1Typo', 4);
helper.setQueryParameter('minWordSizefor2Typos', 8);
}

helper.search();
searchResults.show();
}
Expand Down Expand Up @@ -133,4 +166,4 @@ <h2><a class="result-link" href="${url}">${title}</a></h2>
}
});

</script>
</script>
35 changes: 34 additions & 1 deletion js/algolia-search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,47 @@

function hasStrictShortToken(query) {
var trimmed = query.trim();
if (!trimmed) {
return false;
}

// Keep the fix narrow: only short alphanumeric tokens (3-5 chars),
// such as acronyms like "gsoc", including in multi-word queries.
var tokens = trimmed.split(/\s+/).filter(Boolean);
for (var i = 0; i < tokens.length; i++) {
var token = tokens[i].toLowerCase();
if (!/^[a-z0-9]+$/.test(token)) {
continue;
}
if (token.length >= 3 && token.length <= 5) {
return true;
}
}

return false;
}

const algoliaSearch = instantsearch({
appId: '{{ site.algolia.application_id }}',
apiKey: '{{ site.algolia.search_only_api_key }}',
indexName: '{{ site.algolia.index_name }}',
searchFunction: function(helper) { // hide search result in init query
var query = helper.state.query.trim();
var searchResults = $('#search-results');
if (helper.state.query === '') {
if (query === '') {
searchResults.hide();
return;
}

var strictShortToken = hasStrictShortToken(query);
if (strictShortToken) {
helper.setQueryParameter('minWordSizefor1Typo', 5);
helper.setQueryParameter('minWordSizefor2Typos', 9);
} else {
helper.setQueryParameter('minWordSizefor1Typo', 4);
helper.setQueryParameter('minWordSizefor2Typos', 8);
}

helper.search();
searchResults.show();
}
Expand Down