-
Notifications
You must be signed in to change notification settings - Fork 871
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract scoring logic out of Autocomplete
- Loading branch information
1 parent
c2caede
commit 38500c8
Showing
7 changed files
with
276 additions
and
203 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
118 changes: 118 additions & 0 deletions
118
app/src/main/java/com/duckduckgo/app/autocomplete/api/AutoCompleteScorer.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| /* | ||
| * Copyright (c) 2024 DuckDuckGo | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.duckduckgo.app.autocomplete.api | ||
|
|
||
| import android.net.Uri | ||
| import com.duckduckgo.di.scopes.AppScope | ||
| import com.squareup.anvil.annotations.ContributesBinding | ||
| import javax.inject.Inject | ||
|
|
||
| interface AutoCompleteScorer { | ||
| fun score( | ||
| title: String?, | ||
| url: Uri, | ||
| visitCount: Int, | ||
| query: String, | ||
| queryTokens: List<String>? = null, | ||
| ): Int | ||
| } | ||
|
|
||
| @ContributesBinding(AppScope::class) | ||
| class RealAutoCompleteScorer @Inject constructor() : AutoCompleteScorer { | ||
| override fun score( | ||
| title: String?, | ||
| url: Uri, | ||
| visitCount: Int, | ||
| query: String, | ||
| queryTokens: List<String>?, | ||
| ): Int { | ||
| // To optimize, query tokens can be precomputed | ||
| val tokens = queryTokens ?: query.tokensFrom() | ||
|
|
||
| var score = DEFAULT_SCORE | ||
| val lowercasedTitle = title?.lowercase() ?: "" | ||
| val queryCount = query.count() | ||
| val nakedUrl = url.naked() | ||
| val domain = url.host?.removePrefix("www.") ?: "" | ||
|
|
||
| // Full matches | ||
| if (nakedUrl.startsWith(query)) { | ||
| score += 300 | ||
| // Prioritize root URLs most | ||
| if (url.isRoot()) score += 2000 | ||
| } else if (lowercasedTitle.startsWith(query)) { | ||
| score += 200 | ||
| if (url.isRoot()) score += 2000 | ||
| } else if (queryCount > 2 && domain.contains(query)) { | ||
| score += 150 | ||
| } else if (queryCount > 2 && lowercasedTitle.contains(" $query")) { // Exact match from the beginning of the word within string. | ||
| score += 100 | ||
| } else { | ||
| // Tokenized matches | ||
| if (tokens.size > 1) { | ||
| var matchesAllTokens = true | ||
| for (token in tokens) { | ||
| // Match only from the beginning of the word to avoid unintuitive matches. | ||
| if (!lowercasedTitle.startsWith(token) && !lowercasedTitle.contains(" $token") && !nakedUrl.startsWith(token)) { | ||
| matchesAllTokens = false | ||
| break | ||
| } | ||
| } | ||
|
|
||
| if (matchesAllTokens) { | ||
| // Score tokenized matches | ||
| score += 10 | ||
|
|
||
| // Boost score if first token matches: | ||
| val firstToken = tokens.firstOrNull() | ||
| if (firstToken != null) { // nakedUrlString - high score boost | ||
| if (nakedUrl.startsWith(firstToken)) { | ||
| score += 70 | ||
| } else if (lowercasedTitle.startsWith(firstToken)) { // beginning of the title - moderate score boost | ||
| score += 50 | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (score > 0) { | ||
| // Second sort based on visitCount | ||
| score *= 1000 | ||
| score += visitCount | ||
| } | ||
|
|
||
| return score | ||
| } | ||
|
|
||
| private fun Uri.naked(): String { | ||
| if (host == null) { | ||
| return toString().removePrefix("//") | ||
| } | ||
|
|
||
| val builder = buildUpon() | ||
|
|
||
| builder.scheme(null) | ||
| builder.authority(host!!.removePrefix("www.")) | ||
|
|
||
| if (path?.lastOrNull() == '/') { | ||
| builder.path(path!!.dropLast(1)) | ||
| } | ||
|
|
||
| return builder.build().toString().removePrefix("//") | ||
| } | ||
| } |
35 changes: 35 additions & 0 deletions
35
app/src/main/java/com/duckduckgo/app/autocomplete/api/AutoCompleteUtils.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /* | ||
| * Copyright (c) 2024 DuckDuckGo | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.duckduckgo.app.autocomplete.api | ||
|
|
||
| import android.net.Uri | ||
|
|
||
| fun Uri.isRoot(): Boolean { | ||
| return (path.isNullOrEmpty() || path == "/") && | ||
| query == null && | ||
| fragment == null && | ||
| userInfo == null | ||
| } | ||
|
|
||
| fun String.tokensFrom(): List<String> { | ||
| return this | ||
| .split(Regex("\\s+")) | ||
| .filter { it.isNotEmpty() } | ||
| .map { it.lowercase() } | ||
| } | ||
|
|
||
| const val DEFAULT_SCORE = -1 |
Oops, something went wrong.