From fa853f7d38a5addafe21fb3cabdaaa9cc692bb12 Mon Sep 17 00:00:00 2001 From: Nick Clemens Date: Wed, 21 Mar 2018 13:27:12 +0000 Subject: [PATCH] Bug 18316: Add weighting/relevancy options to ES query on simple search MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit The idea is the following: if some search field(s) are weighted in search engine config page, Koha will query ES on all fields plus those with the coresponding weights. Else, search is done on the entire record with no weighting. The advanced search page is unaffected by these changes Test plan (having Koha working with Elasticsearch): - apply this patch - have some weights defined for various fields - try searches from the search bar and from the advanced search page - confirm weighting affects the relevancy (in expected ways) e.g. 1. search for 'a' from advanced search, note results 2. give 'title' a weight 3. search for 'a' using the simple search bar 4. results with 'a' in the title should now be more relevant - confirm search results on advanced search page are unaffected Signed-off-by: Séverine QUEUNE Signed-off-by: Nick Clemens Signed-off-by: Séverine QUEUNE Rebased-by: Alex Arnaud Signed-off-by: Ere Maijala Signed-off-by: Martin Renvoize Signed-off-by: Nick Clemens --- .../Elasticsearch/QueryBuilder.pm | 12 ++++ Koha/SearchFields.pm | 23 ++++++ catalogue/search.pl | 8 ++- .../prog/en/modules/catalogue/advsearch.tt | 1 + t/db_dependent/Koha/SearchField.t | 70 ++++++++++++++++++- 5 files changed, 112 insertions(+), 2 deletions(-) diff --git a/Koha/SearchEngine/Elasticsearch/QueryBuilder.pm b/Koha/SearchEngine/Elasticsearch/QueryBuilder.pm index 40c88b9dad..91b09ab893 100644 --- a/Koha/SearchEngine/Elasticsearch/QueryBuilder.pm +++ b/Koha/SearchEngine/Elasticsearch/QueryBuilder.pm @@ -92,6 +92,8 @@ sub build_query { default_operator => 'AND', default_field => '_all', lenient => JSON::true, + fields => $options{fields}, + use_dis_max => JSON::true, } }; @@ -228,9 +230,19 @@ sub build_query_compat { join( ' ', $self->_create_query_string(@search_params) ) || (), $self->_join_queries( $self->_convert_index_strings(@$limits) ) || () ); + my @weights = $params->{weight}; + my @w_fields = $params->{w_fields}; + my @fields = '_all'; + if ( defined $weights[0] ) { + for (my $i = 0 ; $i < (scalar @weights) ; $i++ ){ + push @fields, "$w_fields[$i]^$weights[$i]"; + } + } + # If there's no query on the left, let's remove the junk left behind $query_str =~ s/^ AND //; my %options; + $options{fields} = \@fields; $options{sort} = \@sort_params; $options{expanded_facet} = $params->{expanded_facet}; my $query = $self->build_query( $query_str, %options ); diff --git a/Koha/SearchFields.pm b/Koha/SearchFields.pm index 7af3c0b162..3cfcec3c09 100644 --- a/Koha/SearchFields.pm +++ b/Koha/SearchFields.pm @@ -35,6 +35,29 @@ Koha::SearchFields - Koha SearchField Object set class =cut +=head3 weighted_fields + +my (@w_fields, @weight) = Koha::SearchFields->weighted_fields(); + +=cut + +sub weighted_fields { + my ($self) = @_; + + my ($w_fields, $weight) = ([], []); + my $fields = $self->search( + { weight => { '>' => 0, '!=' => undef } }, + { order_by => { -desc => 'weight' } } + ); + + while ( my $field = $fields->next ) { + push @$w_fields, $field->name; + push @$weight, $field->weight; + } + + return ($w_fields, $weight); +} + =head3 type =cut diff --git a/catalogue/search.pl b/catalogue/search.pl index d9961a0c56..d24f424af4 100755 --- a/catalogue/search.pl +++ b/catalogue/search.pl @@ -155,6 +155,7 @@ use Koha::Patrons; use Koha::SearchEngine::Search; use Koha::SearchEngine::QueryBuilder; use Koha::Virtualshelves; +use Koha::SearchFields; use URI::Escape; @@ -455,6 +456,11 @@ my $expanded_facet = $params->{'expand'}; # Define some global variables my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type); +my ($w_fields, $weight); +unless ( $cgi->param('advsearch') ) { + ($w_fields, $weight) = Koha::SearchFields->weighted_fields(); +} + my $builder = Koha::SearchEngine::QueryBuilder->new( { index => $Koha::SearchEngine::BIBLIOS_INDEX } ); my $searcher = Koha::SearchEngine::Search->new( @@ -467,7 +473,7 @@ my $searcher = Koha::SearchEngine::Search->new( $query_type ) = $builder->build_query_compat( \@operators, \@operands, \@indexes, \@limits, - \@sort_by, $scan, $lang ); + \@sort_by, $scan, $lang, { w_fields => @$w_fields, weight => @$weight } ); ## parse the query_cgi string and put it into a form suitable for s my @query_inputs; diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/advsearch.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/advsearch.tt index b8f2a6ba7a..e6a143f149 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/advsearch.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/advsearch.tt @@ -18,6 +18,7 @@