Skip to content

Add phrase match weights for full-query ranking #15863

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

Closed
adnankussair wants to merge 1 commit into from
Closed

Add phrase match weights for full-query ranking #15863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions src/Search/Comb/Comb.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ class Comb
'partial_whole' => 2,
'partial_whole_start' => 2,
'whole' => 10,
'phrase' => 0,
'phrase_start' => 0,
];

/**
Expand Down Expand Up @@ -530,6 +532,8 @@ private function searchOverData($params, $raw_query)
'partial_whole' => 0,
'partial_whole_start' => 0,
'whole' => 0,
'phrase' => 0,
'phrase_start' => 0,
];

$snippets = [];
Expand Down Expand Up @@ -562,6 +566,9 @@ private function searchOverData($params, $raw_query)
if ($result) {
$matched = true;
$found['partial_whole'] += $strength * $result;
if (! $chunk_is_word) {
$found['phrase'] += $strength * $result;
}
if ($chunk_is_word) {
$found['partial_word'] += $strength * $result;
if (preg_match_all($regex['partial_anywhere'], $first_word)) {
Expand Down Expand Up @@ -594,6 +601,9 @@ private function searchOverData($params, $raw_query)
if ($result) {
$matched = true;
$found['partial_whole_start'] += $strength * $result;
if (! $chunk_is_word) {
$found['phrase_start'] += $strength * $result;
}

$result = preg_match_all($regex['whole'], $property);
if ($result) {
Expand Down
59 changes: 59 additions & 0 deletions tests/Search/CombTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ReflectionClass;
use Statamic\Search\Comb\Comb;
use Statamic\Search\Comb\Exceptions\NoResultsFound;
use Tests\TestCase;
Expand Down Expand Up @@ -419,6 +420,64 @@ public function it_handles_stop_words_case_insensitive()
$this->assertEquals(['One two three'], collect($results['data'] ?? [])->pluck('data.title')->all());
}

#[Test]
public function phrase_weights_default_to_zero_and_do_not_change_scores()
{
$weights = (new ReflectionClass(Comb::class))->getDefaultProperties()['match_weights'];

$this->assertSame(0, $weights['phrase']);
$this->assertSame(0, $weights['phrase_start']);

$documents = [
['title' => 'Two years in at Passive House Accelerator'],
['title' => str_repeat('Passive House Accelerator ', 12)],
];
$term = 'Two years in at Passive House Accelerator';

$this->assertSame(
$this->combScores($documents, $term),
$this->combScores($documents, $term, ['phrase' => 0, 'phrase_start' => 0])
);
}

#[Test]
public function a_title_containing_the_full_query_can_outrank_repeated_words()
{
$documents = [
['title' => 'Two years in at Passive House Accelerator'],
['title' => str_repeat('Passive House Accelerator ', 12)],
];
$term = 'Two years in at Passive House Accelerator';

$baseline = $this->combScores($documents, $term);
$repeated = str_repeat('Passive House Accelerator ', 12);

$this->assertGreaterThan(
$baseline['Two years in at Passive House Accelerator'],
$baseline[$repeated]
);

$boosted = $this->combScores($documents, $term, ['phrase' => 500]);

$this->assertSame($baseline[$repeated], $boosted[$repeated]);
$this->assertGreaterThan($boosted[$repeated], $boosted['Two years in at Passive House Accelerator']);
}

private function combScores(array $documents, string $term, array $matchWeights = []): array
{
$settings = ['score_threshold' => 0];

if ($matchWeights !== []) {
$settings['match_weights'] = $matchWeights;
}

$results = (new Comb($documents, $settings))->lookUp($term);

return collect($results['data'])->mapWithKeys(fn ($result) => [
$result['data']['title'] => $result['score'],
])->all();
}

public static function searchesProvider()
{
return [
Expand Down
Loading