container-search/src/main/java/com/yahoo/prelude/querytransform/PhrasingSearcher.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.prelude.querytransform;

import com.yahoo.component.annotation.Inject;
import com.yahoo.component.ComponentId;
import com.yahoo.component.chain.dependencies.After;
import com.yahoo.component.chain.dependencies.Before;
import com.yahoo.component.chain.dependencies.Provides;
import com.yahoo.container.QrSearchersConfig;
import com.yahoo.search.Query;
import com.yahoo.search.Result;
import com.yahoo.search.Searcher;
import com.yahoo.processing.request.CompoundName;
import com.yahoo.search.searchchain.Execution;
import com.yahoo.search.searchchain.PhaseNames;


import java.util.List;

/**
 * Detects query phrases. When a phrase is detected in the query,
 * the query is mutated to reflect this fact.
 *
 * @author bratseth
 * @author Einar M R Rosenvinge
 */
@After(PhaseNames.RAW_QUERY)
@Before(PhaseNames.TRANSFORMED_QUERY)
@Provides(PhrasingSearcher.PHRASE_REPLACEMENT)
public class PhrasingSearcher extends Searcher {

    private static final CompoundName suggestonly = CompoundName.from("suggestonly");

    public static final String PHRASE_REPLACEMENT = "PhraseReplacement";

    private PhraseMatcher phraseMatcher;

    @Inject
    public PhrasingSearcher(ComponentId id, QrSearchersConfig config) {
        super(id);
        setupAutomatonFile(config.com().yahoo().prelude().querytransform().PhrasingSearcher().automatonfile());
    }

    public PhrasingSearcher(String phraseAutomatonFile) {
        setupAutomatonFile(phraseAutomatonFile);
    }

    private void setupAutomatonFile(String phraseAutomatonFile) {
        if (phraseAutomatonFile == null || phraseAutomatonFile.trim().equals("")) {
            //no file, just use dummy matcher
            phraseMatcher = PhraseMatcher.getNullMatcher();
        } else {
            //use real matcher
            phraseMatcher = new PhraseMatcher(phraseAutomatonFile,true);
        }
    }

    @Override
    public Result search(Query query, Execution execution) {
        if (phraseMatcher.isEmpty()) return execution.search(query);
        
        List<PhraseMatcher.Phrase> replacePhrases = phraseMatcher.matchPhrases(query.getModel().getQueryTree().getRoot());
        if (replacePhrases != null && ! query.properties().getBoolean(suggestonly, false)) {
            replace(replacePhrases);
            query.trace("Replacing phrases", true, 2);
        }
        return execution.search(query);
    }

    /** Replaces all phrases longer than one word with a PhraseItem */
    private void replace(List<PhraseMatcher.Phrase> phrases) {
        // Replacing the leaf replace phrases first to preserve
        // the start index of each replace phrase until replacement
        for (int i = phrases.size()-1; i >= 0; i--) {
            PhraseMatcher.Phrase phrase = phrases.get(i);
            if (phrase.getLength() > 1)
                phrase.replace();
        }
    }

}